README.md

WFC3 Notebooks

WFC3 Notebooks is the primary repository for analyzing data from the Wide Field Camera 3 on the Hubble Space Telescope. The Jupyter notebooks include tools for general data analysis, WFC3/IR time variable background (TVB), photometry, and point spread function (PSF) modeling. This repository contains the complementary notebooks mentioned in the WFC3 Data Handbook. These notebooks include:

General Tools:

• WFC3 Image Displayer and Analyzer
• Exception Report Checklist - WFC3
• Processing WFC3/UVIS Data with calwf3 Using the v1.0 CTE-Correction
• Masking Persistence in WFC3/IR Images

WFC3/IR Time Variable Background (TVB):

• WFC3/IR IMA Visualization Tools with an Example of Time Variable Background
• Manual Recalibration of Images using calwf3: Turning off the WFC3/IR Linear Ramp Fit
• Correcting for Helium Line Emission Background in WFC3/IR Exposures using the "Flatten-Ramp" Technique
• Correcting for Scattered Light in WFC3/IR Exposures: Manually Subtracting Bad Reads
• Correcting for Scattered Light in WFC3/IR Exposures: Using calwf3 to Mask Bad Reads

Photometry:

• WFC3/UVIS Filter Transformations with stsynphot
• Flux Unit Conversions with synphot and stsynphot
• Synthetic Photometry Examples for WFC3
• WFC3/UVIS Time-dependent Photometry
• Calculating WFC3 Zeropoints with stsynphot
• WFC3/UVIS Pixel Area Map Corrections for Subarrays

Point Spread Function (PSF):

• HST WFC3 Point Spread Function Modeling
• Downloading WFC3 and WFPC2 PSF Cutouts from MAST

See the WFC3 Instrument Handbook, WFC3 Data Handbook, wfc3tools, and WFC3 Software Tools for more information on instrumentation, data, calibration, and software.

Installation

It is recommended to clone the entire repository. To do so, run the following command in terminal:

git clone https://github.com/spacetelescope/hst_notebooks

stenv is the preferred base virtual environment for running WFC3 Noteboks since it contains libraries necessary for processing and analyzing data from the Hubble Space Telescope (HST) and the James Webb Space Telescope (JWST). To install, see stenv readthedocs or stenv GitHub.

In addition, each notebook contains a requirements.txt file that needs to be installed before running the notebooks. Some notebooks contain a pre-requirements.sh file, usually to install HSTCAL, which is the calibration software for HST. Here is a common set of commands to run before executing the notebooks (assuming your virtual environment is activated):

bash pre-requirements.sh
pip install -r requirements.txt
pip install notebook

With the environment activated and additional libraries installed based on the individual requirement files, you will be able to complete the notebooks.

Contributing

New contributions and feedback are very welcomed! Please open a new issue or new pull request for bugs, feedback, or new features you would like to see. If there is an issue you would like to work on, please leave a comment and we will be happy to assist. Questions can also be sent through the HST Help Desk.

WFC3 Notebooks follows the Astropy Code of Conduct and strives to provide a welcoming community to all of our users and contributors.

Want more information about how to make a contribution? Take a look at the the astropy contributing and developer documentation.

License

WFC3 Notebooks is licensed under a BSD 3-Clause License (see the LICENSE.txt file).