Metadata-Version: 2.4
Name: exorad
Version: 2.2.0
Summary: The generic point source radiometric model
Author: E. Pascale
Author-email: "L. V. Mugnai" <lorenzo.mugnai@uniroma1.it>
License: BSD-3-Clause
Project-URL: Homepage, https://github.com/ExObsSim/ExoRad2-public
Project-URL: Repository, https://github.com/ExObsSim/ExoRad2-public
Project-URL: Documentation, https://exorad2-public.readthedocs.io/en/latest/
Keywords: exoplanets,radiometry,astronomy,simulation
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Software Development :: Libraries
Requires-Python: <3.15,>=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy>=7.0.0
Requires-Dist: matplotlib>=3.9.0
Requires-Dist: mpmath
Requires-Dist: numpy>=2.0.0
Requires-Dist: scipy>=1.9.3
Requires-Dist: h5py>=3.11
Requires-Dist: openpyxl>=3.0.0
Requires-Dist: requests
Requires-Dist: photutils>=2.2.0
Requires-Dist: pandas
Provides-Extra: dev
Requires-Dist: pytest>=8.4.1; extra == "dev"
Requires-Dist: pytest-cov>=7.0.0; extra == "dev"
Requires-Dist: ruff>=0.12.12; extra == "dev"
Requires-Dist: pre-commit>=4.0.1; extra == "dev"
Requires-Dist: nox>=2024.4.15; extra == "dev"
Requires-Dist: scriv>=1.5.0; extra == "dev"
Requires-Dist: build>=1.2.1; extra == "dev"
Requires-Dist: twine>=5.1.1; extra == "dev"
Requires-Dist: mypy>=1.11.2; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Requires-Dist: types-PyYAML; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=8.1.3; extra == "docs"
Requires-Dist: pydata-sphinx-theme>=0.16; extra == "docs"
Requires-Dist: sphinx-design>=0.6; extra == "docs"
Requires-Dist: sphinx-autoapi>=3.3; extra == "docs"
Requires-Dist: sphinx-autobuild>=2024.10; extra == "docs"
Requires-Dist: sphinxcontrib-jsmath; extra == "docs"
Requires-Dist: myst-parser>=4.0; extra == "docs"
Requires-Dist: matplotlib>=3.9.0; extra == "docs"
Dynamic: license-file

[![PyPI version](https://badge.fury.io/py/exorad.svg)](https://badge.fury.io/py/exorad)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/ExObsSim/Exorad2-public?color=gree&label=GitHub%20release)
[![Downloads](https://pepy.tech/badge/exorad)](https://pepy.tech/project/exorad)
[![Documentation Status](https://readthedocs.org/projects/exorad2-public/badge/?version=latest)](https://exorad2-public.readthedocs.io/en/latest/?badge=latest)
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
[![ASCL.net](https://img.shields.io/badge/ascl-2210.006-blue.svg?colorB=262255)](https://ascl.net/2210.006)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8367214.svg)](https://doi.org/10.5281/zenodo.8367214)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.05348/status.svg)](https://doi.org/10.21105/joss.05348)

# ExoRad 2.0: The generic point source radiometric model


ExoRad, the generic point source radiometric model, interfaces with any instrument to provide an estimate of several Payload performance metrics.

As an example, for each target and for each photometric and spectroscopic channel, ExoRad provides estimates of:

1) signals in pixels
2) saturation times
3) read noise
4) photon noise
5) dark current noise
6) zodiacal bkg
7) inner sanctum
8) sky foreground

### Cite
If you use this software please cite:
Mugnai et al., (2023). ExoRad 2.0: The generic point source radiometric model. Journal of Open Source Software, 8(89), 5348, ([doi: 10.21105/joss.05348](https://doi.org/10.21105/joss.05348))


## Installation
### Installing from PyPi
You can install it by doing

    pip install exorad

### Installing from source
ExoRad is compatible with Python 3.12, 3.13, and 3.14.
Clone the directory using:

    git clone https://github.com/ExObsSim/ExoRad2-public

Move into the `ExoRad2` folder and install with `pip`:

    pip install .

or with `uv` for faster resolution:

    uv sync

For development, install the optional `dev` dependencies (test and lint tools):

    pip install -e ".[dev]"


## Run
Once Exorad is installed in your system you can run it from console.
Run `exorad --help` to read the list of accepted keywords.

An example to ExoRad is provide in the `ExoRad2/examples` folder. From the `ExoRad2` directory you can try

    exorad -p examples/payload_example.xml -t examples/test_target.csv -o example_run/test.h5

The code output will appear in a directory called `example_run`

## Documentation
The full documentation is available [here](https://exorad2-public.readthedocs.io/en/latest/)

Or you can build the documentation yourself using `sphinx` . To install it run

    pip install sphinx sphinx_rtd_theme

From the `ExoRad2/docs` folder running

    cd docs
    make html

Then you will find the html version of the documentation in `ExoRad2/docs/build/html/index.html`.
