You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/install.rst
+18-25Lines changed: 18 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ a conda environment called "mirage" and then install the software into that envi
22
22
23
23
::
24
24
25
-
conda create -n mirage python=3.9 -y
25
+
conda create -n mirage python=3.12 -y
26
26
conda activate mirage
27
27
pip install mirage
28
28
@@ -90,43 +90,36 @@ Install via Environment File
90
90
91
91
The Mirage repository also contains environment files, which can be used to create an environment with proper versions of all of Mirage's dependencies. After cloning the Mirage repository, the environment file (located within the top-level directory) can be used via the following commands. The *name* keyword is used to specify that the name of the environment. You can name the environment anything you like.
92
92
93
-
Create a python 3.8 environment using the environment file, activate the environment, and install mirage::
93
+
Create a python 3.11 environment using the environment file, activate the environment, and install mirage::
94
94
95
95
cd mirage
96
-
conda env create -f environment_python_3.8.yml
97
-
conda activate mirage_py3.8
96
+
conda env create -f environment_python_3.11.yml
97
+
conda activate mirage_py3.11
98
98
pip install .
99
99
100
100
101
-
There is also an environment file that can be used to create python 3.9 environment::
101
+
There is also an environment file that can be used to create python 3.12 environment::
102
102
103
103
cd mirage
104
-
conda env create -f environment_python_3.9.yml
105
-
conda activate mirage_py3.9
104
+
conda env create -f environment_python_3.12.yml
105
+
conda activate mirage_py3.12
106
106
pip install .
107
107
108
108
109
+
.. _batman
109
110
110
-
.. tip::
111
-
For the python 3.8 and 3.9 cases most packages, including webbpsf, are installed via pip (astroconda does not yet support python 3.8 and beyond). In this case you must `manually download the collection of webbpsf data files <https://webbpsf.readthedocs.io/en/latest/installation.html#installing-the-required-data-files>`_.
112
-
113
-
114
-
.. _osx1014:
115
-
116
-
Troubleshooting for Mac OSX 10.14 installtion
117
-
---------------------------------------------
118
-
119
-
If you have installation errors on your machine running 10.14 (Mojave), try these solutions.
111
+
Batman versions
112
+
---------------
120
113
121
-
Synphot
122
-
+++++++
114
+
Intel-based Mac installation
115
+
++++++++++++++++++++++++++++
123
116
124
-
If the synphot package fails to build, try installing via conda using the conda-forge channel. Do this before installing Mirage, using the command:
117
+
As of Oct 2025, the most recent version of the Batman package is 2.5.3. However, this version does not have a wheel that works for Intel-based Macs. It is possible to revert back to version 2.5.2, however this version requires numpy < 2.0, which conflicts with several other dependencies, including the jwst pipeline. Therefore, for those on Intel-based Macs, we recommend omitting the Batman package when creating the environment.
125
118
126
-
- conda install synphot -c conda-forge
119
+
Build failure
120
+
+++++++++++++
127
121
128
-
Batman
129
-
++++++
122
+
This is an issue from previous versions of Mac OXS and may not longer be relevent. We keep it here just in case it is still an issue for anyone.
130
123
131
124
If the `Batman <https://github.com/lkreidberg/batman>`_ package fails to build, the work-around is more complex. Mirage uses the Batman package when simulating imaging and grism Time Series Observations (TSO).
132
125
@@ -140,8 +133,8 @@ The installation errors are related to supporting Batman's ability to run calcul
0 commit comments