Welcome to Eureka!
ALERT: Project Eureka! is currently under heavy development. Use at your own risk.
The simplest way to install the Eureka! package is with the following one-line command:
pip install git+git://github.com/kevin218/Eureka.gitwhere specific branches can be installed using:
pip install git+git://github.com/kevin218/Eureka.git@mybranchnameIf you desire any of the files in the demos folder, you will have to download these from GitHub following the method described below.
-
You can install Eureka! directly from source on GitHub in one of two ways:
-
On the GitHub website, click on Code and Download ZIP followed by unpacking the distribution by opening up a terminal and typing:
unzip Eureka-main.zip
-
OR, clone the repository using
gitby typing:git clone https://github.com/kevin218/Eureka.git
-
-
Navigate into the newly created directory and install Eureka! by running the following:
pip install . -
Set JWST CRDS environment variables. Eureka! installs the JWST Calibration Pipeline, and these variables need to be set for the calibration steps to properly run. The best practice for doing this is to add these two lines to your .bashrc (or equivalent shell startup script).
export CRDS_PATH=/PATH/TO/FOLDER/crds_cache export CRDS_SERVER_URL=https://jwst-crds.stsci.edu
Check out the docs at https://eurekadocs.readthedocs.io.