updated help

Annie Hughes
1 parent 38a17554
Showing 1 changed file with 48 additions and 1 deletions Show diff stats
src/idl/dustem_define_dustem_data.pro
 FUNCTION dustem_define_dustem_data,polarization=polarization,rchi2_weight=rchi2_weight
+  
+;+
+; NAME:
+;   dustem_define_dustem_data
+;  
+; PURPOSE:
+;   Returns data structure with appropriate tags (format depends on polarized vs non polarized run)
+;  
+; CATEGORY:
+;    DustEMWrap, Distributed, LowLevel
+;  
+; CALLING SEQUENCE:
+;   dustem_data = dustem_define_dustem_data([/pol],[rchi2=outvar])
+;
+; INPUTS:
+;    None
+;
+; OPTIONAL INPUT PARAMETERS:
+;    None
+;
+; OUTPUTS:
+;    data structure with appropriate tags
+;
+; OPTIONAL OUTPUT PARAMETERS:
+;    structure with the same tags for the corresponding reduced chi2 weights
+;  
+; ACCEPTED KEY-WORDS:
+;
+; COMMON BLOCKS:
+;    None
+;
+; SIDE EFFECTS:
+;
+; RESTRICTIONS:
+;    The DustEMWrap idl code must be installed
+;
+; PROCEDURES AND SUBROUTINES USED:
+;   
+; EXAMPLES
+;    dustem_data = dustem_define_dustem_data(pol=1)
+;
+; MODIFICATION HISTORY:
+;    Written by JPB
+;    Evolution details on the DustEMWrap gitlab.
+;    See http://dustemwrap.irap.omp.eu/ for FAQ and help.  
+;-
+
  
 if keyword_set(polarization) then begin
     dustem_data_st ={    $ ;Structure contaning the data to fit
@@ -28,4 +75,4 @@ endelse
  
 RETURN,dustem_data_st
  
-END
 \ No newline at end of file
+END