Page History
| Table of Contents |
|---|
For Pandeia Engine
...
v3.
...
0/v3.1
...
| Table of Contents |
|---|
Code
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 | ||
|---|---|---|
| ||
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.
/v3.2
Python Requirements:
| Required | Recommended |
|---|---|
python 3.8+ | 3.11.3 |
numpy 1.17+ | 1.23.5 |
scipy | 1.10.1 |
astropy 5+ | 5.2.2 |
| photutils | 1.7.0 |
| synphot 1.0+ | 1.2.0 |
| stsynphot 1.0+ | 1.2.0 |
| six | 1.16.0 |
| setuptools | 67.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 with4. Then, install the engine itself:
| Code Block | ||
|---|---|---|
| ||
pip install pandeia.engine==1.5.1 |
...
3.2 |
or for Roman:
| Code Block | ||
|---|---|---|
| ||
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.
...
In order to function, the Pandeia Engine requires one * set of reference data (containing instrument definitions):
- James Webb Space Telescope: https://stsci.app.box.com/v/pandeia-refdata-v1p5p1v3p2-jwst
- Nancy Grace Roman Space Telescope: https://stsci.box.com/v/pandeia-refdata-v1p5p1v3p1-wfirstroman
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 file)
...
| Note | ||
|---|---|---|
| ||
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
- An additional dataset: httphttps://archive.stsci.edu/pub/hst/pysynphot/hlsp/reference-atlases can be used to provide more spectroscopic functionality (phoenix spectral models, normalization by HST bandpasses, normalizing in among others).
Once untarred, the files will produce a directory tree of grp/hstredcat/cdbstrds. The pandeia.engine uses the contents of the cdbs trds directory.
Environment variable: $PYSYN_CDBS must point to the cdbs trds directory (NOT grp)
Verify Installation
...
If properly installed and configured, it should show the refdata version and synphot data directory.
Requirements
...
python 2.7+
...
numpy 1.13.3+
...
scipy >1.4
...
astropy 2--3
...
, 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 |
| Warning |
pandeia.engine v1.5.1 is not compatible with scipy 1.4+ or astropy 4+ pandeia.engine v1.5.1 is the final version compatible with Python 2.7 |
Helper Script
The following script (which can also be added to your .bashrc or .bash_profile file) assumes you are operating in a terminal BASH shell where a conda 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/pysynphotsynphot
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
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/pysynphotsynphot 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 in place, "source"ing this file will set up the pandeia environmentOnce this is done, "conda activate pandeia" and "conda deactivate pandeia" should perform all of the setup required.
