Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reorganize documentation

For Pandeia Engine v1.5.1

Table of Contents

Requirements

...

Installation

Code

...

python 2.7+

...

numpy 1.13.3+

...

scipy >1.4

...

astropy 2--3

...

We recommend using the Anaconda python distribution.

  1. Follow its installation instructions to set up a new environment if you do not already have one.
  2. Once installed, from a terminal with access to the conda environment, type "conda config --add channels http://ssb.stsci.edu/astroconda" to install the Astroconda channel.
  3. Create an AstroConda environment with the STScI package installed. For example, to create an environment named "pandeia" working under python 3.6, type
Code Block
languagebash
conda create -n pandeia stsci numpy scipy=1.1 astropy=2 photutils pysynphot setuptools python=3.6

from a terminal with access to the conda environment.

4. Then, install the engine itself:

Code Block
languagebash
pip install pandeia.engine==1.5.1


It should also be possible to install the Pandeia Engine and all its dependencies by simply running `pip install pandeia.engine==1.5.1` but this is not recommended and users are likely to run into more issues if it is installed this way.

Then set up the data files.

...

Data

Required Data

In order to function, the Pandeia Engine requires one* set of reference data (containing instrument definitions):

Download and untar the files to a suitable location.

Environment variable: $pandeia_refdata must point to the The location of the top of the data file tree (the folder containing PSF_VERSION) must be set as the $pandeia_refdata environment variable.

*Both telescope datasets may be untarred to the same location to produce an engine that can work with either telescope; any files the two packages have in common may be overwritten.

Optional Data

The Once untarred, the files will produce a directory tree of grp/hst/cdbs; the Pandeia Engine expects the environment variable .

Environment variable: $PYSYN_CDBS to must point to the cdbs directory .

Installation

We recommend using the Anaconda python distribution. Follow its installation instructions to set up a new environment if you do not already have one.

Once installed, from a terminal with access to the conda environment, type "conda config --add channels http://ssb.stsci.edu/astroconda" to install the Astroconda channel.

Create an AstroConda environment with the STScI package installed. For example, to create an environment named "pandeia" working under python 3.6, type

Code Block
languagebash
conda create -n pandeia stsci numpy scipy=1.1 astropy=2 photutils pysynphot setuptools python=3.6

from a terminal with access to the conda environment.

Then, install the engine itself: `pip install pandeia.engine==1.5.1`

...

(NOT grp)

Requirements

RequiredRecommended

python 2.7+

3.6.5

numpy 1.13.3+

1.15.4

scipy >1.4

1.1.0

astropy 2--3

2.0.9
photutils0.4
pysynphot0.9.12
setuptools40.8.0


Warning

pandeia.engine v1.5.1 is not compatible with scipy 1.4+ or astropy 4+

pandeia.engine v1.5.1 is the last version compatible with Python 2.7

Verify Installation

Open up a terminal with access to the conda installation, and type

...

Code Block
languagebash
titleInstallation script
linenumberstrue
conda config --add channels http://ssb.stsci.edu/astroconda
conda create -n pandeia stsci numpy scipy=1.1 astropy=2 python=3.6
mkdir -p ~/anaconda/envs/pandeia/etc/conda/activate.d
cat >>~/anaconda/envs/pandeia/etc/conda/activate.d/env_vars.sh <<EOF
#!/bin/sh
export PYSYN_CDBS=${HOME}/data/pysynphot
export pandeia_refdata=${HOME}/data/pandeia
EOF
mkdir -p ~/anaconda/envs/pandeia/etc/conda/deactivate.d
cat >>~/anaconda/envs/pandeia/etc/conda/deactivate.d/env_vars.sh <<EOF
#!/bin/sh
unset PYSYN_CDBS
unset pandeia_refdata
EOF
conda activate pandeia
pip install pandeia.engine==1.5.1

This creates a pandeia environment in an already-existing conda installation (line 2) and installs the pandeia.engine (line 16), and sets up two scripts (line 4, line 10) to automatically set and unset the required environment variables every time you activate and deactivate the pandeia environment.

Once this is done, 'conda activate pandeia' and 'conda deactivate pandeia' should perform all of the setup required.