Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated for ETC 3.2

Table of Contents

For Pandeia Engine

...

v3.

...

0/v3.1/v3.2

Python Requirements

...

The Pandeia Engine is a Python module, and requires both code and data files to operate.

Code

:

RequiredRecommended

python

2

3.

7

8+

3.
6
11.
5
3

numpy 1.

13.3

17+

1.
15
23.
4
5

scipy

>1.4

1.10.1

astropy 5+

5.2.2
photutils1.7.0
synphot 1.0+

astropy 2--3

1.2.0
stsynphot 1.0+1.2.0
.9photutils0.4pysynphot0.9.12setuptools40.8.0
six1.16.0
setuptools67.7.0

Installing the Pandeia Engine requires a python environment with the dependencies listed above, a set of telescope-specific datafiles, and an optional (but highly recommended) second set of data files for additional spectral manipulation capabilities.

Code

The engine can be installed with

Code Block
languagebash
pip install pandeia.engine==3.2

or for Roman:

Code Block
languagebash
pip install pandeia.engine==3.1
Warning
We highly recommend installing into a fresh python environment, such as ones provided by the Anaconda Python distribution, to avoid problems. If you experience issues after installing the Pandeia Engine, consider starting again with a fresh python installation and a clean new set of data files.

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

...

  • jwst
  • Nancy Grace Roman Space Telescope:

...

Download and untar the files to a suitable location.

Environment variable: $pandeia_refdata must point to the location of the top of the data file tree (the

...

directory containing the VERSION_PSF

...

*Both telescope datasets may be untarred to the same location; any files the two packages have in common may be overwritten.

Optional Data

...

file)

Note
titleInstalling both data packages

You CAN untar both sets of files to the same location and run calculations for Webb and Roman. The sole difference between the packages are the jwst/ and roman/ directories (and the VERSION_PSF file, to reflect that Roman PSFs were regenerated with WebbPSF 1.0, instead of WebbPSF 1.1). You can either untar the second telescope on top of the first one and overwrite any files when prompted, or copy just the second telescope's directory into the $pandeia_refdata location.


Recommended Data

...

  • among others).

The Once untarred, the files will produce a directory tree of grp/hst/cdbs; the Pandeia Engine expects the environment variable redcat/trds. The pandeia.engine uses the contents of the trds directory.

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

Installation

We recommend using the Anaconda python distribution.

trds directory (NOT grp)

Verify Installation

Open up Once installed, from a terminal with access to the conda environmentinstallation, and 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 "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`

Code Block
languagebash
python -c "import pandeia.engine; pandeia.engine.pandeia_version()"

If properly installed and configured, it should show the refdata version and synphot data directory, like this:

Code Block
Pandeia Engine version:  3.2
Pandeia RefData version:  3.2
Pysynphot Data:  /your/data/directory/synphot

or for Roman:

Code Block
Pandeia Engine version:  3.1
Pandeia RefData version:  3.1
Pysynphot Data:  /your/data/directory/synphot

Helper Script

The following script (which can also be added to your .bashrc or .bash_profile file) assumes you are operating in a BASH shell where a python installation has been installed and activated, that you've installed the pandeia refdata in ${HOME}/data/pandeia, and the cdbs folder from the additional dataset moved and renamed to ${HOME}/data/synphot

Code Block
languagebash
titleInstallation script
linenumberstrue
#!/bin/sh
export PYSYN_CDBS=${HOME}/data/synphot
export pandeia_refdata=${HOME}/data/pandeia

Once in place, "source"ing this file will set up the pandeia environmentIt should also be possible to install the Pandeia Engine by simply running `pip install pandeia.engine==1.5.1` but this is not recommended and users are likely to run into more issues we cannot solve if installed this way.