OV-GSO-DC / dustem-wrapper_idl

Commit a9404b264eed7edde5febbbabd10555f9f49dfa2

Authored by Annie Hughes
1 parent c256dc81
Exists in master

updated help

Showing 1 changed file with 21 additions and 4 deletions   Show diff stats
Inline Side-by-side
src/idl/dustem_create_stext.pro
  Diff comments   View file @a9404b2
... ... @@ -3,32 +3,49 @@ FUNCTION dustem_create_stext ,st, key=key, val=val, scope, help=help
3 3 ;+
4 4 ; NAME:
5 5 ; dustem_create_stext
  6 +;
6 7 ; PURPOSE:
7 8 ; Produces stokes extinction parameters (cross sections / optical depths)
  9 +;
8 10 ; CATEGORY:
9   -; DUSTEM Wrapper
  11 +; DUSTEM Wrapper, Plugin, Distributed
  12 +;
10 13 ; CALLING SEQUENCE:
11 14 ; dustem_create_stext(st,key=key,val=val)
  15 +;
12 16 ; INPUTS:
13 17 ; st (st = dustem_run(p_dim))
  18 +;
14 19 ; OPTIONAL INPUT PARAMETERS:
15 20 ; key = input parameter number
16 21 ; val = input parameter value
  22 +;
17 23 ; OUTPUTS:
18 24 ; out = array containing the extinction stokes parameters
  25 +;
19 26 ; OPTIONAL OUTPUT PARAMETERS:
20 27 ; None
  28 +;
21 29 ; ACCEPTED KEY-WORDS:
22 30 ; help = if set, print this help
  31 +;
23 32 ; COMMON BLOCKS:
24 33 ; None
  34 +;
25 35 ; SIDE EFFECTS:
26 36 ; None
  37 +;
27 38 ; RESTRICTIONS:
28   -; The dustem fortran code must be installed
29   -; The dustem idl wrapper must be installed
  39 +; The DustEM fortran code must be installed
  40 +; The DustEMWrap IDL code must be installed
  41 +;
30 42 ; PROCEDURE:
31 43 ; This is a dustem plugin
  44 +; EXAMPLES
  45 +;
  46 +; MODIFICATION HISTORY:
  47 +; Evolution details on the DustEMWrap gitlab
  48 +; See http://dustemwrap.irap.omp.eu/ for FAQ and help.
32 49 ;-
33 50  
34 51 IF keyword_set(help) THEN BEGIN
... ... @@ -64,4 +81,4 @@ scope=((*!dustem_scope).stext)
64 81 return, out[1:*]
65 82  
66 83 the_end:
67   -END
68 84 \ No newline at end of file
  85 +END
... ...