Commit 93cd417b4c83d5d096a9bf491ac9d977394703b2
1 parent
cd49cdc0
Exists in
master
updated help
Showing
2 changed files
with
25 additions
and
3 deletions
Show diff stats
src/idl/dustem_sort_params.pro
@@ -3,32 +3,53 @@ PRO dustem_sort_params | @@ -3,32 +3,53 @@ PRO dustem_sort_params | ||
3 | ;+ | 3 | ;+ |
4 | ; NAME: | 4 | ; NAME: |
5 | ; dustem_sort_params | 5 | ; dustem_sort_params |
6 | +; | ||
7 | +; CATEGORY: | ||
8 | +; DustEMWrap, Distributed, Low-Level | ||
9 | +; | ||
6 | ; CALLING SEQUENCE: | 10 | ; CALLING SEQUENCE: |
7 | ; dustem_sort_params | 11 | ; dustem_sort_params |
12 | +; | ||
8 | ; PURPOSE: | 13 | ; PURPOSE: |
9 | ; Sorts the parameter descriptions and values the way they must | 14 | ; Sorts the parameter descriptions and values the way they must |
10 | ; be processed. | 15 | ; be processed. |
16 | +; | ||
11 | ; INPUTS: | 17 | ; INPUTS: |
12 | ; None | 18 | ; None |
19 | +; | ||
13 | ; OPTIONAL INPUT: | 20 | ; OPTIONAL INPUT: |
14 | ; None | 21 | ; None |
22 | +; | ||
15 | ; OUTPUTS: | 23 | ; OUTPUTS: |
16 | ; None | 24 | ; None |
25 | +; | ||
17 | ; PROCEDURE AND SUBROUTINE USED | 26 | ; PROCEDURE AND SUBROUTINE USED |
18 | ; Parameter description (!param_desc) and values (!init_value) are | 27 | ; Parameter description (!param_desc) and values (!init_value) are |
19 | ; ordered the way they should be processed. The ordered information | 28 | ; ordered the way they should be processed. The ordered information |
20 | ; is put into system variables !PDO and !IDO respectively | 29 | ; is put into system variables !PDO and !IDO respectively |
21 | ; If the isrf is being modified, then, PAH ionization fraction | 30 | ; If the isrf is being modified, then, PAH ionization fraction |
22 | ; is set to be updated as well. | 31 | ; is set to be updated as well. |
32 | +; | ||
23 | ; SIDE EFFECTS: | 33 | ; SIDE EFFECTS: |
24 | ; !PDO and !IDO variables are set. | 34 | ; !PDO and !IDO variables are set. |
25 | ; Optionally !ionfrac is set. | 35 | ; Optionally !ionfrac is set. |
26 | ; The !func_ind variable is set. | 36 | ; The !func_ind variable is set. |
37 | +; | ||
38 | +; RESTRICTIONS: | ||
39 | +; The DustEM fortran code must be installed | ||
40 | +; The DustEMWrap IDL code must be installed | ||
41 | +; | ||
27 | ; MODIFICATION HISTORY: | 42 | ; MODIFICATION HISTORY: |
28 | -; See cvs logs | ||
29 | -; Written by NF,JPB,DP Jan-2007 | 43 | +; Written by NF,JPB,DP Jan-2007 |
44 | +; Evolution details on the DustEMWrap gitlab. | ||
45 | +; See http://dustemwrap.irap.omp.eu/ for FAQ and help. | ||
30 | ;- | 46 | ;- |
31 | 47 | ||
48 | + IF keyword_set(help) THEN BEGIN | ||
49 | + doc_library,'dustem_sort_params' | ||
50 | + goto,the_end | ||
51 | + END | ||
52 | + | ||
32 | nparam = n_elements(*!param_desc) | 53 | nparam = n_elements(*!param_desc) |
33 | !func_ind=ptr_new(fltarr(nparam)) | 54 | !func_ind=ptr_new(fltarr(nparam)) |
34 | 55 |
src/idl/dustem_test_model_exists.pro
@@ -3,7 +3,8 @@ function dustem_test_model_exists,model $ | @@ -3,7 +3,8 @@ function dustem_test_model_exists,model $ | ||
3 | ,polarisation=polarisation $ | 3 | ,polarisation=polarisation $ |
4 | ,silent=silent | 4 | ,silent=silent |
5 | 5 | ||
6 | -;+ NAME: | 6 | +;+ |
7 | +; NAME: | ||
7 | ; dustem_test_model_exists | 8 | ; dustem_test_model_exists |
8 | ; | 9 | ; |
9 | ; PURPOSE: | 10 | ; PURPOSE: |