Metadata-Version: 2.4
Name: romanisim
Version: 0.13.1
Summary: Nancy Grace Roman Space Telescope WFI Simulator
Author: STScI
Project-URL: Tracker, https://github.com/spacetelescope/romanisim/issues
Project-URL: Documentation, https://romanisim.readthedocs.io/en/stable/
Project-URL: Source Code, https://github.com/spacetelescope/romanisim
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: asdf>=4.1.0
Requires-Dist: astropy>=6.0
Requires-Dist: astropy_healpix>=1.1.2
Requires-Dist: astroquery>=0.4.11
Requires-Dist: crds>=13.0.2
Requires-Dist: defusedxml>=0.5.0
Requires-Dist: galsim>=2.5.1
Requires-Dist: roman_datamodels>=0.29.0
Requires-Dist: gwcs>=0.25.0
Requires-Dist: numpy>1.26
Requires-Dist: photutils>=2.3.0
Provides-Extra: docs
Requires-Dist: sphinx<7; extra == "docs"
Requires-Dist: sphinx-automodapi; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Requires-Dist: stsci-rtd-theme; extra == "docs"
Requires-Dist: sphinx-astropy; extra == "docs"
Requires-Dist: sphinx-asdf>=0.1.1; extra == "docs"
Requires-Dist: tomli; python_version < "3.11" and extra == "docs"
Provides-Extra: test
Requires-Dist: ci-watson>=0.3.0; extra == "test"
Requires-Dist: pytest>=9.0; extra == "test"
Requires-Dist: pytest-openfiles>=0.5.0; extra == "test"
Requires-Dist: pytest-doctestplus>=0.10.0; extra == "test"
Requires-Dist: pytest-cov>=2.9.0; extra == "test"
Requires-Dist: stpsf>=2.1.0; extra == "test"
Dynamic: license-file

[![CI](https://github.com/spacetelescope/romanisim/actions/workflows/ci.yml/badge.svg)](https://github.com/spacetelescope/romanisim/actions/workflows/ci.yml) [![codecov](https://codecov.io/gh/spacetelescope/romanisim/branch/main/graph/badge.svg?token=pkoLtQOa2v)](https://codecov.io/gh/spacetelescope/romanisim)

# romanisim: an image simulator for Roman

romanisim is a Galsim-based simulator of imaging data from the Wide
Field Instrument (WFI) on the Nancy Grace Roman Space Telescope
(pronounced roman-eye-sim, stylized Roman I-Sim). It uses
[Galsim](https://galsim-developers.github.io/GalSim/_build/html/overview.html)
to render astronomical scenes,
[WebbPSF](https://galsim-developers.github.io/GalSim/_build/html/overview.html)
to model the point spread function, and
[CRDS](https://github.com/spacetelescope/crds) to access the
calibration information needed to produce realistic WFI images.

The simulator starts by producing an idealized scene with Galsim and a
PSF, and then proceeds to simulate the various noise sources and
instrumental systematics imprinted by the system. One major feature
is a fairly faithful implementation of up-the-ramp sampling and
ramp-fitting, so that romanisim can produce realistic L1 images ("raw" sets
of up the ramp samples like those that will be delivered from the telescope) and
L2 images (calibrated images of astronomical flux per pixel).

> **Warning**
> romanisim is under active developement. Its output has not been formally validated; only limited testing has been performed. For this reason, use of romanisim for preparation of ROSES proposals is not advised. Other packages like galsim's roman package or STIPS may better serve such purposes.

## Documentation

See the full romanisim [documentation](https://romanisim.readthedocs.org) at readthedocs.

## Installation

    pip install romanisim

should do most of what you want. Then

    romanisim-make-image out.asdf

will render a test image. See the
[documentation](https://romanisim.readthedocs.org) for more
information about simulating scenes you're actually interested in!

## Contributing

romanisim is intended to support the community in understanding and
analyzing imaging from Roman. If there are features you want to use or
see, file an
[issue](https://github.com/spacetelescope/romanisim/issues), or better
yet, make a pull request!
