Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update RTD installation instructions #8200

Merged
merged 6 commits into from
Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ documentation
- Added additional information for the ``scale`` and ``snr`` parameters
in the ``outlier_detection`` step docs. [#8177]

- Updated installation instructions to include a warning that Python<=3.11
must be used. [#8200]

emicorr
-------

Expand Down
27 changes: 13 additions & 14 deletions docs/getting_started/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,16 +38,22 @@ shell.

.. warning::

Users on MacOS Mojave (10.14) should limit their environment python to 3.9 -
there is a package dependency which currently fails to build on Mojave with
The jwst package requires a C compiler for dependencies and is currently
limited to Python 3.9, 3.10, or 3.11. Until Python 3.12 is supported, fresh
conda environments will require setting the Python version to <=3.11.

.. warning::

Users on MacOS Mojave (10.14) should limit their environment to python 3.9 -
there is a package dependency that currently fails to build on Mojave with
python>=3.10.

Installing Latest Release
-------------------------

You can install the latest released version via `pip`. From a bash/zsh shell:

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

Expand All @@ -58,16 +64,9 @@ Installing Previous Releases

You can also install a specific version (from `jwst 0.17.0` onward):

| >> conda create -n <env_name> python
| >> conda create -n <env_name> python=3.11
| >> conda activate <env_name>
| >> pip install jwst==1.3.3

Installing specific versions before `jwst 0.17.0` need to be installed from Github:

| >> conda create -n <env_name> python
| >> conda activate <env_name>
| >> pip install git+https://github.com/spacetelescope/[email protected]

| >> pip install jwst==1.12.5

.. _installing_dev:

Expand All @@ -77,7 +76,7 @@ Installing the Development Version from Github
You can install the latest development version (not as well tested) from the
Github master branch:

| >> conda create -n <env_name> python
| >> conda create -n <env_name> python=3.11
| >> conda activate <env_name>
| >> pip install git+https://github.com/spacetelescope/jwst

Expand Down Expand Up @@ -114,4 +113,4 @@ for more information.


**For more install instructions, including how to install jwst for development**
**or how to install a DMS operational build, see** `the Github README <https://github.com/spacetelescope/jwst>`_.
**or how to install a DMS operational build, see** `the Github README <https://github.com/spacetelescope/jwst>`_.
4 changes: 2 additions & 2 deletions docs/getting_started/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ To create a conda environment specifically for the latest stable release of

::

conda create --name jwst_latest python=3.10
conda create --name jwst_latest python=3.11

This will create a new, (nearly) empty Python 3.10 environment in which you can
This will create a new, (nearly) empty Python 3.11 environment in which you can
install the `jwst` package.

**2. Install jwst from PyPi**
Expand Down