OV-GSO-DC / dustem-wrapper_idl

Commit 632f54bd9e1b101d155f87636557d242f6f98b30

Authored by Annie Hughes
1 parent b133430a
Exists in master

minor updates to README

Showing 1 changed file with 55 additions and 17 deletions   Show diff stats
Inline Side-by-side
README.txt
  Diff comments   View file @632f54b
  1 +**************************
1 2 Readme File for DustemWrap
2 3 **************************
3 4  
4 5 0. What is this?
  6 +****************
5 7  
6   -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 software, developed and maintained at the Institute of Research in Astrophysics and Planetology (IRAP).
7 9  
8   -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 on 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.)
9 11  
10   -A static version of the DustemWrap Users' Guide is provided in Docs/dustem_wrapper_UG.pdf
  12 +A static version of the DustemWrap Users' Guide corresponding to this distribution is provided in Docs/DustEMWrap_UG.pdf
11 13  
12 14 The Users' Guide contains:
13 15 * instructions for obtaining DUSTEM
14   -* installation instructions for the current releases of DustemWrap and DUSTEM
15   -* an overview of how DustemWrap works (including how it interacts with the underlying DUSTEM fortran code)
  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
16 18 * format requirements for user input
17   -* a description of how color corrections and plugins are implemented in Dustemwrap
18   -* a description of the individual DustemWrap routines
19   -* usage examples
  19 +* a description of how color corrections and plugins are implemented in DustEMWrap
  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/
20 25  
21   -A continuously updated version of the Users' Guide, including a FAQ and list of known current issues, is maintained at the following URL:
22   -https://www.overleaf.com/read/bbvrghjmffgn
23 26  
24 27 1. Directory Structure and Files
25 28 ********************************
26 29  
27   -The DustemWrap directory is organized as follows:
  30 +The DustEMWrap directory is organized as follows:
28 31  
29 32 - Data
30   - - EXTs
31   - - FILTERS
32   - - POLEXTs
33   - - SEDs
  33 +
  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)
  39 +
  40 + -- FILTERS
  41 +
  42 +Filter transmission information
  43 +
  44 + -- POLEXTs
  45 +
  46 +Dust extinction curves (Stokes QU)
  47 +
  48 +-- SEDs
  49 +
  50 +Dust emission SEDs (Stokes IQU)
34 51  
35 52 - Docs
36 53  
37   -- Readme
  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.
  55 +
  56 +- README.txt
  57 +
  58 +This file.
38 59  
39 60 - instrument_description.xcat
40 61  
  62 +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.
  64 +
41 65 - plugins_description.xcat
42 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 +
43 70 - src
44 71  
  72 +This directory contains the IDL code. It contains the following subdirectories:
  73 +
  74 + -- idl
  75 +
  76 +The core DustEMWrap routines
  77 +
  78 + -- idl_misc
  79 +
  80 +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.
  82 +
45 83 2. Getting Help
46 84 ***************
47 85  
48 86 The DustemWrap maintainers can be contacted by email: dustemwrap@irap.omp.eu
49 87  
50   -To be added to the DustemWrap mailing list and be informed of new releases and major bug fixes, please email dustemwrap@irap.omp.eu with the subject 'SUBSCRIBE'
  88 +To be added to the DustemWrap mailing list and be informed of new releases and any major bug fixes, please email dustemwrap@irap.omp.eu with the subject 'SUBSCRIBE'.
... ...