OV-GSO-DC / dustem-wrapper_idl

Commit 02ee63e9733abf4a1828c6e36fffb4df6e7a8e2c

Authored by Annie Hughes
1 parent 69cbf51c
Exists in master

doc help updated

Showing 1 changed file with 20 additions and 5 deletions   Show diff stats
Inline Side-by-side
src/idl/dustem_run.pro
  Diff comments   View file @02ee63e
... ... @@ -3,36 +3,51 @@ FUNCTION dustem_run,params,help=help
3 3 ;+
4 4 ; NAME:
5 5 ; dustem_run
  6 +;
6 7 ; PURPOSE:
7 8 ; Runs the DUSTEM code and returns the results into a structure.
  9 +;
8 10 ; CATEGORY:
9   -; Dustem
  11 +; DustEMWrap, Distributed, Mid-Level, Fortran
  12 +;
10 13 ; CALLING SEQUENCE:
11 14 ; st=dustem_run(params[,/help])
  15 +;
12 16 ; INPUTS:
13 17 ; params = model parameter values
  18 +;
14 19 ; OPTIONAL INPUT PARAMETERS:
15 20 ; None
  21 +;
16 22 ; OUTPUTS:
17 23 ; st: output structure
  24 +;
18 25 ; OPTIONAL OUTPUT PARAMETERS:
19 26 ; None
  27 +;
20 28 ; ACCEPTED KEY-WORDS:
21 29 ; help = If set, print this help
  30 +;
22 31 ; COMMON BLOCKS:
23 32 ; None
  33 +;
24 34 ; SIDE EFFECTS:
25 35 ; None
  36 +;
26 37 ; RESTRICTIONS:
27   -; The dustem idl wrapper must be installed
  38 +; The DustEM fortran code must be installed
  39 +; The DustEMWrap idl code must be installed
  40 +;
28 41 ; PROCEDURE:
29 42 ; None
  43 +;
30 44 ; EXAMPLES
31 45 ; st=dustem_run(params)
  46 +;
32 47 ; MODIFICATION HISTORY:
33   -; Written by J.-Ph. Bernard, N. Flagey, D. Paradis Jan 2007
34   -; see evolution details on the dustem cvs maintained at CESR
35   -; Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
  48 +; Written by JPB 2007
  49 +; Evolution details on the DustEMWrap gitlab.
  50 +; See http://dustemwrap.irap.omp.eu/ for FAQ and help.
36 51 ;-
37 52  
38 53 IF keyword_set(help) THEN BEGIN
... ...