Commit 2d680c92d210e212f8f4a33131d37aa551244e6f
1 parent
ecfb8fb3
Exists in
master
minor updates
Showing
1 changed file
with
26 additions
and
37 deletions
Show diff stats
README.txt
| 1 | -************************** | ||
| 2 | -Readme File for DustemWrap | ||
| 3 | -************************** | 1 | +******************************* |
| 2 | +Readme File for DustemWrap V4.3 | ||
| 3 | +******************************* | ||
| 4 | 4 | ||
| 5 | 0. What is this? | 5 | 0. What is this? |
| 6 | **************** | 6 | **************** |
| 7 | 7 | ||
| 8 | -This package contains the DustEMWrap software, developed and maintained at the Institute of Research in Astrophysics and Planetology (IRAP). | 8 | +This package contains the DustEMWrap v4.3 software, developed and maintained at the Institute of Research in Astrophysics and Planetology (IRAP). |
| 9 | 9 | ||
| 10 | -DustemWrap requires the fortran code DUSTEM, which is developed and maintained at the Institute of Space Astrophysics (IAS). The DUSTEM fortran code must be downloaded separately (see the DustEMWrap Users' Guide for instructions about obtaining and installing DUSTEM.) | 10 | +DustemWrap requires the fortran code DustEM, which is developed and maintained at the Institute of Space Astrophysics (IAS). The DustEM fortran code must be downloaded separately (see the DustEMWrap Users' Guide for instructions about obtaining and installing DustEM.) |
| 11 | 11 | ||
| 12 | -A static version of the DustemWrap Users' Guide corresponding to this distribution is provided in Docs/DustEMWrap_UG.pdf | 12 | +More information, including a Users' Guide, is available at the DustEMWrap website, http://dustemwrap.irap.omp.eu |
| 13 | 13 | ||
| 14 | -The Users' Guide contains: | ||
| 15 | -* instructions for obtaining DUSTEM | ||
| 16 | -* installation instructions for the current releases of DustEMWrap and DUSTEM | ||
| 17 | -* an overview of how DustEMWrap works, including how it interacts with the underlying DUSTEM fortran code | 14 | +A non-exhaustive list of information on the website : |
| 15 | +* instructions for obtaining DustEM | ||
| 16 | +* installation instructions for the current releases of DustEMWrap and DustEM | ||
| 17 | +* an overview of how DustEMWrap works, including how it interacts with the underlying DustEM fortran code | ||
| 18 | * format requirements for user input | 18 | * format requirements for user input |
| 19 | * a description of how color corrections and plugins are implemented in DustEMWrap | 19 | * a description of how color corrections and plugins are implemented in DustEMWrap |
| 20 | * a description of the individual DustEMWrap routines | 20 | * a description of the individual DustEMWrap routines |
| 21 | -* usage examples (see also the files in the Docs/examples/ subdirectory) | ||
| 22 | - | ||
| 23 | -A continuously updated version of the Users' Guide, a FAQ and list of known current issues, can be accessed via the DustEMWrap website at the following URL: | ||
| 24 | -http://dustemwrap.irap.omp.eu/ | 21 | +* step-by-step examples |
| 22 | +* patches, minor updates | ||
| 23 | +* FAQ and list of current known issues | ||
| 25 | 24 | ||
| 26 | 25 | ||
| 27 | 1. Directory Structure and Files | 26 | 1. Directory Structure and Files |
| @@ -31,27 +30,19 @@ The DustEMWrap directory is organized as follows: | @@ -31,27 +30,19 @@ The DustEMWrap directory is organized as follows: | ||
| 31 | 30 | ||
| 32 | - Data | 31 | - Data |
| 33 | 32 | ||
| 34 | -This directory contains data files that may be read by DustEMWrap. It contains the following subdirectories: | ||
| 35 | - | ||
| 36 | - -- EXTs | ||
| 37 | - | ||
| 38 | -Dust extinction curves (Stokes I) | 33 | +This directory contains data files that are read by DustEMWrap. It contains the following subdirectories: |
| 34 | + | ||
| 35 | + -- EXAMPLE_OBSDATA FIDUCIAL_CC FILTERS STELLARPOPS | ||
| 36 | + | ||
| 37 | +Example SEDs and extinction curves | ||
| 39 | 38 | ||
| 40 | -- FILTERS | 39 | -- FILTERS |
| 41 | 40 | ||
| 42 | -Filter transmission information | 41 | +Filter transmission information for instruments known to DustEMWrap |
| 43 | 42 | ||
| 44 | - -- POLEXTs | 43 | + -- STELLARPOPS |
| 45 | 44 | ||
| 46 | -Dust extinction curves (Stokes QU) | ||
| 47 | - | ||
| 48 | --- SEDs | ||
| 49 | - | ||
| 50 | -Dust emission SEDs (Stokes IQU) | ||
| 51 | - | ||
| 52 | -- Docs | ||
| 53 | - | ||
| 54 | -Documentation relating to DustEMWrap, including the Users' Guide and some simple usage examples. Other files in this directory contain more detailed information about the code structure that may be of interest to developers and expert users who wish to contribute plugins. | 45 | +Stellar parameters, used by plugins for modifying the dust-heating ISRF. |
| 55 | 46 | ||
| 56 | - README.txt | 47 | - README.txt |
| 57 | 48 | ||
| @@ -62,11 +53,6 @@ This file. | @@ -62,11 +53,6 @@ This file. | ||
| 62 | A keyfile describing the instruments and filters that are known to the DustEMWrap code. | 53 | A keyfile describing the instruments and filters that are known to the DustEMWrap code. |
| 63 | For new users, we recommend contacting the DustEMWrap team if there are instruments and/or filters that you would like implemented. | 54 | For new users, we recommend contacting the DustEMWrap team if there are instruments and/or filters that you would like implemented. |
| 64 | 55 | ||
| 65 | -- plugins_description.xcat | ||
| 66 | - | ||
| 67 | -A keyfile describing the plugins that are known to the DustEMWrap code. | ||
| 68 | -Plugins can be defined by the user. See the Users' Guide and other documentation for a description of how plugins are called and understood by the DustEMWrap code. | ||
| 69 | - | ||
| 70 | - src | 56 | - src |
| 71 | 57 | ||
| 72 | This directory contains the IDL code. It contains the following subdirectories: | 58 | This directory contains the IDL code. It contains the following subdirectories: |
| @@ -75,10 +61,13 @@ This directory contains the IDL code. It contains the following subdirectories: | @@ -75,10 +61,13 @@ This directory contains the IDL code. It contains the following subdirectories: | ||
| 75 | 61 | ||
| 76 | The core DustEMWrap routines | 62 | The core DustEMWrap routines |
| 77 | 63 | ||
| 78 | - -- idl_misc | 64 | + -- idl_extern |
| 79 | 65 | ||
| 80 | Routines from external libraries that are used by DustEMWrap. They are provided in case of conflicts/installation issues with the required external libraries. | 66 | Routines from external libraries that are used by DustEMWrap. They are provided in case of conflicts/installation issues with the required external libraries. |
| 81 | -See the Users' Guide for instructions about modifying your path so that the routines in idl_misc are given precedence. | 67 | + |
| 68 | + -- idl_special | ||
| 69 | + | ||
| 70 | +IDL routines used by DustEMWrap that have been deprecated in recent IDL versions. These are backups for safe-keeping. | ||
| 82 | 71 | ||
| 83 | 2. Getting Help | 72 | 2. Getting Help |
| 84 | *************** | 73 | *************** |