yinuohan / pandeia-coronagraphy

Toolkit for adding advanced coronagraph simulations on top of the Pandeia engine

Pandeia-Coronagraphy

Installation

It is highly recommended that you begin by installing AstroConda (with python 3.x) and then follow these installation instructions to install the Pandeia engine and the required reference files. Once Pandeia is set up, the following command will install this package:

pip install git+git://github.com/spacetelescope/pandeia-coronagraphy.git

---

Alternatively, follow these step-by-step instructions:

1. If you don't already have Anaconda or Miniconda installed, download and install the Python 3 version here.
2. Add the AstroConda channel to your Conda channels:

conda config --add channels http://ssb.stsci.edu/astroconda

3. Create a conda environment with the STScI software stack:

conda create -n astroconda stsci python=3

4. Activate this environment with source activate astroconda. (NB: Conda is only compatible with a BASH shell.)
5. Install the Pandeia engine following its instructions on JDox, in particular with this command: pip install pandeia.engine. (You should already have the Pysynphot package installed at this point. If you don't, install it with pip install pysynphot or conda install pysynphot. You can generate a list of installed packages with conda list.)
6. Download and install the matching Pandeia data files and the PySynphot data files. See the instructions on JDox for links to current versions of these files.
7. Add the following lines to your ~/.bashrc file (and source it after modifying):

export pandeia_refdata=/path/to/pandeia/data/directory
export PYSYN_CDBS=/path/to/cdbs/directory

8. Finally, install the pandeia-coronagraphy package:

pip install git+git://github.com/spacetelescope/pandeia-coronagraphy.git

9. (Optional, but highly recommended) Install WebbPSF with conda install webbpsf. This is required only if you are interested in using higher-fidelity PSFs in your calculations; otherwise, the Pandeia engine relies on interpolations of a bundled library of precomputed PSFs. This functionality is documented here and here.

Installing PySynphot Data Files

The entire PySynphot data file collection is quite large, and the PySynphot package expects a particular directory structure. If you're on the STScI network, you can skip this download and point the PYSYN_CDBS environment variable to the CDBS directory on central store instead (/grp/hst/cdbs). Otherwise, two (hopefully) helpful tips for installing the reference files locally:

1. Rather than download every package, you may be able to get away with downloading only the Pysynphot Phoenix Models (ftp://archive.stsci.edu/pub/hst/pysynphot/synphot5.tar.gz).
2. The .tar files will unpack to a directory structure that looks something like grp/hst/cdbs/etc. You'll need to consolidate the multiple structures into a single directory structure under cdbs. When setting up your environment variables in Step 7 (under Installation), you'll want to point to the cdbs directory directly.

Getting Started

Once installation is complete, take a look at the provided Jupyter notebooks for examples of constructing a scene, setting instrument properties, running the Pandeia engine, and performing some basic post-processing.

You can find a quickstart guide to using the Pandeia engine here.

Example input templates for the Pandeia engine are provided for coronagraphy here and for other instruments and observing modes here.