Retrieve and plot JWST background information
Project description
jwst_backgrounds is a a simple program to predict the levels of background emission in JWST observations, for use in proposal planning.
It accesses a precompiled background cache prepared by Space Telescope Science Institute. The background cache is hosted by the Mikulski Archive for Space Telescopes (MAST), so you need internet access to run the tool with the remote cache. It is possible to download the full background cache to your local machine. Instructions for downloading the background cache can be found at http://archive.stsci.edu/archive_news/2017/08-Aug/index.html#article1
For a given target (RA, DEC), and wavelength, jwst_backgrounds does the following:
- Plot the spectrum of the background for that target on a given calendar day.
- Plot the total background for that target versus calendar day.
- Compute the number of days per year that the target is observable at low background, for a given wavelength and a selectable threshold.
- Save the retrieved background data to file.
This code was written by Jane Rigby (GSFC, Jane.Rigby@nasa.gov) and Klaus Pontoppidan (STScI, pontoppi@stsci.edu) The background cache was prepared by Wayne Kinzel at STScI, and is the same as used by the JWST Exposure Time Calculator.
This software is provided as-is, with no warranty.
INSTALLATION
Using pip:
pip install jwst_backgrounds
Note: healpy (version >= 1.10) is a required dependency, so if you don't have it pip will install it automatically.
Note: to upgrade the JBT with pip use pip install jwst_background --upgrade
Using Conda
First clone the repository
git clone git@github.com:spacetelescope/jwst_backgrounds.git
cd jwst_backgrounds
conda create --name <env> --file requirements.txt
where <env>
is the name of the environment you wish to create and requirements is the requirements.txt
in the package directory.
To activate your JBT enter the following command:
source activate <env>
Manually
Clone the repository from github and install using easy_install
.
git clone git@github.com:spacetelescope/jwst_backgrounds.git
cd jwst_backgrounds
easy_install .
RUNNING THE CODE:
python # Start python.
from jwst_backgrounds import jbt # Import the background module
Below is an example that plots a background curve for a given RA, DEC, wavelength, threshold
jbt.get_background(261.6833333, -73.33222222, 2.15, thresh=1.1, \
plot_background=True, plot_bathtub=True, write_bathtub=True)
Contributing
jwst_backgrounds
follows the STScI "forking workflow".
TROUBLESHOOTING:
If matplotlib does not display the images, then try editing your ~/.matplotlib/matplotlibrc file, and choosing a different backend:
backend: MacOSX
backend: TkAgg
backend: GTKCairo
Citation
This code was written by Jane Rigby (GSFC, Jane.Rigby@nasa.gov) and Klaus Pontoppidan (STScI, pontoppi@stsci.edu) The background cache was prepared by Wayne Kinzel at STScI, and is the same as used by the JWST Exposure Time Calculator.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file jwst_backgrounds-1.3.0.tar.gz
.
File metadata
- Download URL: jwst_backgrounds-1.3.0.tar.gz
- Upload date:
- Size: 122.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17ac1e2b9f4a2ecea56ba328542044029675bfbd90f3668b156f1384be51a192 |
|
MD5 | 4529a7da60bde1d701b34c06c787c907 |
|
BLAKE2b-256 | f18c5a3e809cb30486e92edc884be600443f63aef724da4de16211635460f47a |
File details
Details for the file jwst_backgrounds-1.3.0-py3-none-any.whl
.
File metadata
- Download URL: jwst_backgrounds-1.3.0-py3-none-any.whl
- Upload date:
- Size: 125.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d8a7551a931b7f41df602216f4b171cbab71716bb6c2e712a9f0cfd96059dec |
|
MD5 | f28748a60d540eb7ba097271d050ee48 |
|
BLAKE2b-256 | 86c051155f61078cff7da4baa0c67c8ba33263b116d4707b957c86bce0b4eea1 |