Beginning with version 0.9.0, JWST requires Python 3.5 and above.
To install the latest released version of the library, we recommend using conda and the astroconda channel to install the software and using a conda environment for the installation:
conda create -n jwst --override-channels -c http://ssb.stsci.edu/astroconda-dev -c defaults python=3.6 jwst
source activate jwst
This will install the latest released version of the package, and within the
jwst environment, the pipeline can be run from the command line or imported
into python programs. In order to install a specific version, the exact
version can be supplied, e.g. jwst=0.9.2.
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/STScI-JWST/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
Documentation (built daily from master) is available here:
https://jwst-pipeline.readthedocs.io/en/latest/
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.
Unit tests can be run via pytest. We recommend using pytest-xdist so you can run them in parallel. Install pytest-xdist and run pytest in the top level of the repository
conda install pytest-xdist
pytest -n <cores>
where cores is the number of cores you'd like to use on your machine for the tests.
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 10am and 7pm local Baltimore time every day on jwcalibdev.
To run the regression tests on your local machine, rsync or scp the input and comparison data locally
rsync -av <username>@jwcalibdev:/data4/jwst_test_data /my/local/path/
set the environment variable TEST_BIGDATA to this location
export TEST_BIGDATA=/my/local/path/jwst_test_data/
and then run the tests in the repository
cd ~/path/to/jwst
pytest --bigdata .
| jwst tag | DMS build | Date | Notes |
|---|---|---|---|
| 0.9.2 | 03/28/2018 | DMS test, no delivery to I&T | |
| 0.9.1 | 02/16/2018 | DMS test, no delivery to I&T | |
| 0.9.0 | B7.1.2 | 12/22/2017 | DMS patch release to I&T 02/15/2018 |
| 0.8.0 | B7.1.1 | DMS patch release to I&T 01/17/2018 | |
| 0.8.0 | B7.1 | 11/14/2017 | Final, delivered to I&T 11/17/2017 |
| 0.7.0rc7 | B7.0 | 12/13/2016 | Final, delivered to I&T |