OV-GSO-DC / dustem-wrapper_idl

Commit a2745344de6e0339393e4fb876eca2358c13e6ed

Authored by Annie Hughes
1 parent 0dda35a7
Exists in master

updated inline doc help

Showing 2 changed files with 21 additions and 9 deletions   Show diff stats
Inline Side-by-side
src/idl/dustem_fit_intensity_example.pro
  Diff comments   View file @a274534
... ... @@ -83,8 +83,7 @@ PRO dustem_fit_intensity_example,model=model $
83 83 ; The DustEMWrap IDL code must be installed
84 84 ;
85 85 ; PROCEDURES AND SUBROUTINES USED:
86   -; *** COMMENT AH --> is this really NONE? ****
87   -;
  86 +;
88 87 ; EXAMPLES
89 88 ; dustem_fit_intensity_example
90 89 ; dustem_fit_intensity_example,Nitermax=1,fits_save_and_restore='/tmp/mysavefile.fits'
... ... @@ -183,7 +182,8 @@ fpd=[] & fiv=[]
183 182 ;; ;=== Here we fit the dust abundances of the model. The
184 183 ;; ;=== intensity of the dust-heating radiation field is fixed to 1.2*G0.
185 184 ;; ;=== The free parameters are all lower-bounded at zero.
186   -;; use_model='DL01' ; you should specify this above!
  185 +;; use_model='DL01' ; you should specify this above, or in the
  186 +;; command line
187 187 ;; pd = [ $
188 188 ;; '(*!dustem_params).grains(0).mdust_o_mh',$ ;PAH0 mass fraction
189 189 ;; '(*!dustem_params).grains(1).mdust_o_mh',$ ;PAH1 mass fraction
... ...
src/idl/dustem_mpfit_run.pro
  Diff comments   View file @a274534
... ... @@ -2,46 +2,58 @@ FUNCTION dustem_mpfit_run,x,p_min,niter=niter_completed,_EXTRA=_extra
2 2  
3 3 ;+
4 4 ; NAME:
5   -; dustem_mpfit_run_vg
  5 +; dustem_mpfit_run
  6 +;
6 7 ; PURPOSE:
7 8 ; function used to fit dustem model with dustem_mpfit_sed
  9 +;
8 10 ; CATEGORY:
9 11 ; Dustem
  12 +;
10 13 ; CALLING SEQUENCE:
11 14 ; res=dustem_mpfit_run_vg(x,params[,_EXTRA=extra][,cc_sed=cc_sed][,/help])
  15 +;
12 16 ; INPUTS:
13 17 ; x = necessary for interface but unused
14 18 ; params = Dustem Model parameters normalized to initial values
  19 +;
15 20 ; OPTIONAL INPUT PARAMETERS:
16 21 ; cc_sed = SED color correction factors
17 22 ; _extra = extra parameters for the plot routine
  23 +;
18 24 ; OUTPUTS:
19 25 ; None
  26 +;
20 27 ; OPTIONAL OUTPUT PARAMETERS:
21 28 ; None
  29 +;
22 30 ; ACCEPTED KEY-WORDS:
23 31 ; help = If set, print this help
  32 +;
24 33 ; COMMON BLOCKS:
25 34 ; None
  35 +;
26 36 ; SIDE EFFECTS:
27 37 ; SED and model are plotted if !dustem_show_plot
  38 +;
28 39 ; RESTRICTIONS:
29 40 ; The dustem idl wrapper must be installed
  41 +;
30 42 ; PROCEDURE:
31 43 ; None
  44 +;
32 45 ; EXAMPLES
33 46 ; res=dustem_mpfit_run_vg(x,params[,_EXTRA=extra][,cc_sed=cc_sed][,/help])
34   -; ODIFICATION HISTORY:
  47 +;
  48 +; MODIFICATION HISTORY:
35 49 ; Adapted to extinction and polarization by Vincent Guillet (IAS)
36 50 ; Written by J.-Ph. Bernard
37   -; see evolution details on the dustem cvs maintained at CESR
38   -; Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
  51 +; Evolution details on the DustEMWrap gitlab.
  52 +; See http://dustemwrap.irap.omp.eu/ for FAQ and help.
39 53 ;-
40 54  
41 55 ;note that x is not used.
42 56  
43   -;stop
44   -
45 57 IF keyword_set(help) THEN BEGIN
46 58 doc_library,'dustem_mpfit_run'
47 59 sed=0.
... ...