JWST tools

BREADS includes several tools for working with JWST data. These include tools for observation planning, for running pipeline reductions of JWST data prior to BREADS processing, and for analysing and plotting the resulting outputs.

This code is located within the breads.jwst_tools module and its submodules. This is all supporting code, not part of the “core” BREADS functionality.

Planning JWST observations: breads.jwst_tools.planning

For planning JWST IFU observations, the functions visualize_nrs_fov and visualize_miri_mrs_fov display the FOV of an observation of a star and companion to help planning special requirements for position angles and offstes. See this demo notebook

Reducing JWST data: breads.jwst_tools.reduction_utils

Functions in this module can be used to automate JWST pipeline reductions along with some custom steps and optimizations. See tutorial notebooks for JWST data analyses in this repo.

Plotting JWST data: breads.jwst_tools.plotting

This module contains some (simple!) functions for making nice plots of JWST 2D images, mostly to help display the status of data files during reductions.

breads.jwst_tools Package

Functions

`find_files_to_process`(input_dir[, filetype, ...])	Utility function to find files of a given type
`run_complete_stage1_2_clean_reduction`(input_dir)	Overarching top-level function to invoke stage1, stage2, and 1/f noise cleaning code
`run_noise_clean`(rate_files, stage2_dir, ...)	Invoke forward model noise removal for a list of rate files
`run_stage1`(uncal_files, output_dir[, ...])	Run pipeline stage 1, with some customizations for reductions intended to be used with breads for IFU high contrast
`run_stage2`(rate_files, output_dir[, ...])	Run pipeline stage 2, with some customizations for reductions intended to be used with breads for IFU high contrast
`visualize_miri_mrs_fov`(comp_name, comp_sep, ...)	Visualize MIRI MRS FOV for a companion
`visualize_nrs_fov`(comp_name, comp_sep, ...)	Visualize NIRSpec IFU or slit FOV for a companion