Skip to main content

Create simulated JWST data

Project description

MIRaGe = Multi Instrument Ramp Generator

Build Status License Python STScI DOI

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 is located on ReadTheDocs. Detailed installation instructions 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.

Contributing

Prior to contributing to the mirage development, please review our style guide.

Contibutors should use a "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. 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.

Current Development Team

Acknowledgments:

Mirage is based on a NIRISS data simulator originally written by Kevin Volk.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mirage-2.5.0.tar.gz (14.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mirage-2.5.0-py3-none-any.whl (8.7 MB view details)

Uploaded Python 3

File details

Details for the file mirage-2.5.0.tar.gz.

File metadata

  • Download URL: mirage-2.5.0.tar.gz
  • Upload date:
  • Size: 14.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mirage-2.5.0.tar.gz
Algorithm Hash digest
SHA256 a5972bb3037f1e514635cf1834b3d5a1a62e5f4d3a604e52b4f91e5e25de85ec
MD5 e8b1a7a8a7b5b0fc1972d535606f0853
BLAKE2b-256 162e010cdd66447221ef4f9d95b0d24e5bb0b339eabea4da2bdc01e45f24d65e

See more details on using hashes here.

Provenance

The following attestation bundles were made for mirage-2.5.0.tar.gz:

Publisher: build.yml on spacetelescope/mirage

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mirage-2.5.0-py3-none-any.whl.

File metadata

  • Download URL: mirage-2.5.0-py3-none-any.whl
  • Upload date:
  • Size: 8.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mirage-2.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1f31451d93b3b5a8d54708078009620c59b588424d0a323eb4f1cb665d0e6f1c
MD5 f0a3c88f322498807b06124910bd3a10
BLAKE2b-256 8ad001bb0b8e49b92b931763137c40b4bf21ed847d08d7e873ac480f76f50eb8

See more details on using hashes here.

Provenance

The following attestation bundles were made for mirage-2.5.0-py3-none-any.whl:

Publisher: build.yml on spacetelescope/mirage

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page