OV-GSO-DC / dustem-wrapper_idl

Commit 5051ce3b7b5c215d2b2875d2814df3059a6cfcd2

Authored by Annie Hughes
1 parent d6c8ffcb
Exists in master

Renamed and reorganised developer docs

Showing 5 changed files with 0 additions and 1022 deletions   Show diff stats
Inline Side-by-side
Docs/DustemWrapp.html deleted
View file @d6c8ffc
... ... @@ -1,1008 +0,0 @@
1   -<!-- This file was generated by mk_html_help.pro -->
2   -<html>
3   -
4   -<head>
5   -<TITLE>Extended Help for DustemWrap routines</TITLE>
6   -</head>
7   -
8   -<body>
9   -<H1>Extended Help for DustemWrap routines</H1>
10   -<P>
11   -This page was created by the IDL library routine
12   -<CODE>mk_html_help</CODE>. For more information on
13   -this routine, refer to the IDL Online Help Navigator
14   -or type: <P>
15   -<PRE> ? mk_html_help</PRE><P>
16   -at the IDL command line prompt.<P>
17   -<STRONG>Last modified: </STRONG>Wed Jun 8 12:10:31 2011.<P>
18   -
19   -<HR>
20   -
21   -<A NAME="ROUTINELIST">
22   -<H1>List of Routines</H1></A>
23   -<UL>
24   -<LI><A HREF="#DUSTEM_CC">DUSTEM_CC</A>
25   -<LI><A HREF="#DUSTEM_COMPUTE_SED">DUSTEM_COMPUTE_SED</A>
26   -<LI><A HREF="#DUSTEM_FILTER2FLUXCONV">DUSTEM_FILTER2FLUXCONV</A>
27   -<LI><A HREF="#DUSTEM_FILTER2INSTRU">DUSTEM_FILTER2INSTRU</A>
28   -<LI><A HREF="#DUSTEM_FILTER2WAV">DUSTEM_FILTER2WAV</A>
29   -<LI><A HREF="#DUSTEM_FILTER_INIT">DUSTEM_FILTER_INIT</A>
30   -<LI><A HREF="#DUSTEM_FIT_SED_README">DUSTEM_FIT_SED_README</A>
31   -<LI><A HREF="#DUSTEM_INIT">DUSTEM_INIT</A>
32   -<LI><A HREF="#DUSTEM_PLANCK_FUNCTION">DUSTEM_PLANCK_FUNCTION</A>
33   -<LI><A HREF="#DUSTEM_PLOT_EXTINCTION">DUSTEM_PLOT_EXTINCTION</A>
34   -<LI><A HREF="#DUSTEM_PLOT_FIT_SED">DUSTEM_PLOT_FIT_SED</A>
35   -<LI><A HREF="#DUSTEM_PLOT_NUINU_EM">DUSTEM_PLOT_NUINU_EM</A>
36   -<LI><A HREF="#DUSTEM_READ_ALL">DUSTEM_READ_ALL</A>
37   -<LI><A HREF="#DUSTEM_READ_ALL_RES">DUSTEM_READ_ALL_RES</A>
38   -<LI><A HREF="#DUSTEM_RESTORE_SED_FIT">DUSTEM_RESTORE_SED_FIT</A>
39   -<LI><A HREF="#DUSTEM_RUN">DUSTEM_RUN</A>
40   -<LI><A HREF="#DUSTEM_RUN_README">DUSTEM_RUN_README</A>
41   -<LI><A HREF="#DUSTEM_SAVE_SED_FIT">DUSTEM_SAVE_SED_FIT</A>
42   -<LI><A HREF="#DUSTEM_SET_DATA">DUSTEM_SET_DATA</A>
43   -<LI><A HREF="#DUSTEM_SET_FUNC_IND">DUSTEM_SET_FUNC_IND</A>
44   -<LI><A HREF="#DUSTEM_WRITE_ALL">DUSTEM_WRITE_ALL</A>
45   -</UL><P>
46   -
47   -<HR>
48   -
49   -<H1>Routine Descriptions</H1>
50   -<A NAME="DUSTEM_CC">
51   -<H2>DUSTEM_CC</H2></A>
52   -<A HREF="#DUSTEM_COMPUTE_SED">[Next Routine]</A>
53   -<A HREF="#ROUTINELIST">[List of Routines]</A>
54   -<PRE>
55   - NAME:
56   - dustem_cc
57   - PURPOSE:
58   - Computes observed sed and color correction for a given spectrum in a given filter
59   - CATEGORY:
60   - Dustem
61   - CALLING SEQUENCE:
62   - sed=dustem_cc(wave,spec,filter_names,cc=cc,fluxconv=fluxconv,help=help)
63   - INPUTS:
64   - wave: array of wavelengths for spec
65   - spec: spectrum (must be in brightness units)
66   - filter_names: names of filters for which color correction is needed
67   - OPTIONAL INPUT PARAMETERS:
68   - None
69   - OUTPUTS:
70   - sed: SED as observed in filters provided in filter_names
71   - OPTIONAL OUTPUT PARAMETERS:
72   - cc = color correction coefficients (spec*cc=sed)
73   - ACCEPTED KEY-WORDS:
74   - fluxconv = if set, these are taken for flux conventions
75   - possible values: 'nuInu=cste', 'IRAC', 'MIPS', 'CMB'
76   - help = If set, print this help
77   - COMMON BLOCKS:
78   - None
79   - SIDE EFFECTS:
80   - None
81   - RESTRICTIONS:
82   - The dustem idl wrapper must be installed
83   - PROCEDURE:
84   - None
85   - EXAMPLES
86   -
87   - MODIFICATION HISTORY:
88   - Written by J.P. Bernard April 18th 2011
89   - replaces individual cc routines for various instruments
90   - see evolution details on the dustem cvs maintained at CESR
91   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
92   -</PRE><P>
93   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_cc.pro)</STRONG><P>
94   -<HR>
95   -
96   -<A NAME="DUSTEM_COMPUTE_SED">
97   -<H2>DUSTEM_COMPUTE_SED</H2></A>
98   -<A HREF="#DUSTEM_CC">[Previous Routine]</A>
99   -<A HREF="#DUSTEM_FILTER2FLUXCONV">[Next Routine]</A>
100   -<A HREF="#ROUTINELIST">[List of Routines]</A>
101   -<PRE>
102   - NAME:
103   - dustem_compute_sed
104   - PURPOSE:
105   - Computes an SED from a given Dustem spectrum
106   - CATEGORY:
107   - Dustem
108   - CALLING SEQUENCE:
109   - sed=dustem_compute_sed(p_dim[,st=][,cont=][,_extra=][,/help])
110   - INPUTS:
111   - p_dim = parameter values
112   - OPTIONAL INPUT PARAMETERS:
113   - None
114   - OUTPUTS:
115   - sed = computed SED for filters in !dustem_data
116   - OPTIONAL OUTPUT PARAMETERS:
117   - st = Dustem output structure
118   - cont = NIR continuum
119   - ACCEPTED KEY-WORDS:
120   - help = If set, print this help
121   - COMMON BLOCKS:
122   - None
123   - SIDE EFFECTS:
124   - None
125   - RESTRICTIONS:
126   - The dustem idl wrapper must be installed
127   - PROCEDURE:
128   - None
129   - EXAMPLES
130   -
131   - MODIFICATION HISTORY:
132   - Written by J.-Ph. Bernard
133   - see evolution details on the dustem cvs maintained at CESR
134   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
135   -</PRE><P>
136   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_compute_sed.pro)</STRONG><P>
137   -<HR>
138   -
139   -<A NAME="DUSTEM_FILTER2FLUXCONV">
140   -<H2>DUSTEM_FILTER2FLUXCONV</H2></A>
141   -<A HREF="#DUSTEM_COMPUTE_SED">[Previous Routine]</A>
142   -<A HREF="#DUSTEM_FILTER2INSTRU">[Next Routine]</A>
143   -<A HREF="#ROUTINELIST">[List of Routines]</A>
144   -<PRE>
145   - NAME:
146   - dustem_filter2fluxconv
147   - PURPOSE:
148   - Returns flux convention given filter name
149   - CATEGORY:
150   - Dustem
151   - CALLING SEQUENCE:
152   - flx_conv=dustem_filter2fluxconv(filter[,/help])
153   - INPUTS:
154   - filter = Filter name
155   - OPTIONAL INPUT PARAMETERS:
156   - None
157   - OUTPUTS:
158   - flx_conv = Flux convention string
159   - OPTIONAL OUTPUT PARAMETERS:
160   - None
161   - ACCEPTED KEY-WORDS:
162   - help = If set, print this help
163   - COMMON BLOCKS:
164   - None
165   - SIDE EFFECTS:
166   - Reads instrument_description.xcat at each call. Not optimal.
167   - RESTRICTIONS:
168   - The dustem idl wrapper must be installed
169   - PROCEDURE:
170   - None
171   - EXAMPLES
172   - print,dustem_filter2fluxconv(['IRAS1','MIPS3'])
173   - MODIFICATION HISTORY:
174   - Written by J.-Ph. Bernard
175   - see evolution details on the dustem cvs maintained at CESR
176   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
177   -</PRE><P>
178   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_filter2fluxconv.pro)</STRONG><P>
179   -<HR>
180   -
181   -<A NAME="DUSTEM_FILTER2INSTRU">
182   -<H2>DUSTEM_FILTER2INSTRU</H2></A>
183   -<A HREF="#DUSTEM_FILTER2FLUXCONV">[Previous Routine]</A>
184   -<A HREF="#DUSTEM_FILTER2WAV">[Next Routine]</A>
185   -<A HREF="#ROUTINELIST">[List of Routines]</A>
186   -<PRE>
187   - NAME:
188   - dustem_filter2instru
189   - PURPOSE:
190   - Returns instrument name given filter name
191   - CATEGORY:
192   - Dustem
193   - CALLING SEQUENCE:
194   - inst_name=dustem_filter2instru(filter[,/help])
195   - INPUTS:
196   - filter = Filter name
197   - OPTIONAL INPUT PARAMETERS:
198   - None
199   - OUTPUTS:
200   - inst_name = Instrument name
201   - OPTIONAL OUTPUT PARAMETERS:
202   - None
203   - ACCEPTED KEY-WORDS:
204   - help = If set, print this help
205   - COMMON BLOCKS:
206   - None
207   - SIDE EFFECTS:
208   - Reads instrument_description.xcat at each call. Not optimal.
209   - RESTRICTIONS:
210   - The dustem idl wrapper must be installed
211   - PROCEDURE:
212   - None
213   - EXAMPLES
214   - print,dustem_filter2instru(['IRAS1','MIPS3'])
215   - MODIFICATION HISTORY:
216   - Written by J.-Ph. Bernard
217   - see evolution details on the dustem cvs maintained at CESR
218   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
219   -</PRE><P>
220   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_filter2instru.pro)</STRONG><P>
221   -<HR>
222   -
223   -<A NAME="DUSTEM_FILTER2WAV">
224   -<H2>DUSTEM_FILTER2WAV</H2></A>
225   -<A HREF="#DUSTEM_FILTER2INSTRU">[Previous Routine]</A>
226   -<A HREF="#DUSTEM_FILTER_INIT">[Next Routine]</A>
227   -<A HREF="#ROUTINELIST">[List of Routines]</A>
228   -<PRE>
229   - NAME:
230   - dustem_filter2wav
231   - PURPOSE:
232   - Returns reference wavelength given filter name
233   - CATEGORY:
234   - Dustem
235   - CALLING SEQUENCE:
236   - wave=dustem_filter2wav(filter[,/help])
237   - INPUTS:
238   - filter = Filter name
239   - OPTIONAL INPUT PARAMETERS:
240   - None
241   - OUTPUTS:
242   - wave = reference wavelength (microns)
243   - OPTIONAL OUTPUT PARAMETERS:
244   - None
245   - ACCEPTED KEY-WORDS:
246   - help = If set, print this help
247   - COMMON BLOCKS:
248   - None
249   - SIDE EFFECTS:
250   - Reads instrument_description.xcat at each call. Not optimal.
251   - RESTRICTIONS:
252   - The dustem idl wrapper must be installed
253   - PROCEDURE:
254   - None
255   - EXAMPLES
256   - print,dustem_filter2wav(['IRAS1','MIPS3'])
257   - MODIFICATION HISTORY:
258   - Written by J.-Ph. Bernard
259   - see evolution details on the dustem cvs maintained at CESR
260   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
261   -</PRE><P>
262   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_filter2wav.pro)</STRONG><P>
263   -<HR>
264   -
265   -<A NAME="DUSTEM_FILTER_INIT">
266   -<H2>DUSTEM_FILTER_INIT</H2></A>
267   -<A HREF="#DUSTEM_FILTER2WAV">[Previous Routine]</A>
268   -<A HREF="#DUSTEM_FIT_SED_README">[Next Routine]</A>
269   -<A HREF="#ROUTINELIST">[List of Routines]</A>
270   -<PRE>
271   - NAME:
272   - dustem_filter_init
273   - PURPOSE:
274   - Initializes the dustem filter structure (!dustem_filters)
275   - CATEGORY:
276   - Dustem
277   - CALLING SEQUENCE:
278   - dustem_filter_init[,dir=]
279   - INPUTS:
280   - None
281   - OPTIONAL INPUT PARAMETERS:
282   - None
283   - OUTPUTS:
284   - None
285   - OPTIONAL OUTPUT PARAMETERS:
286   - None
287   - ACCEPTED KEY-WORDS:
288   - help = If set print this help
289   - COMMON BLOCKS:
290   - None
291   - SIDE EFFECTS:
292   - initializes !dustem_filters
293   - RESTRICTIONS:
294   - The dustem idl wrapper must be installed
295   - PROCEDURE:
296   - None
297   - EXAMPLES
298   - dustem_init
299   - dustem_filter_init
300   - MODIFICATION HISTORY:
301   - Written by J.-Ph. Bernard
302   - see evolution details on the dustem cvs maintained at CESR
303   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
304   -</PRE><P>
305   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_filter_init.pro)</STRONG><P>
306   -<HR>
307   -
308   -<A NAME="DUSTEM_FIT_SED_README">
309   -<H2>DUSTEM_FIT_SED_README</H2></A>
310   -<A HREF="#DUSTEM_FILTER_INIT">[Previous Routine]</A>
311   -<A HREF="#DUSTEM_INIT">[Next Routine]</A>
312   -<A HREF="#ROUTINELIST">[List of Routines]</A>
313   -<PRE>
314   - NAME:
315   - dustem_fit_sed_readme
316   - PURPOSE:
317   - This is an example of how to fit SEDs with the dustem wrapper.
318   - It is meant to be an example to follow when writing your own
319   - programs using the dustem IDL wrapper.
320   - It is not meant to reproduce the result in Compiegne et al 2010
321   - The SED used here is in sample_SED.xcat
322   - CATEGORY:
323   - Dustem
324   - CALLING SEQUENCE:
325   - dustem_fit_sed_readme,postcript=postcript,mode=mode,help=help
326   - INPUTS:
327   - None
328   - OPTIONAL INPUT PARAMETERS:
329   - None
330   - OUTPUTS:
331   - None
332   - OPTIONAL OUTPUT PARAMETERS:
333   - None
334   - ACCEPTED KEY-WORDS:
335   - mode = Selects one of the dust mixture used by dustem
336   - 'COMPIEGNE_ETAL2010' from Compiegne et al 2010 (default)
337   - 'DBP90' from Desert et al 1990
338   - 'DL01' from Draine & Li 2001
339   - 'DL07' from Draine & Li 2007
340   - postcript = if set plot is done in DUSTEM/Docs/Figures/Last_dustem_fit.ps
341   - help = If set print this help
342   - COMMON BLOCKS:
343   - None
344   - SIDE EFFECTS:
345   - None
346   - RESTRICTIONS:
347   - The dustem fortran code must be installed
348   - The dustem idl wrapper must be installed
349   - PROCEDURE:
350   - None
351   - EXAMPLES
352   - dustem_fit_sed_readme,mode='COMPIEGNE_ETAL2010'
353   - MODIFICATION HISTORY:
354   - Written by J.P. Bernard April 1st 2011
355   - see evolution details on the dustem cvs maintained at CESR
356   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
357   -</PRE><P>
358   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_fit_sed_readme.pro)</STRONG><P>
359   -<HR>
360   -
361   -<A NAME="DUSTEM_INIT">
362   -<H2>DUSTEM_INIT</H2></A>
363   -<A HREF="#DUSTEM_FIT_SED_README">[Previous Routine]</A>
364   -<A HREF="#DUSTEM_PLANCK_FUNCTION">[Next Routine]</A>
365   -<A HREF="#ROUTINELIST">[List of Routines]</A>
366   -<PRE>
367   - NAME:
368   - dustem_init
369   - CALLING SEQUENCE:
370   - dustem_init
371   - PURPOSE:
372   - Defines system variables to run the DUSTEM code
373   - INPUTS:
374   - mode = Selects one of the dust mixture used by dustem
375   - 'COMPIEGNE_ETAL2010' from Compiegne et al 2010 (default)
376   - 'DBP90' from Desert et al 1990
377   - 'DL01' from Draine & Li 2001
378   - 'DL07' from Draine & Li 2007
379   - dir = overrides default directory where to read data
380   - wraptest = test running dustem f90 through the wrapper
381   - plot_it = plots run result (only if wraptest)
382   - help = If set print this help
383   - OPTIONAL INPUT:
384   - None
385   - OUTPUTS:
386   - None
387   - PROCEDURE AND SUBROUTINE USED
388   - 1/ The folowing system variables are initialized to null values
389   - or empty pointers:
390   - !dustem_fit
391   - !dustem_data
392   - !dustem_inputs
393   - !dustem_params
394   - !run_ionfrac
395   - !dustem_idl_continuum
396   - !dustem_filters
397   - !dustem_verbose
398   - !dustem_show_plot
399   - 2/ optionally runs the fortran code (if wraptest)
400   - This step calls the Fortran code to run a standard model
401   - 3/ !dustem_filters is initialized calling dustem_filter_init.pro.
402   - RESTRICTIONS:
403   - The dustem fortran code must be installed
404   - The dustem idl wrapper must be installed
405   - EXAMPLES
406   - dustem_init,/wrap,/plot_it
407   - MODIFICATION HISTORY:
408   - See cvs logs
409   - Written by JPB,NF,DP Jan-2007
410   - see evolution details on the dustem cvs maintained at CESR
411   -</PRE><P>
412   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_init.pro)</STRONG><P>
413   -<HR>
414   -
415   -<A NAME="DUSTEM_PLANCK_FUNCTION">
416   -<H2>DUSTEM_PLANCK_FUNCTION</H2></A>
417   -<A HREF="#DUSTEM_INIT">[Previous Routine]</A>
418   -<A HREF="#DUSTEM_PLOT_EXTINCTION">[Next Routine]</A>
419   -<A HREF="#ROUTINELIST">[List of Routines]</A>
420   -<PRE>
421   - NAME:
422   - dustem_planck_function
423   - PURPOSE:
424   - To calculate the Planck function in units of MJy/sr
425   -
426   - CALLING SEQUENCE:
427   - bbflux = dustem_planck_function(temp,wave)
428   -
429   - INPUT PARAMETERS:
430   - WAVE in microns
431   - TEMP Scalar giving the temperature of the planck function in degree K
432   -
433   - OUTPUT PARAMETERS:
434   - BBFLUX - Scalar or vector giving the planck function at the specified
435   - wavelength points.
436   -
437   - EXAMPLES:
438   -
439   - RESTRICTIONS:
440   - Values less than approximately 1E-24 are truncated to 0.
441   -
442   - PROCEDURE:
443   -
444   - MODIFICATION HISTORY:
445   -</PRE><P>
446   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_planck_function.pro)</STRONG><P>
447   -<HR>
448   -
449   -<A NAME="DUSTEM_PLOT_EXTINCTION">
450   -<H2>DUSTEM_PLOT_EXTINCTION</H2></A>
451   -<A HREF="#DUSTEM_PLANCK_FUNCTION">[Previous Routine]</A>
452   -<A HREF="#DUSTEM_PLOT_FIT_SED">[Next Routine]</A>
453   -<A HREF="#ROUTINELIST">[List of Routines]</A>
454   -<PRE>
455   - NAME:
456   - dustem_plot_extinction
457   - PURPOSE:
458   - Plots a Dustem extinction
459   - CATEGORY:
460   - Dustem
461   - CALLING SEQUENCE:
462   - dustem_plot_extinction,st,st_model[,/help][,_extra=]
463   - INPUTS:
464   - st = Dustem model output structure
465   - st_model = Dustem model parameters structure
466   - OPTIONAL INPUT PARAMETERS:
467   - _extra = extra parameters for the plot routine
468   - OUTPUTS:
469   - None
470   - OPTIONAL OUTPUT PARAMETERS:
471   - None
472   - ACCEPTED KEY-WORDS:
473   - help = If set, print this help
474   - COMMON BLOCKS:
475   - None
476   - SIDE EFFECTS:
477   - model is plotted
478   - RESTRICTIONS:
479   - The dustem idl wrapper must be installed
480   - PROCEDURE:
481   - None
482   - EXAMPLES
483   - dustem_init,/wrap
484   - dir_in=getenv('DUSTEM_SOFT_DIR')+'/src/dustem3.8_web/'
485   - st_model=dustem_read_all(dir_in)
486   - dir=getenv('DUSTEM_RES')
487   - st=dustem_read_all_res(dir_in)
488   - loadct,13
489   - dustem_plot_extinction,st,st_model,yr=[1.e-6,1.e0],/ysty,xr=[1.,400],/xsty
490   - MODIFICATION HISTORY:
491   - Written by J.-Ph. Bernard
492   - see evolution details on the dustem cvs maintained at CESR
493   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
494   -</PRE><P>
495   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_plot_extinction.pro)</STRONG><P>
496   -<HR>
497   -
498   -<A NAME="DUSTEM_PLOT_FIT_SED">
499   -<H2>DUSTEM_PLOT_FIT_SED</H2></A>
500   -<A HREF="#DUSTEM_PLOT_EXTINCTION">[Previous Routine]</A>
501   -<A HREF="#DUSTEM_PLOT_NUINU_EM">[Next Routine]</A>
502   -<A HREF="#ROUTINELIST">[List of Routines]</A>
503   -<PRE>
504   - NAME:
505   - dustem_plot_fit_sed
506   - PURPOSE:
507   - Plots a Dustem model and SED. Parameter values and error are
508   - printed on plot. Used for plotting results during fit.
509   - CATEGORY:
510   - Dustem
511   - CALLING SEQUENCE:
512   - dustem_plot_fit_sed,st,sed,cont[,/no_spec_error][,res=][,errors=][,chi2=][,rchi2=][/help][_extra=]
513   - INPUTS:
514   - st = Dustem model output structure
515   - sed = Dustem model SED
516   - cont = Dustem model NIR continuum
517   - OPTIONAL INPUT PARAMETERS:
518   - res = fit result values. If set values are written on plot.
519   - errors = fit result errors. If set values are written on plot.
520   - chi2 = fit chi^2. if set value is written on plot.
521   - rchi2 = Reduced fit chi^2. if set value is written on plot.
522   - _extra = extra parameters for the plot routine
523   - OUTPUTS:
524   - None
525   - OPTIONAL OUTPUT PARAMETERS:
526   - None
527   - ACCEPTED KEY-WORDS:
528   - help = If set, print this help
529   - COMMON BLOCKS:
530   - None
531   - SIDE EFFECTS:
532   - SED and model are plotted
533   - RESTRICTIONS:
534   - The dustem idl wrapper must be installed
535   - PROCEDURE:
536   - None
537   - EXAMPLES
538   - dustem_plot_fit_sed,st,sed,cont
539   - MODIFICATION HISTORY:
540   - Written by J.-Ph. Bernard
541   - see evolution details on the dustem cvs maintained at CESR
542   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
543   -</PRE><P>
544   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_plot_fit_sed.pro)</STRONG><P>
545   -<HR>
546   -
547   -<A NAME="DUSTEM_PLOT_NUINU_EM">
548   -<H2>DUSTEM_PLOT_NUINU_EM</H2></A>
549   -<A HREF="#DUSTEM_PLOT_FIT_SED">[Previous Routine]</A>
550   -<A HREF="#DUSTEM_READ_ALL">[Next Routine]</A>
551   -<A HREF="#ROUTINELIST">[List of Routines]</A>
552   -<PRE>
553   - NAME:
554   - dustem_plot_nuinu_em
555   - PURPOSE:
556   - Plots a Dustem spectrum
557   - CATEGORY:
558   - Dustem
559   - CALLING SEQUENCE:
560   - dustem_plot_fit_sed,st[,/help][,_extra=]
561   - INPUTS:
562   - st = Dustem model output structure
563   - OPTIONAL INPUT PARAMETERS:
564   - _extra = extra parameters for the plot routine
565   - OUTPUTS:
566   - None
567   - OPTIONAL OUTPUT PARAMETERS:
568   - None
569   - ACCEPTED KEY-WORDS:
570   - help = If set, print this help
571   - COMMON BLOCKS:
572   - None
573   - SIDE EFFECTS:
574   - model is plotted
575   - RESTRICTIONS:
576   - The dustem idl wrapper must be installed
577   - PROCEDURE:
578   - None
579   - EXAMPLES
580   - dustem_init,/wrap
581   - dir=getenv('DUSTEM_RES')
582   - st=dustem_read_all_res(dir)
583   - dustem_plot_nuinu_em,st,yr=[1e-28,1.e-22],/ysty,xr=[1,5e3],/xsty
584   - MODIFICATION HISTORY:
585   - Written by J.-Ph. Bernard
586   - see evolution details on the dustem cvs maintained at CESR
587   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
588   -</PRE><P>
589   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_plot_nuinu_em.pro)</STRONG><P>
590   -<HR>
591   -
592   -<A NAME="DUSTEM_READ_ALL">
593   -<H2>DUSTEM_READ_ALL</H2></A>
594   -<A HREF="#DUSTEM_PLOT_NUINU_EM">[Previous Routine]</A>
595   -<A HREF="#DUSTEM_READ_ALL_RES">[Next Routine]</A>
596   -<A HREF="#ROUTINELIST">[List of Routines]</A>
597   -<PRE>
598   - NAME:
599   - dustem_read_all
600   - PURPOSE:
601   - Reads all Dustem input data
602   - CATEGORY:
603   - Dustem
604   - CALLING SEQUENCE:
605   - st=dustem_read_all(dir_in,silent=silent,help=help)
606   - INPUTS:
607   - dir_in: input directory
608   - OPTIONAL INPUT PARAMETERS:
609   - None
610   - OUTPUTS:
611   - st: input structure
612   - OPTIONAL OUTPUT PARAMETERS:
613   - None
614   - ACCEPTED KEY-WORDS:
615   - silent = If set, function is silent
616   - help = If set, print this help
617   - COMMON BLOCKS:
618   - None
619   - SIDE EFFECTS:
620   - None
621   - RESTRICTIONS:
622   - The dustem idl wrapper must be installed
623   - PROCEDURE:
624   - None
625   - EXAMPLES
626   - dustem_init
627   - dir=getenv('DUSTEM_SOFT_DIR')+'/src/dustem3.8_web/'
628   - st=dustem_read_all(dir)
629   - MODIFICATION HISTORY:
630   - Written by J.-Ph. Bernard
631   - see evolution details on the dustem cvs maintained at CESR
632   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
633   -</PRE><P>
634   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_read_all.pro)</STRONG><P>
635   -<HR>
636   -
637   -<A NAME="DUSTEM_READ_ALL_RES">
638   -<H2>DUSTEM_READ_ALL_RES</H2></A>
639   -<A HREF="#DUSTEM_READ_ALL">[Previous Routine]</A>
640   -<A HREF="#DUSTEM_RESTORE_SED_FIT">[Next Routine]</A>
641   -<A HREF="#ROUTINELIST">[List of Routines]</A>
642   -<PRE>
643   - NAME:
644   - dustem_read_all_res
645   - PURPOSE:
646   - Reads all Dustem outputs
647   - CATEGORY:
648   - Dustem
649   - CALLING SEQUENCE:
650   - st=dustem_read_all_res(dir_out[,/silent][,/help])
651   - INPUTS:
652   - dir_out: Dustem output directory
653   - OPTIONAL INPUT PARAMETERS:
654   - None
655   - OUTPUTS:
656   - st: Dustem output structure
657   - structure:
658   - DUSTEM STRUCT -> <Anonymous> Array[800]
659   - WAV FLOAT 0.0400000
660   - EM_GRAIN_1 FLOAT 0.00000
661   - EM_GRAIN_2 FLOAT 0.00000
662   - EM_GRAIN_3 FLOAT 0.00000
663   - EM_GRAIN_4 FLOAT 0.00000
664   - EM_GRAIN_5 FLOAT 0.00000
665   - EM_TOT FLOAT 0.00000
666   - EXT STRUCT -> <Anonymous> Array[799]
667   - WAV FLOAT 0.0406570
668   - ABS_GRAIN FLOAT Array[5]
669   - SCA_GRAIN FLOAT Array[5]
670   - OPTIONAL OUTPUT PARAMETERS:
671   - None
672   - ACCEPTED KEY-WORDS:
673   - help = If set, print this help
674   - silent = If set, function is silent
675   - COMMON BLOCKS:
676   - None
677   - SIDE EFFECTS:
678   - None
679   - RESTRICTIONS:
680   - The dustem idl wrapper must be installed
681   - PROCEDURE:
682   - None
683   - EXAMPLES
684   - dustem_init,/wrap
685   - dir=getenv('DUSTEM_RES')
686   - st=dustem_read_all_res(dir)
687   - help,st,/str
688   - MODIFICATION HISTORY:
689   - Written by J.-Ph. Bernard
690   - see evolution details on the dustem cvs maintained at CESR
691   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
692   -</PRE><P>
693   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_read_all_res.pro)</STRONG><P>
694   -<HR>
695   -
696   -<A NAME="DUSTEM_RESTORE_SED_FIT">
697   -<H2>DUSTEM_RESTORE_SED_FIT</H2></A>
698   -<A HREF="#DUSTEM_READ_ALL_RES">[Previous Routine]</A>
699   -<A HREF="#DUSTEM_RUN">[Next Routine]</A>
700   -<A HREF="#ROUTINELIST">[List of Routines]</A>
701   -<PRE>
702   - NAME:
703   - dustem_restore_sed_fit
704   - PURPOSE:
705   - Restore Dustem SED fit results from a file.
706   - CATEGORY:
707   - Dustem
708   - CALLING SEQUENCE:
709   - dustem_restore_sed_fit,file[,/help]
710   - INPUTS:
711   - file = File name
712   - OPTIONAL INPUT PARAMETERS:
713   - None
714   - OUTPUTS:
715   - None
716   - OPTIONAL OUTPUT PARAMETERS:
717   - None
718   - ACCEPTED KEY-WORDS:
719   - help = If set, print this help
720   - COMMON BLOCKS:
721   - None
722   - SIDE EFFECTS:
723   - The !dustem_fit structure is updated
724   - The !dustem_data, !dustem_filters, !dustem_verbose and
725   - !run_ionfrac are also affected.
726   - RESTRICTIONS:
727   - The dustem idl wrapper must be installed
728   - PROCEDURE:
729   - None
730   - EXAMPLES
731   - dustem_fit_sed_readme
732   - file=getenv('DUSTEM_RES')+'DUSTEM_fit_example.sav'
733   - dustem_restore_sed_fit,file
734   - MODIFICATION HISTORY:
735   - Written by J.-Ph. Bernard
736   - see evolution details on the dustem cvs maintained at CESR
737   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
738   -</PRE><P>
739   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_restore_sed_fit.pro)</STRONG><P>
740   -<HR>
741   -
742   -<A NAME="DUSTEM_RUN">
743   -<H2>DUSTEM_RUN</H2></A>
744   -<A HREF="#DUSTEM_RESTORE_SED_FIT">[Previous Routine]</A>
745   -<A HREF="#DUSTEM_RUN_README">[Next Routine]</A>
746   -<A HREF="#ROUTINELIST">[List of Routines]</A>
747   -<PRE>
748   - NAME:
749   - dustem_run
750   - PURPOSE:
751   - Runs the DUSTEM code and returns the results into a structure.
752   - CATEGORY:
753   - Dustem
754   - CALLING SEQUENCE:
755   - st=dustem_run(params[,/help])
756   - INPUTS:
757   - params = model parameter values
758   - OPTIONAL INPUT PARAMETERS:
759   - None
760   - OUTPUTS:
761   - st: output structure
762   - OPTIONAL OUTPUT PARAMETERS:
763   - None
764   - ACCEPTED KEY-WORDS:
765   - help = If set, print this help
766   - COMMON BLOCKS:
767   - None
768   - SIDE EFFECTS:
769   - None
770   - RESTRICTIONS:
771   - The dustem idl wrapper must be installed
772   - PROCEDURE:
773   - None
774   - EXAMPLES
775   - st=dustem_run(params)
776   - MODIFICATION HISTORY:
777   - Written by J.-Ph. Bernard, N. Flagey, D. Paradis Jan 2007
778   - see evolution details on the dustem cvs maintained at CESR
779   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
780   -</PRE><P>
781   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_run.pro)</STRONG><P>
782   -<HR>
783   -
784   -<A NAME="DUSTEM_RUN_README">
785   -<H2>DUSTEM_RUN_README</H2></A>
786   -<A HREF="#DUSTEM_RUN">[Previous Routine]</A>
787   -<A HREF="#DUSTEM_SAVE_SED_FIT">[Next Routine]</A>
788   -<A HREF="#ROUTINELIST">[List of Routines]</A>
789   -<PRE>
790   - NAME:
791   - dustem_run_readme
792   - PURPOSE:
793   - This is an example of how to run dustem SEDs with the dustem wrapper.
794   - CATEGORY:
795   - Dustem
796   - CALLING SEQUENCE:
797   - dustem_run_readme,mode=mode,help=help,/postcript,/help,/plot_it
798   - INPUTS:
799   - None
800   - OPTIONAL INPUT PARAMETERS:
801   - None
802   - OUTPUTS:
803   - None
804   - OPTIONAL OUTPUT PARAMETERS:
805   - None
806   - ACCEPTED KEY-WORDS:
807   - mode = Selects one of the dust mixture used by dustem
808   - 'COMPIEGNE_ETAL2010' from Compiegne et al 2010 (default)
809   - 'DBP90' from Desert et al 1990
810   - 'DL01' from Draine & Li 2001
811   - 'DL07' from Draine & Li 2007
812   - postcript = if set, plot is done in DUSTEM/Docs/Figures/Last_dustem_fit.ps
813   - help = If set, print this help
814   - COMMON BLOCKS:
815   - None
816   - SIDE EFFECTS:
817   - None
818   - RESTRICTIONS:
819   - The dustem fortran code must be installed
820   - The dustem idl wrapper must be installed
821   - PROCEDURE:
822   - None
823   - EXAMPLES
824   - dustem_run_readme,mode='COMPIEGNE_ETAL2010'
825   - MODIFICATION HISTORY:
826   - Written by J.P. Bernard April 1st 2011
827   - see evolution details on the dustem cvs maintained at CESR
828   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
829   -</PRE><P>
830   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_run_readme.pro)</STRONG><P>
831   -<HR>
832   -
833   -<A NAME="DUSTEM_SAVE_SED_FIT">
834   -<H2>DUSTEM_SAVE_SED_FIT</H2></A>
835   -<A HREF="#DUSTEM_RUN_README">[Previous Routine]</A>
836   -<A HREF="#DUSTEM_SET_DATA">[Next Routine]</A>
837   -<A HREF="#ROUTINELIST">[List of Routines]</A>
838   -<PRE>
839   - NAME:
840   - dustem_save_sed_fit
841   - PURPOSE:
842   - Save Dustem SED fit results in a file
843   - CATEGORY:
844   - Dustem
845   - CALLING SEQUENCE:
846   - dustem_save_sed_fit,file[,/help]
847   - INPUTS:
848   - file = File name
849   - OPTIONAL INPUT PARAMETERS:
850   - None
851   - OUTPUTS:
852   - None
853   - OPTIONAL OUTPUT PARAMETERS:
854   - None
855   - ACCEPTED KEY-WORDS:
856   - help = If set, print this help
857   - COMMON BLOCKS:
858   - None
859   - SIDE EFFECTS:
860   - File is stored.
861   - The stored data are taken from !dustem_fit, !dustem_data,
862   - !dustem_filters, !dustem_verbose and !run_ionfrac
863   - RESTRICTIONS:
864   - The dustem idl wrapper must be installed
865   - PROCEDURE:
866   - None
867   - EXAMPLES
868   -
869   - MODIFICATION HISTORY:
870   - Written by J.-Ph. Bernard
871   - see evolution details on the dustem cvs maintained at CESR
872   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
873   -</PRE><P>
874   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_save_sed_fit.pro)</STRONG><P>
875   -<HR>
876   -
877   -<A NAME="DUSTEM_SET_DATA">
878   -<H2>DUSTEM_SET_DATA</H2></A>
879   -<A HREF="#DUSTEM_SAVE_SED_FIT">[Previous Routine]</A>
880   -<A HREF="#DUSTEM_SET_FUNC_IND">[Next Routine]</A>
881   -<A HREF="#ROUTINELIST">[List of Routines]</A>
882   -<PRE>
883   - NAME:
884   - dustem_set_data
885   - PURPOSE:
886   - Initializes the dustem data structure (!dustem_data)
887   - CATEGORY:
888   - Dustem
889   - CALLING SEQUENCE:
890   - dustem_set_data,spec[,help=]
891   - INPUTS:
892   - spec: array of structures containing a SED
893   - OPTIONAL INPUT PARAMETERS:
894   - None
895   - OUTPUTS:
896   - None
897   - OPTIONAL OUTPUT PARAMETERS:
898   - None
899   - ACCEPTED KEY-WORDS:
900   - help = If set print this help
901   - COMMON BLOCKS:
902   - None
903   - SIDE EFFECTS:
904   - initializes !dustem_data
905   - wavelengths are forced to be the central filter wavelength for
906   - photometric data
907   - RESTRICTIONS:
908   - The dustem idl wrapper must be installed
909   - PROCEDURE:
910   - None
911   - EXAMPLES
912   - dustem_init
913   - dir=getenv('DUSTEM_SOFT_DIR')+'/src/dustem3.8_web/SEDs/'
914   - file=dir+'Gal_composite_spectrum.xcat'
915   - spec=read_xcat(file,/silent)
916   - dustem_set_data,spec
917   - MODIFICATION HISTORY:
918   - Written by J.-Ph. Bernard
919   - see evolution details on the dustem cvs maintained at CESR
920   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
921   -</PRE><P>
922   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_set_data.pro)</STRONG><P>
923   -<HR>
924   -
925   -<A NAME="DUSTEM_SET_FUNC_IND">
926   -<H2>DUSTEM_SET_FUNC_IND</H2></A>
927   -<A HREF="#DUSTEM_SET_DATA">[Previous Routine]</A>
928   -<A HREF="#DUSTEM_WRITE_ALL">[Next Routine]</A>
929   -<A HREF="#ROUTINELIST">[List of Routines]</A>
930   -<PRE>
931   - NAME:
932   - dustem_set_func_ind
933   - CALLING SEQUENCE:
934   - dustem_set_func_ind
935   - PURPOSE:
936   - Sorts the parameter descriptions and values the way they must
937   - be processed.
938   - INPUTS:
939   - None
940   - OPTIONAL INPUT:
941   - None
942   - OUTPUTS:
943   - None
944   - PROCEDURE AND SUBROUTINE USED
945   - Parameter description (!param_desc) and values (!init_value) are
946   - ordered the way they should be processed. The ordered information
947   - is put into system variables !PDO and !IDO respectively
948   - If the isrf is being modified, then, PAH ionization fraction
949   - is set to be updated as well.
950   - SIDE EFFECTS:
951   - !PDO and !IDO variables are set.
952   - Optionally !ionfrac is set.
953   - The !func_ind variable is set.
954   - MODIFICATION HISTORY:
955   - See cvs logs
956   - Written by NF,JPB,DP Jan-2007
957   -</PRE><P>
958   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_set_func_ind.pro)</STRONG><P>
959   -<HR>
960   -
961   -<A NAME="DUSTEM_WRITE_ALL">
962   -<H2>DUSTEM_WRITE_ALL</H2></A>
963   -<A HREF="#DUSTEM_SET_FUNC_IND">[Previous Routine]</A>
964   -<A HREF="#ROUTINELIST">[List of Routines]</A>
965   -<PRE>
966   - NAME:
967   - dustem_write_all
968   - PURPOSE:
969   - Write all Dustem input data
970   - CATEGORY:
971   - Dustem
972   - CALLING SEQUENCE:
973   - dustem_write_all,st,dir_out[,/help]
974   - INPUTS:
975   - st: Dustem input structure
976   - dir_out: output directory
977   - OPTIONAL INPUT PARAMETERS:
978   - None
979   - OUTPUTS:
980   - None
981   - OPTIONAL OUTPUT PARAMETERS:
982   - None
983   - ACCEPTED KEY-WORDS:
984   - help = If set, print this help
985   - COMMON BLOCKS:
986   - None
987   - SIDE EFFECTS:
988   - None
989   - RESTRICTIONS:
990   - The dustem idl wrapper must be installed
991   - PROCEDURE:
992   - None
993   - EXAMPLES
994   - dustem_init
995   - dir=getenv('DUSTEM_SOFT_DIR')+'/src/dustem3.8_web/'
996   - st=dustem_read_all(dir)
997   - dirout=getenv('DUSTEM_DAT')
998   - dustem_write_all,st,dirout
999   - MODIFICATION HISTORY:
1000   - Written by J.-Ph. Bernard
1001   - see evolution details on the dustem cvs maintained at CESR
1002   - Contact J.-Ph. Bernard (Jean-Philippe.Bernard@cesr.fr) in case of problems.
1003   -</PRE><P>
1004   -<STRONG>(See /Users/jpb/Soft_Librairies/DUSTEM/src/idl/dustem_write_all.pro)</STRONG><P>
1005   -<HR>
1006   -
1007   -</body>
1008   -</html>
Docs/Flow_charts/dustem-wrapper_flow_chart1.drawio renamed to Docs/developers/Code_Structure_Flowcharts/dustem-wrapper_flow_chart1.drawio
  Diff comments   View file @5051ce3
Docs/Flow_charts/dustem-wrapper_flow_chart1.png renamed to Docs/developers/Code_Structure_Flowcharts/dustem-wrapper_flow_chart1.png
View file @5051ce3

387 KB
Docs/examples/List_of_Dustem_IDL_system_variables.txt renamed to Docs/developers/List_of_Dustem_IDL_system_variables.txt
  Diff comments   View file @5051ce3
Docs/examples/DustemWrap_development_issues.txt deleted
View file @d6c8ffc
... ... @@ -1,14 +0,0 @@
1   -%This is a note describing known current development issues for Dustem
2   -%This file is called DustemWrap_development_issues.txt and is managed by J.-Ph. Bernard and Ilyes Choubani
3   -%Issues must be described as explicitly as possible
4   -%These issues must be checked before the next joint release of Dustem and Dustemwrap
5   -
6   -- JPB, April 8th 2022:
7   - Dustem has a bug due to calculation accuracy for the THEMIS model, which solves by replacing max size values in GRAIN_THEMIS.DAT from 9.00E-6 into 8.99E-05
8   -
9   -- JPB, April 8th 2022:
10   - Dustemwrap causes the Fortran to crash if the chrg keyword is not specified in the initial GRAIN.DAT file, but is subsequently added by the (*!dustem_params).grains[0].TYPE_KEYWORDS. A similar error is likely to occur for the spin keyword (untested).
11   - We must force these pointers to not be empty just after writing our own GRAIN.DAT in /tmp, in the same way this is done in dustem_init.pro with the GRAIN.DAT from the fortran directory.
12   -- *FOLLOW UP*: IC, May 15th 2022: A SOLUTION HAS BEEN IMPLEMENTED BY INTRODUCING the 'kwords'
13   -;keyword and specifying the necessary population keywords. IE: kwords=['plaw-ed-chrg-spin'] for the first grain population
14   -;to enable the use of spinning dust. THIS IS NOT AN ISSUE ANYMORE.
15 0 \ No newline at end of file