Simulation Tools Handbook Home
The Simulation Tools Handbook contains documentation for the tools and resources for planning observations and analyzing Roman Wide Field Instrument imaging data. These tools are maintained by the Roman Science Operations Center at STScI.
Simulation Tools Handbook Table of Contents
The Simulation Tools Handbook contains the following articles:
- What Roman Simulation Tool Should I Use?
- WebbPSF for Roman
- STIPS - Space Telescope Imaging Product Simulator
- Roman WFI Exposure Time Calculator
- Roman I-Sim - The Roman Image Simulator
- Simulation Development Utilities
- Future Development of Simulation Tools
The Simulation Tools Documentation Ecosystem
For most elements documented in the Simulation Tools Handbook there are three types of documentation:
The user guides presented here in this RDox Simulation Tools Handbook,
The Code Repository presented in GitHub, which also hosts example notebooks, and
The Developer Documentation in ReadTheDocs that is updated as code is updated.
Each of these forms of documentation provide insight into the functioning of the simulation tools. The user guides in this Simulation Tools Handbook are helpful for getting started with the tools and applying them to science projects, the code repositories are helpful for anyone who needs to view the code or basic examples, and the developer documentation has the most up-to-date explanation of installation instructions and specifics about all the available parameters and other code details.
The Table of the Status and Locations of Simulation Tools Documentation provides a succinct description of each tool and catalogs the various forms of documentation available for each.
Table of the Status and Locations of Simulation Tools Documentation
Simulation Tool | Tool Description | Roman User's Guide | Code Repository | Developer Documentation |
---|---|---|---|---|
WebbPSF | generates PSF from optical models | |||
STIPS | fast simulator of astronomical scenes for full frame Level 2 (L2) data products | |||
Roman I-Sim | image simulator of Level 1 (L1) and Level 2 (L2) data products | |||
Pandeia | exposure time calculator; high precision, small area astronomical scenes |
| ||
Simulation Development Utilities: | ||||
pysiaf | transformation tool between instrument, observatory, and sky coordinates | |||
synphot | synthetic photometry for input astronomical object |
Software Versions Used in this Documentation
- This documentation is written for WebbPSF version 2.0.
- This documentation is written for STIPS version 2.2.2 (released on December 16, 2024).
- This documentation is written for Pandeia version 2024.12 (released on December 11, 2024).
- This documentation is written for Roman I-Sim version 0.7.0 (released on December 6, 2024).
For additional questions not answered in this article, please contact the Roman Help Desk at STScI.