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.

Sign up for GitHub

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

Jump to bottom

Update installation instructions to show installation from github #656

Merged
merged 1 commit into from
Apr 14, 2021
Merged

Update installation instructions to show installation from github #656

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 21 additions & 0 deletions docs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,27 @@ These are: **jwst**, which is the JWST calibration pipeline software, and two pa
Install the Development Version
-------------------------------

For those wishing to use the most up-to-date version of Mirage, you can install directly from github. In general, the version in the master branch should work, although that is not guaranteed. By installing this version, you will have access to updates made since the latest release on Pypi.

The installation procedure is nearly identical to the case of installing from Pypi above. The only difference is that the install command points to github.

::

conda create -n mirage python=3.7 -y
conda activate mirage
pip install git+https://github.com/spacetelescope/mirage

.. tip::
Some of Mirage's dependencies rely on `Healpy <https://healpy.readthedocs.io/en/latest/>`_,. Healpy has released different wheels for different versions of Mac OSX. For example, healpy version 1.12.5
works for MacOSX 10.13 (High Sierra) and 1.14.0 works for MacOSX 10.15 (Catalina). If the version of healpy above does not work for your system, you may need to install a different version.

.. tip::
This method installs `webbpsf <https://webbpsf.readthedocs.io/en/latest/>`_ via pip. In this case, you must also `manually download the collection of webbpsf data files <https://webbpsf.readthedocs.io/en/latest/installation.html#installing-the-required-data-files>`_ If you install webbpsf via conda, the data files are downloaded and installed for you, however conda installation is currrently only supported for python 3.7 and below.


Installation for Developers
---------------------------

For those wishing to contribute to the code base, you can install Mirage by cloning and installing the repository. This is only
recommended for those looking to help with development. In general, those wishing only to use Mirage should install the latest stable version from :ref:`Pypi <pypi>`.

Expand Down
2 changes: 1 addition & 1 deletion environment_python_3.7.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ dependencies:
- jwxml==0.3.2
- lxml==4.6.2
- matplotlib==3.3.4
- nircam_gsim==1.5
- nircam_gsim==1.56
- numpy==1.20.1
- photutils==1.0.2
- pysiaf==0.10.0
Expand Down
2 changes: 1 addition & 1 deletion environment_python_3.8.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ dependencies:
- jwxml==0.3.2
- lxml==4.6.2
- matplotlib==3.3.4
- nircam_gsim==1.5
- nircam_gsim==1.56
- numpy==1.20.1
- photutils==1.0.2
- pysiaf==0.10.0
Expand Down
2 changes: 1 addition & 1 deletion environment_python_3.9.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ dependencies:
- jwxml==0.3.2
- lxml==4.6.2
- matplotlib==3.3.4
- nircam_gsim==1.5
- nircam_gsim==1.56
- numpy==1.20.1
- photutils==1.0.2
- pysiaf==0.10.0
Expand Down