Logo FIREFLY

Installation

To install FIREFLY, you can clone the repository from GitHub using the following command in your terminal:

git clone https://github.com/Firefly-Collaboration/FIREFLY

Then, install the required Python dependencies:

pip install -r requirements.txt

After cloning, navigate into the cloned directory:

cd firefly
get FIREFLY on github

Dependencies

Python 3.6+ required

FIREFLY is no longer compatible with Python 2 and earlier versions. It requires Python version 3.6 or later. Ensure you have the correct version installed before proceeding with the installation.

FIREFLY also requires the following third-party Python packages:

Package Version Description
numpy2.2.2Core array math for spectra and model grids
scipy1.15.1Optimisation, stats, and interpolation used in fitting
pandas2.2.3Table handling for catalogs, metadata, and CSV I/O
astropy7.0.0Astronomy I/O (FITS), cosmology, coordinates, and units
matplotlib3.10.0Visualisations for spectra, comparisons, and QA plots
fitsio1.2.1Fast FITS file reading and writing
psutil5.9.8Resource monitoring for multiprocessing workflows
requests2.32.3HTTP downloads for remote DESI data
tqdm4.67.1Progress bars for long-running loops
desimodel0.19.3DESI instrument and targeting models (NERSC ONLY - using desi_envioment.sh)
desispec0.69.0DESI spectral I/O and processing utilities (NERSC ONLY - using desi_envioment.sh)
desitarget2.9.0DESI target selection masks and helpers (NERSC ONLY - using desi_envioment.sh)
sparcl1.2.0Client for remote SPARCL catalog access (API Documentation)