Skip to content

Commit

Permalink
Add CRDS setup to docs landing page
Browse files Browse the repository at this point in the history
  • Loading branch information
jdavies-st committed Jan 25, 2021
1 parent a2fc676 commit 4675c45
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ 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
Expand All @@ -42,8 +42,22 @@ In a bash-compatible shell:
conda activate <env_name>
pip install jwst

For more detailed instructions and alternate installation methods see
`our Github README <https://github.com/spacetelescope/jwst>`_.
For more detailed instructions and alternate installation methods see the
`Github README <https://github.com/spacetelescope/jwst>`_.


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


===========
Expand Down

0 comments on commit 4675c45

Please sign in to comment.