Metadata-Version: 2.4
Name: mirage
Version: 2.5.0
Summary: Create simulated JWST data
Author: Kevin Volk, Lauren Chambers, Johannes Sahlmann, Nor Pirzkal, Joe Filippazzo, Shannon Osborne, Marshall Perrin, Charles-Phillipe Lajoie, Mees Fix, Deepashri Thatte, Zachary Burnett, Pey-Lian Lim, Everett Schlawin, Jo Taylor, Erik Tollerud, Nadia Dencheva, Yanu Khusanova, Juan Luis Cano Rodriguez, Chris Tava
Author-email: Bryan Hilbert <hilbert@stsci.edu>
License-Expression: BSD-3-Clause
Keywords: astronomy,python
Classifier: Programming Language :: Python
Requires-Python: <3.14,>=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: asdf>=3.4.0
Requires-Dist: astropy>=6.1.3
Requires-Dist: astroquery>=0.4.7
Requires-Dist: bokeh>=3.5.2
Requires-Dist: crds>=11.18.4
Requires-Dist: grismconf
Requires-Dist: gwcs>=0.21.0
Requires-Dist: h5py>=3.11.0
Requires-Dist: hotsoss>=0.1.10
Requires-Dist: ipython
Requires-Dist: jupyter
Requires-Dist: jwst
Requires-Dist: jwst-backgrounds>=1.3.0
Requires-Dist: jwst_gtvt>=1.0.1
Requires-Dist: lxml>=5.3.0
Requires-Dist: matplotlib>=3.9.2
Requires-Dist: nircam_gsim>=1.71
Requires-Dist: numpy
Requires-Dist: photutils>=1.13.0
Requires-Dist: pysiaf>=0.24.1
Requires-Dist: scipy>=1.14.1
Requires-Dist: synphot>=1.4.0
Requires-Dist: stpsf>=2.2.0
Requires-Dist: pyyaml>=6.0.2
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Provides-Extra: docs
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-automodapi; extra == "docs"
Requires-Dist: sphinx_rtd_theme; extra == "docs"
Requires-Dist: stsci_rtd_theme; extra == "docs"
Requires-Dist: extension-helpers; extra == "docs"
Dynamic: license-file

# MIRaGe = Multi Instrument Ramp Generator

[![Build Status](https://github.com/spacetelescope/mirage/actions/workflows/build.yml/badge.svg)](https://github.com/spacetelescope/mirage/actions/workflows/build.yml)
[![License](https://img.shields.io/pypi/l/Django.svg)](https://github.com/spacetelescope/mirage/blob/master/LICENSE.txt)
[![Python](https://img.shields.io/badge/Python-3.12-blue.svg)](https://www.python.org/)
[![STScI](https://img.shields.io/badge/powered%20by-STScI-blue.svg?colorA=707170&colorB=3e8ddd&style=flat)](http://www.stsci.edu)
[![DOI](https://zenodo.org/badge/109982775.svg)](https://doi.org/10.5281/zenodo.3519261)


This repository contains code that can be used to generate
simulated NIRCam, NIRISS, or FGS data. These data can be in one
of two formats:

`raw` - No calibrations applied. Detector level effects such as non-linearity,
superbias, etc are still present.

`linearized` - Detector level effects have been removed, and data have been
linearized, but are still in ramp format, where multiple non-destructive
reads of the detector are present.

## Installation and Documentation

The [main documentation for Mirage](https://mirage-data-simulator.readthedocs.io/en/latest/) is located on ReadTheDocs.
[Detailed installation instructions](https://mirage-data-simulator.readthedocs.io/en/latest/install.html) can be found there.


## Examples

See the notebooks in the `examples` subdirectory. There are notebooks
for imaging simulations, WFSS simulations, moving target
(non-sidereal) simulations, and simulations of OTE commissioning.


### Citation
If you find this package useful, please consider citing the Zenodo record using the DOI badge above.
Please find additional citation instructions in [CITATION](CITATION).


## Contributing

Prior to contributing to the `mirage` development, please review our [style guide](https://github.com/spacetelescope/mirage/blob/master/style_guide/style_guide.md).

Contibutors should use a ["forking workflow"](https://github.com/spacetelescope/style-guides/blob/master/guides/git-workflow.md#the-forking-workflow-) when making contributions to the project.


## Code of Conduct

Users and contributors to the `mirage` repository should adhere to the [Code of Conduct](https://github.com/spacetelescope/mirage/blob/master/CODE_OF_CONDUCT.md).  Any issues or violations pertaining to the Code of Conduct should be brought to the attention of a `mirage` team member or to `conduct@stsci.edu`.


## Questions

For any questions about the `mirage` project or its software or documentation, please [open an Issue](https://github.com/spacetelescope/mirage/issues).


## Current Development Team
- Bryan Hilbert [@bhilbert4](https://github.com/bhilbert4)
- Joe Filippazzo [@hover2pi](https://github.com/hover2pi)
- Nor Pirzkal [@NorPirzkal](https://github.com/npirzkal)


## Acknowledgments:
`Mirage` is based on a NIRISS data simulator originally written by Kevin Volk.
