Metadata-Version: 2.1
Name: dorado-sensitivity
Version: 0.2.0
Summary: Dorado sensitivity and exposure time calculator
Home-page: https://github.com/nasa/dorado-sensitivity
License: NOSA
Author: Brad Cenko
Author-email: brad.cenko@nasa.gov
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Dist: pyyaml
Requires-Dist: synphot
Project-URL: Bug Tracker, https://github.com/nasa/dorado-sensitivity/issues
Project-URL: Change Log, https://github.com/nasa/dorado-sensitivity/blob/master/CHANGES.md
Project-URL: Repository, https://github.com/nasa/dorado-sensitivity
Description-Content-Type: text/markdown

# Dorado sensitivity and exposure time calculator

Dorado is a proposed space mission for ultraviolet follow-up of gravitational
wave events. This repository contains a simple sensitivity and exposure time
calculator for Dorado.

This package can estimate the signal to noise, exposure time, or limiting
magnitude for an astronomical source with a given spectrum using the [CCD
signal to noise equation]. It models the following noise contributions:

*   Zodiacal light
*   Airglow (geocoronal emission)
*   Standard CCD noise (shot noise, read noise, dark current)

## Installation

To install with [Pip]:

    $ pip install dorado-sensitivity

## Examples

For examples, see the [Jupyter notebook].

## Dependencies

*   [Astropy]
*   [Synphot] for combining bandpasses and source spectra
*   [PyYAML] for reading [ECSV] data files

[CCD signal to noise equation]: https://hst-docs.stsci.edu/stisihb/chapter-6-exposure-time-calculations/6-4-computing-exposure-times
[Pip]: https://pip.pypa.io
[Astropy]: https://www.astropy.org
[Synphot]: https://synphot.readthedocs.io/
[PyYAML]: https://pyyaml.org/
[ECSV]: https://github.com/astropy/astropy-APEs/blob/master/APE6.rst
[Jupyter notebook]: https://github.com/nasa/dorado-sensitivity/blob/master/example.ipynb

