Beginning with version 0.9.0, JWST requires Python 3.5 or above.

To install a particular released version of the package, and all dependencies, we recommend using conda and a spec file that lists the exact versions of all packages to be installed. To create a new environment, use:

conda create -n jwst --file <URL>
source activate jwst

where <URL> is of the form:

Linux: http://ssb.stsci.edu/releases/jwstdp/0.12.2/latest-linux
OS X: http://ssb.stsci.edu/releases/jwstdp/0.12.2/latest-osx

Other particular versions can be installed by choosing a different version tag in place of "0.12.2" in the URL path. See the "Software vs DMS build version map" table below for a list of tags corresponding to particular releases.

To update to the latest nightly build:

conda update -n jwst --override-channels -c http://ssb.stsci.edu/astroconda-dev -c defaults --all

To install the development version of the repository, we recommend creating a new environment, using the astroconda channel to install the dependencies, and then installing from the github repository:

conda create -n jwst_dev --only-deps --override-channels -c http://ssb.stsci.edu/astroconda-dev -c defaults python=3.6 jwst
source activate jwst_dev
git clone https://github.com/spacetelescope/jwst.git
cd jwst
python setup.py develop

Once installed, the software can be updated to the lastest development version by updating the dependencies, pulling the latest version of master from the Github repository inside the jwst directory:

conda update -n jwst_dev --override-channels -c http://ssb.stsci.edu/astroconda-dev -c defaults --all
git pull origin master
python setup.py develop

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

Documentation (built daily from master) is available here:

https://jwst-pipeline.readthedocs.io/en/latest/

One can clone this repository and build the documentation with

pip install sphinx_rtd_theme stsci_rtd_theme sphinx_automodapi
python setup.py build_sphinx

We welcome contributions and feedback on the project. Please follow the contributing guidelines to submit an issue or a pull request.

We strive to provide a welcoming community to all of our users by abiding to the Code of Conduct.

If you have questions or concerns regarding the software, please open an issue at https://github.com/spacetelescope/jwst/issues or contact the JWST Help Desk.

Note: CRDS_CONTEXT values flagged with an asterisk in the above table are estimates (formal CONTEXT deliveries are only provided with final builds).

Unit tests can be run via pytest. All tests need a the ci_watson pytest plugin to run.

pip install requests_mock ci_watson
pytest jwst

Regression tests - both the data and the result reports - are currently only accessible to STScI staff members. If you do need information about this, please open an issue.

Latest regression test results can be found here:

https://boyle.stsci.edu:8081/job/RT/job/JWST/

The test builds start at 11am and 6pm local Baltimore time every day on jwcalibdev.

To run the regression tests on your local machine, you need the ci_watson pytest plugin as above. Then set the environment variable TEST_BIGDATA to our Artifactory server (STSci staff members only)

export TEST_BIGDATA=https://bytesalad.stsci.edu/artifactory/

When you run the tests, the results will get written somewhere in /tmp or /var by default. Control this with the --basetemp arg to pytest. So to run all the regression tests:

pytest --bigdata --basetemp=<PATH> jwst/tests_nightly/general

If you would like to run a specific test, find its name or ID and use the -k option:

pytest --bigdata --basetemp=<PATH> jwst/tests_nightly/general -k ami_pipeline

If developers need to update the truth files in our nightly regression tests, there are instructions in the repository wiki.

https://github.com/spacetelescope/jwst/wiki/Updating-nightly-RT