Installation

Step 1: Install HUSTLE-tools from GitHub

Currently HUSTLE-tools is only available to download or clone from GitHub. You can download HUSTLE-tools from GitHub or you can clone the repository:

git clone https://github.com/Exo-TiC/HUSTLE-tools

Then navigate into the top level of the newly-cloned repository and install:

cd HUSTLE-tools
pip install .

Alternatively, you can pip install a specific branch of HUSTLE-tools from Github using this syntax:

pip install git+https://github.com/Exo-TiC/HUSTLE-tools@branch-name

Step 2: Download supporting files for grismconf

HUSTLE-tools uses grismconf (hosted on GitHub at this link and developed by Pirzkal & Ryan 2017) to assign wavelength solutions to G280 exposures. To use grismconf you must download the associated WFC3/UVIS configuration files and supply the absolute path to either the UVIS_G280_CCD1_V2.conf file or UVIS_G280_CCD2_V2.conf file on your computer in the Stage 2 .hustle files, depending on which CCD chip your observation was collected on. Make sure to download these if you intend to run Stage 2!

Step 3 (optional): Download WFC3/UVIS sky background files

The WFC3/UVIS G280 has a unique background pattern owing in part to the amplifier split midway across the detector (see Pagul et al. 2023 for details). HUSTLE-tools uses the empirically-determined G280 sky image developed by Pagul et al. 2023 in a custom background correction routine contained in Step 5c of Stage 1. If you want to make use of this routine, simply head over to https://www.stsci.edu/hst/instrumentation/wfc3/documentation/grism-resources/uvis-grism-sky-images and download the latest sky image appropriate to the file type and chip used in your observations (typically type FLT, chip 2). Then supply the absolute path to this file on your computer in the Stage 1 .hustle file.