modified doc-help text

Annie Hughes
1 parent b71e81d2
Showing 1 changed file with 25 additions and 17 deletions Show diff stats
src/idl/dustem_show_fortran.pro
-PRO dustem_show_fortran, model=model, data_dir=data_dir,dustem_dir=dustem_dir,nh=nh, fsed=fsed, sw=sw, inst=inst, smdat=smdat, com=com, wref=wref, bbpar=bbpar, wext=wext,  $
-                 xr=xr, yr=yr, tit=tit, CMB=cmb, COSMO=COSMO, DATA=data, SHOW=show, wn=wn, HARD=hard
+PRO dustem_show_fortran, model=model $
+                         , data_dir=data_dir $
+                         , dustem_dir=dustem_dir $
+                         , nh=nh, fsed=fsed, sw=sw $
+                         , inst=inst, smdat=smdat, com=com $
+                         , wref=wref, bbpar=bbpar, wext=wext  $
+                         , xr=xr, yr=yr, tit=tit $
+                         , CMB=cmb, COSMO=COSMO, DATA=data, SHOW=show $
+                         , wn=wn, HARD=hard
  
 ;+
 ; NAME:
 ;    dustem_show_fortran
 ; PURPOSE:
-;    shows differents results of the DUSTEM fortran calculations,
-;    overlaid on fiducial diffuse ISM dust observables
+;    shows various outputs of the DUSTEM fortran calculations,
+;    overlaid on an example observation of diffuse ISM dust 
 ; CATEGORY:
 ;    DustEM, Distributed, User-Example
 ; CALLING SEQUENCE:
-;    dustem_show_results
+;    dustem_show_fortran
 ; INPUTS:
-;    DATA_DIR : path to directory containing fiducial observational
-;    SED files. Defaults to Data/EXAMPLE_OBSDATA/ subdirectory.
+;    DATA_DIR : path to directory containing observational
+;               SED files. Defaults to Data/EXAMPLE_OBSDATA/ subdirectory.
 ;    DUSTEM_DIR : path to directory containing DustEM data files. Default
 ;                 is the !dustem_dat directory (which is defined in
 ;                 a user's idl_startup file)
@@ -77,26 +84,27 @@ PRO dustem_show_fortran, model=model, data_dir=data_dir,dustem_dir=dustem_dir,nh
 ; EXAMPLES
     ;; print,' Examples:'
     ;; print,'  path=''/Users/lverstra/DUSTEM_LOCAL/dustem4.0/''' 
-    ;; print,'  to show SED only:                     show_dustem,path'
-    ;; print,'  SED+UV-extinction:                    show_dustem,path,show=''extuv'' '
-    ;; print,'  SED+IR extinction+size dist.:         show_dustem,path,show=[''extir'',''sdist''] '
-    ;; print,'  ps files with default names:          show_dustem,path,show=[''extir'',''alb''],/hard '
-    ;; print,'  ps files with given names:            show_dustem,path,show=[''extir'',''sdist''],hard=[''f1.ps'',''f2.ps''] '
-    ;; print,'  no plot :                             show_dustem,path,show=0'
-    ;; print,'  to get band fluxes in structure SM:   show_dustem,path,smdat=sm'
+    ;; print,'  to show SED only:                     dustem_show_fortran,path'
+    ;; print,'  SED+UV-extinction:                    dustem_show_fortran,path,show=''extuv'' '
+    ;; print,'  SED+IR extinction+size dist.:         dustem_show_fortran,path,show=[''extir'',''sdist''] '
+    ;; print,'  ps files with default names:          dustem_show_fortran,path,show=[''extir'',''alb''],/hard '
+    ;; print,'  ps files with given names:            dustem_show_fortran,path,show=[''extir'',''sdist''],hard=[''f1.ps'',''f2.ps''] '
+    ;; print,'  no plot :                             dustem_show_fortran,path,show=0'
+    ;; print,'  to get band fluxes in structure SM:   dustem_show_fortran,path,smdat=sm'
     ;; print,'  see structure SM (overall):           help,/str,sm'
     ;; print,'  see structure SM model field:         help,/str,sm.m_emis'
     ;; print,'  see structure SM inst field:          help,/str,sm.i_dirbe'
     ;; print,'  see structure SM inst flux field:     help,/str,sm.i_dirbe.flx'
     ;; print,'                                        array(i,j+1) i:index of inst band, j:index of grain type (ntype+1 is total SED) '
-    ;; print,'  to select or add instrument field(s): show_dustem,path,smdat=sm,inst=[''spire'']  (on existing SM to add instrumentx) '
+    ;; print,'  to select or add instrument field(s): dustem_show_fortran,path,smdat=sm,inst=[''spire'']  (on existing SM to add instrumentx) '
 ; MODIFICATION HISTORY:
+;    Inherited from DustEM fortran repo, July 2022. 
 ;    Written by L Verstraete and M Compiegne, Spring 2010
 ;    Modified by LV : change to cgs, add band fluxes in SMDAT, 2011
 ;    Modified by LV & V Guillet : add polarization part, 2017
 ;    Further evolution details on the DustEMWrap gitlab.
 ;    See http://dustemwrap.irap.omp.eu/ for FAQ and help.  
-
+;    
  
 if keyword_set(help) then begin 
   doc_library,'dustem_show_fortran'
@@ -186,7 +194,7 @@ if keyword_set(data_dir) then data_path = data_dir
 ;
 ; get the SED data
 ;
-; New FarIR-mm SED from FBoulanger
+; FarIR-mm SED from FBoulanger
  RESTORE, data_path+'/EXAMPLE_OBSDATA/filters_ref_wave.xdr'
  fact_em = 0.77                     ; to account for 20% of H to be in ionized form + 3% H2
  to_sed_20 = 1d-17 * (1d20/1.82d18) ; MJy/sr->erg/s/cm2/sr and normalization to NH = 10^20 H/cm2