pyNRC Documentation

pyNRC - Python ETC and Simulator for JWST NIRCam

pyNRC is a set of Python-based tools for planning observations with JWST NIRCam. It includes an ETC, a simple image slope simulator, and an enhanced data simulator compatible with the JWST pipeline. This package works for a variety of NIRCam observing modes including direct imaging, coronagraphic imaging, slitless grism spectroscopy, and weak lens imaging. All PSFs are generated via WebbPSF and WebbPSF Extensions to reproduce realistic JWST images and spectra.

Developed by Jarron Leisenring and contributors at University of Arizona (2015 - 2024).

Getting Started

• Overview
  • A JWST NIRCam ETC and Simulator
  • Simulating PSFs

• Basic Installation
  • Requirements
  • Installing with pip
  • Installing with conda
  • Installing from source
  • Installing the data files
  • Testing
• Install with new Conda Environment
  • Configure Conda Channels
  • Installing stsynphot and synphot
  • Installing WebbPSF
  • Installing JWST Backgrounds
  • Installing Astroquery
  • Installing JWST Pipeline
  • Installing WebbPSF Extensions
  • Installing pyNRC
  • Environment Variables

User Guides

User Guides

• Basic Usage
  • Getting Started
  • First NIRCam Observation
  • 1. Saturation Limits
  • 2. Sensitivity Limits
  • 3. Ramp Optimization
• Ramp Optimization Examples
  • Example 1: M-Dwarf companion (imaging vs coronagraphy)
  • Example 2: Exoplanet Coronagraphy
  • Example 3: Single-Object Grism Spectroscopy
  • Example 4: Exoplanet Transit Spectroscopy
  • Example 5: Extended Souce
• Coronagraph Basics
  • Source Definitions
  • Initialize Observation
  • Exposure Settings
  • Add Planets
  • Estimated Performance
• Coronagraph Wedge Masks
  • Source Definitions
  • Initialize Observation
  • Exposure Settings
  • Add Planets
  • Estimated Performance
• DMS Level 1b Example
  • HR 8799 GTO 1194
  • APT Inputs
  • Source Definitions
  • Target Information
  • Create Observation Parameters
  • Perform simulations of observations

Reference Info

Reference Info

• Revision History
  • v1.3.1 (Sept 19, 2024)
  • v1.3.0 (Sept 19, 2024)
  • v1.2.2 (Sept 19, 2024)
  • v1.2.1 (May 24, 2024)
  • v1.2.0 (May 13, 2024)
  • v1.0.4 (Dec 28, 2021)
  • v1.0.3 (Dec 23, 2021)
  • v1.0.1 (Dec 14, 2021)
  • v1.0.0 (Nov 22, 2021)
  • v0.9.0beta (no release)
  • v0.8.0beta (no release)
  • v0.7.0 (Jun 2018)
  • v0.6.5 (Mar 2018)
  • v0.6.4 (Mar 2018)
  • v0.6.3 (Mar 2018)
  • v0.6.2 (Mar 2018)
  • v0.6.0 (Dec 2017)
  • v0.5.0 (Feb 2017)
  • v0.1.2 (Jan 2017)
  • v0.1.1 (Sep 2016)
  • v0.1.0 (Aug 2016)
  • Planned Updates
• License
• Contributing
  • Types of Contributions
  • Pull Request Guidelines
  • Tips
  • Deploying
• Detailed API
  • Detector Operations
  • Observation Classes
  • Simulations
  • Data Reduction
  • Utilities
  • WebbPSF Extensions

License & Attribution

pyNRC is free software made available under the MIT License. For details see LICENSE.

Citing pyNRC

If you make use of pyNRC in your work, please cite the following paper:

• Leisenring, J. (2024). pyNRC: Python ETC and Simulator for JWST NIRCam (Version v1.2.0) [Computer software]. https://doi.org/10.5281/zenodo.5829552

• BibTeX entry: @software{Leisenring_pyNRC_Python_ETC_2024, author = {Leisenring, Jarron}, doi = {10.5281/zenodo.5829552}, month = may, title = {{pyNRC: Python ETC and Simulator for JWST NIRCam}}, url = {https://github.com/JarronL/pynrc}, version = {v1.2.0}, year = {2024} }

Indices and Tables

• Index

• Module Index

• Search Page