**************************
Readme File for DustemWrap
**************************

0. What is this?
****************

This package contains the DustEMWrap software, developed and maintained at the Institute of Research in Astrophysics and Planetology (IRAP).

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.)

A static version of the DustemWrap Users' Guide corresponding to this distribution is provided in Docs/DustEMWrap_UG.pdf

The Users' Guide contains:
* instructions for obtaining DUSTEM
* installation instructions for the current releases of DustEMWrap and DUSTEM
* an overview of how DustEMWrap works, including how it interacts with the underlying DUSTEM fortran code
* format requirements for user input
* a description of how color corrections and plugins are implemented in DustEMWrap
* a description of the individual DustEMWrap routines
* usage examples (see also the files in the Docs/examples/ subdirectory)

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:
http://dustemwrap.irap.omp.eu/

1. Directory Structure and Files
********************************

The DustEMWrap directory is organized as follows:

- Data

This directory contains data files that may be read by DustEMWrap. It contains the following subdirectories:

-- EXTs

Dust extinction curves (Stokes I)

-- FILTERS

Filter transmission information

-- POLEXTs

Dust extinction curves (Stokes QU)

-- SEDs

Dust emission SEDs (Stokes IQU)

- Docs

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.

- README.txt

This file.

- instrument_description.xcat

A keyfile describing the instruments and filters that are known to the DustEMWrap code.
For new users, we recommend contacting the DustEMWrap team if there are instruments and/or filters that you would like implemented.

- plugins_description.xcat

A keyfile describing the plugins that are known to the DustEMWrap code.
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.

- src

This directory contains the IDL code. It contains the following subdirectories:

-- idl

The core DustEMWrap routines

-- idl_misc

Routines from external libraries that are used by DustEMWrap. They are provided in case of conflicts/installation issues with the required external libraries.
See the Users' Guide for instructions about modifying your path so that the routines in idl_misc are given precedence.

2. Getting Help
***************

The DustemWrap maintainers can be contacted by email: dustemwrap@irap.omp.eu

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'.