Simulation Tools Handbook Home

The Simulation Tools Handbook contains documentation for the tools and resources for planning observations and analyzing WFI image data with the Nancy Grace Roman Space Telescope maintained by the Roman Science Operations Center at STScI.


This article contains:


Simulation Tools Handbook Table of Contents

The Simulation Tools Handbook contains the following articles:


The Simulation Tools Documentation Ecosystem

For most elements documented in the Simulation Tools Handbook there are three types of documentation:

  1. The User's Guide presented in the Simulation Tools Handbook,
  2. The Code Repository presented in Github, which also hosts example notebooks, and
  3. 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 Tool.  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 that exist for each tool.

Table of the Status and Locations of Simulation Tools Documentation

Simulation ToolTool Description

Roman User's Guide

Code RepositoryDeveloper Documentation

WebbPSF

generates PSF from optical models(tick) WebbPSF for Roman in RDox(tick) WebbPSF on Github(tick) WebbPSF on readthedocs

STIPS

fast simulator of astronomical scenes for full frame Level 2 (L2) data products(tick) STIPS in RDox(tick) STIPS on Github(tick) STIPS on readthedocs

RomanISim

data simulator of full frame Level 1 (L1) data products(error) Not yet released in RDox(tick) RomanISim on Github(tick) RomanISim on readthedocs

Pandeia

exposure time calculator;
high precision, small area astronomical scenes
(tick) Pandeia for Roman in RDox(error)(tick) Pandeia on STScI Outerspace

Simulation Development Utilities: 

pysiaf

transformation tool between instrument, observatory, and sky coordinates(tick) pySIAF for Roman in RDox(tick) pySIAF on GitHub

(tick)  pySIAF on readthedocs

synphot

synthetic photometry for input astronomical object(tick) stsynphot for Roman in RDox(tick)  stsynphot on GitHub (tick)  stsynphot on readthedocs

Software Versions Used in this Documentation

  • This documentation is written for  WebbPSF version 1.2.1 (released on August 11, 2023).
  • This documentation is written for STIPS version 2.1.0 (released on November 15, 2023).
  • This documentation is written for  Pandeia version 3.1 (released on December 11, 2023).

For additional questions not answered in this article, please contact the Roman Help Desk at STScI.



Latest Update

 

Updated to reflect additional documentation.
Publication

 

Initial publication of the article.