Index | Module Index

Installation

Stable releases of the jwst package are registered at PyPI. The latest released version can be installed into a fresh virtualenv or conda environment using pip:

pip install jwst

Installation details (via conda)

The jwst package should be installed into a virtualenv or conda environment via pip. We recommend that for each installation you start by creating a fresh environment that only has Python installed and then install the jwst package into that bare environment.

If using conda environments, first make sure you have a recent version of Anaconda or Miniconda installed.

Installation is generally a 3-step process:

• Create a conda environment

• Activate that environment

• Install the jwst package into that environment

In a bash-compatible shell:

conda create -n <env_name> python
conda activate <env_name>
pip install jwst

For more detailed instructions and alternate installation methods see the Github README.

Calibration References Data System (CRDS) Setup

CRDS is the system that manages the reference files needed to run the pipeline. Inside the STScI network, the pipeline works with default CRDS setup with no modifications. To run the pipeline outside the STScI network, CRDS must be configured by setting two environment variables:

export CRDS_PATH=$HOME/crds_cache
export CRDS_SERVER_URL=https://jwst-crds.stsci.edu

User Manual

• Introduction
• Reference Files
• CRDS
• Running From the Command Line
  • Exit Status
• Running From Within Python
• Input and Output File Conventions
  • Input Files
  • Output Files
• Universal Parameters
  • Output Directory
  • Output File
  • Override Reference File
  • Skip
  • Logging Configuration
• Parameter Files
• Available Pipelines
  • Pipeline/Step Suffix Definitions
• For More Information

Data products Documentation

• Data Products Information

Error Propagation Documentation

• Error Propagation

Package Documentation

• Package Index