Installation
Installation methods
In order to have consistent, repeatable results across the Eureka!
user community, we recommend that all general users install
the most recent stable release of Eureka!
, v0.2. The following installation instructions are written with this in mind,
and the most recent stable release is also available as a zipped archive here.
Initial environment preparation
It is strongly recommended that you install Eureka!
in a new conda
environment as other packages you’ve previously
installed could have conflicting requirements with Eureka!
. You can install a lightweight version of conda at
this link. Once conda is installed, you can create a
new environment by doing:
conda create -n eureka python==3.9.7
conda activate eureka
a) With git
and pip
Once in your new conda environment, you can install Eureka!
directly from source on
GitHub using git
and pip
by running:
git clone -b v0.2 https://github.com/kevin218/Eureka.git
cd Eureka
pip install -e '.[jwst]'
To update your Eureka!
installation to the most recent version, you can do the following within that Eureka folder:
git pull
pip install --upgrade '.[jwst]'
b) With pip
only
Once in your new conda environment, you can install the Eureka!
package with pip
with the following command:
pip install -e git+https://github.com/kevin218/Eureka.git@v0.2#egg=eureka[jwst]
Other specific branches can be installed using:
pip install -e git+https://github.com/kevin218/Eureka.git@mybranchname#egg=eureka[jwst]
In order to use any of the demo ECF files, follow the instructions in the Demos section of the Quickstart page.
Installing with a conda
environment.yml file
You can also download Eureka!
using git
and set up a conda
environment directly from the git
repository if
you’d prefer not to use pip
to install dependencies. This can be done following:
git clone -b v0.2 https://github.com/kevin218/Eureka.git
cd Eureka
conda env create --file environment.yml --force
conda activate eureka
pip install --no-deps .
To update your Eureka!
installation to the most recent version, you can do the following within that Eureka folder:
git pull
conda env update --file environment.yml --prune
pip install --no-deps --upgrade .
CRDS Environment Variables
Eureka!
installs the JWST Calibration Pipeline as part of its requirements, and this also requires users to set the proper environment
variables so that it can download the proper reference files needed to run the pipeline. For users not on the internal STScI network,
two environment variables need to be set to enable this functionality. In your ~/.zshrc
(for Mac users) or ~/.bashrc
file (for bash
users), or other shell initialization file, add these two lines (specifying your desired location to cache the CRDS files,
e.g. /Users/your_name/crds_cache
for Mac users or /home/your_name/crds_cache
for Linux users):
export CRDS_PATH=/PATH/TO/FOLDER/crds_cache export CRDS_SERVER_URL=https://jwst-crds.stsci.edu
If these environment variables are not set, Stages 1-3 of the pipeline will fail.
Issues with installing the jwst dependency
If you have issues installing the jwst dependency, check out the debugging advice related to the jwst package on our FAQ page.