mirage

This code can be used to generate simulated NIRCam, NIRISS, or FGS data

https://github.com/spacetelescope/mirage

Science Score: 38.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
○
codemeta.json file
○
.zenodo.json file
○
DOI references
✓
Academic publication links
Links to: zenodo.org
✓
Committers with academic emails
16 of 29 committers (55.2%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.7%) to scientific vocabulary

Keywords

astronomy fgs nircam niriss simulator

Keywords from Contributors

source-detection photometry astropy-affiliated astropy dynamic calibration mesh graph-generation cryptocurrencies network-simulation

Last synced: 6 months ago · JSON representation ·

Repository

This code can be used to generate simulated NIRCam, NIRISS, or FGS data

Basic Info

Host: GitHub
Owner: spacetelescope
License: bsd-3-clause
Language: Python
Default Branch: master
Homepage: https://mirage-data-simulator.readthedocs.io/en/latest/
Size: 211 MB

Statistics

Stars: 43
Watchers: 9
Forks: 41
Open Issues: 121
Releases: 13

Topics

astronomy fgs nircam niriss simulator

Created over 8 years ago · Last pushed 9 months ago

Metadata Files

Readme Changelog License Code of conduct Citation

MIRaGe = Multi Instrument Ramp Generator

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

Bryan Hilbert @bhilbert4
Joe Filippazzo @hover2pi
Nor Pirzkal @NorPirzkal
Kevin Volk @KevinVolkSTScI
Shannon Osborne @shanosborne
Marshall Perrin @mperrin

Acknowledgments:

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

Owner

Name: Space Telescope Science Institute
Login: spacetelescope
Kind: organization
Email: help@stsci.edu
Location: Baltimore, MD

Website: http://www.stsci.edu
Repositories: 305
Profile: https://github.com/spacetelescope

STScI is operated by AURA for NASA

Citation (CITATION)

If you use `mirage` for work/research presented in a publication (whether directly,
or as a dependency to another package), we recommend and encourage the following acknowledgment:

  This research made use of the open source Python package mirage, the JWST Multi Instrument Ramp
  Generator (Hilbert et al, 2019).

where (Hilbert et al, 2019) is a citation of the Zenodo record, e.g.:

@software{bryan_hilbert_2019_3519262,
  author       = {Bryan Hilbert and
                  Johannes Sahlmann and
                  Kevin Volk and
                  Shannon Osborne and
                  dthatte and
                  Marshall Perrin and
                  Lauren Chambers and
                  Edward Slavich and
                  Jo Taylor and
                  Erik Tollerud and
                  P. L. Lim},
  title        = {spacetelescope/mirage: First github release},
  month        = oct,
  year         = 2019,
  publisher    = {Zenodo},
  version      = {v1.1.1},
  doi          = {10.5281/zenodo.3519262},
  url          = {https://doi.org/10.5281/zenodo.3519262}
}

GitHub Events

Total

Watch event: 3
Issue comment event: 6
Pull request review event: 1
Gollum event: 1
Pull request event: 9
Create event: 3

Last Year

Watch event: 3
Issue comment event: 6
Pull request review event: 1
Gollum event: 1
Pull request event: 9
Create event: 3

Committers

Last synced: about 2 years ago

All Time

Total Commits: 1,586
Total Committers: 29
Avg Commits per committer: 54.69
Development Distribution Score (DDS): 0.301

Past Year

Commits: 9
Committers: 1
Avg Commits per committer: 9.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
Bryan Hilbert	h**t@s**u	1,109
Lauren Chambers	l**s@s**u	122
Johannes Sahlmann	j**n@s**u	111
Joe Filippazzo	j**o@s**u	79
Shannon Osborne	s**e@s**u	36
Marshall Perrin	m**n@s**u	31
Kevin Volk	3****I	28
Deepashri Thatte	t**e@s**u	14
Kevin Volk	v**k@s**u	9
Charles-Philippe Lajoie	l**e@i**u	6
dependabot[bot]	4****]	5
Zach Burnett	z**t@s**u	5
Ed Slavich	e**h@s**u	4
Charles-Philippe Lajoie	l**p@g**m	4
Takahiro Morishita	m**a@a**u	3
Charles-Philippe Lajoie	l**e@c**u	3
Erik Tollerud	e**d@g**m	2
Charles-Philippe Lajoie	l**e@i**l	2
Jo Taylor	j**r@s**u	2
Keira Brooks	k**s@s**u	2
Everett Schlawin	g**n@h**m	1
Nadia Dencheva	n**a@g**m	1
Chris Tava	c**a@g**m	1
Juan Luis Cano Rodríguez	j**u@r**g	1
Bryan Hilbert	h**t@g**m	1
dependabot-preview[bot]	2****]	1
Everett S	e**2@e**u	1
Yana Khusanova	5****h	1
Pey Lian Lim	2****m	1

Committer Domains (Top 20 + Academic)

stsci.edu: 12 email.arizona.edu: 1 readthedocs.org: 1 cosmonaut.local.stsci.edu: 1 astro.ucla.edu: 1 itsd-osx34.local.stsci.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 41
Total pull requests: 85
Average time to close issues: about 2 months
Average time to close pull requests: 2 months
Total issue authors: 17
Total pull request authors: 7
Average comments per issue: 2.71
Average comments per pull request: 1.55
Merged pull requests: 56
Bot issues: 0
Bot pull requests: 21

Past Year

Issues: 0
Pull requests: 16
Average time to close issues: N/A
Average time to close pull requests: 28 days
Issue authors: 0
Pull request authors: 3
Average comments per issue: 0
Average comments per pull request: 0.56
Merged pull requests: 5
Bot issues: 0
Bot pull requests: 2

View more stats

Top Authors

Issue Authors

bhilbert4 (17)
x12red (5)
christinawilliams (3)
hover2pi (2)
dthatte (1)
Mohammed-Sameed-Hussain (1)
tgrindlay (1)
zacharyburnett (1)
trevorfoote (1)
youngr1960 (1)
mtakahiro (1)
vandalt (1)
tomgreene (1)
eas342 (1)
Eobard828 (1)

Pull Request Authors

bhilbert4 (57)
dependabot[bot] (27)
pllim (4)
hover2pi (4)
zacharyburnett (1)
astrojuanlu (1)
ctava (1)

Top Labels

Issue Labels

Bug (2) Documentation (1) galaxy source (1) Enhancement (1) Medium Priority (1) SOSS (1) niriss (1) Non-sidereal targets (1) catalogs (1) seed image (1) AMI (1)

Pull Request Labels

dependencies (27) niriss (5) seed image (4) ghosts (3) Enhancement (2) SOSS (2) APT reader (2) python (2) github_actions (2) dark_prep (1) Non-sidereal targets (1) Documentation (1) WFSS (1)

Packages

Total packages: 1
Total downloads:
- pypi 207 last-month

Total dependent packages: 0
Total dependent repositories: 14
Total versions: 13
Total maintainers: 1

pypi.org: mirage

Create simulated JWST data

Homepage: https://github.com/spacetelescope/mirage
Documentation: https://mirage.readthedocs.io/
License: BSD License
Latest release: 2.4.0
published about 3 years ago

Versions: 13
Dependent Packages: 0
Dependent Repositories: 14
Downloads: 207 Last month

Rankings

Dependent repos count: 3.9%

Forks count: 6.2%

Average: 8.8%

Dependent packages count: 10.1%

Stargazers count: 10.5%

Downloads: 13.5%

Maintainers (1)

hilbert

Last synced: 7 months ago

Dependencies

requirements.txt pypi

asdf >=2.11.0
astropy >=5.0.4
astroquery >=0.4.6
batman-package >=2.4.8
bokeh >=2.2.3
crds >=11.12.0
grismconf >=1.32
h5py >=3.6.0
hotsoss >=0.1.7
ipython >=8.2.0
jupyter >=1.0.0
jwst >=1.4.4
jwst-backgrounds >=1.1.2
lxml >=4.8.0
matplotlib >=3.5.1
nircam_gsim >=1.60
numpy >=1.22.3
photutils >=1.4.0
pysiaf ==0.15.0
pytest >=7.1.1
pyyaml >=6.0
scipy >=1.8.0
sphinx >=4.5.0
synphot >=1.1.1
webbpsf >=1.0.0

setup.py pypi

asdf >=2.11.0
astropy >=5.0.4
astroquery >=0.4.6
batman-package *
bokeh >=2.2.3
crds >=11.12.0
grismconf *
gwcs >=0.18.1
h5py >=3.6.0
hotsoss ==0.1.7
ipython *
jinja2 ==3.1.2
jupyter *
jwst *
jwst-backgrounds >=1.1.2
lxml >=4.8.0
matplotlib >=3.5.1
nircam_gsim *
numpy *
photutils >=1.4.0
pysiaf ==0.15.0
pyyaml >=6.0
scipy >=1.8.0
synphot >=1.1.1
webbpsf >=1.0.0

.github/workflows/ci.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite

pyproject.toml pypi

mirage

Science Score: 38.0%

Keywords

Keywords from Contributors

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

MIRaGe = Multi Instrument Ramp Generator

Installation and Documentation

Examples

Citation

Contributing

Code of Conduct

Questions

Current Development Team

Acknowledgments:

Owner

Citation (CITATION)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: mirage

Rankings

Maintainers (1)

Dependencies