Metadata-Version: 2.4
Name: nyx-astro
Version: 0.2.1
Summary: Differentiable Simulation of NSB in IACTs using JAX
Author-email: Gerrit Roellinghoff <gerrit.roellinghoff@fau.de>
Maintainer-email: Gerrit Roellinghoff <gerrit.roellinghoff@fau.de>
License-Expression: BSD-3-Clause AND LicenseRef-Nyx-Data
Project-URL: Homepage, https://github.com/GerritRo/nyx
Project-URL: Documentation, https://gerritro.github.io/nyx/
Project-URL: Repository, https://github.com/GerritRo/nyx.git
Project-URL: Issues, https://github.com/GerritRo/nyx/issues
Keywords: sky-brightness,atmosphere,astronomy,astrophysics,jax,differentiable,healpix,zodiacal-light,airglow
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: licenses/DATA.rst
License-File: licenses/README.rst
Requires-Dist: numpy>=2.0
Requires-Dist: scipy>=1.11
Requires-Dist: astropy>=6.0
Requires-Dist: healpy>=1.16
Requires-Dist: jax-healpy>=0.3
Requires-Dist: dust_extinction>=1.3
Requires-Dist: jax>=0.4.25
Requires-Dist: equinox>=0.11
Requires-Dist: optimistix>=0.0.7
Provides-Extra: gpu
Requires-Dist: jax[cuda12]; extra == "gpu"
Provides-Extra: iactrace
Requires-Dist: iactrace; extra == "iactrace"
Provides-Extra: numpyro
Requires-Dist: numpyro; extra == "numpyro"
Requires-Dist: corner; extra == "numpyro"
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: jupyter>=1.0; extra == "dev"
Requires-Dist: mypy>=1.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Requires-Dist: commitizen>=3.12.0; extra == "dev"
Requires-Dist: matplotlib; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: furo; extra == "docs"
Requires-Dist: sphinx-automodapi; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: myst-nb; extra == "docs"
Dynamic: license-file

# nyx

![Python](https://img.shields.io/badge/python-3.12-blue)
[![License](https://img.shields.io/badge/license-BSD--3--Clause-green)](LICENSE)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

**Differentiable Simulation of Night Sky Background in Imaging Atmospheric Cherenkov Telescopes**

nyx models the night sky background for IACT telescopes, enabling parameter estimation through HMC or gradient-based optimization.

## Features

- Fully differentiable computation for gradient-based optimization and Bayesian inference using JAX
- Zodiacal light, airglow, lunar brightness, and stellar catalogs are supported as emitters
- Effective aperture instrument models with spectral response

## Installation

```bash
pip install git+https://github.com/GerritRo/nyx/
```

For development:
```bash
git clone https://github.com/GerritRo/nyx.git
cd nyx
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
```

## Documentation

Full documentation and examples are available at: **https://gerritro.github.io/nyx/**

### Building Documentation Locally

```bash
pip install -e ".[docs]"
cd docs && make html
```

## License

BSD-3-Clause License - see [LICENSE](https://github.com/GerritRo/nyx/blob/main/LICENSE) for details.

## Citation

If you use nyx in your research, please cite this repository.

## Data Attribution

nyx bundles and downloads scientific datasets produced by third parties
(Pickles 1998, Leinert et al. 1998, the ROLO lunar model, ESO SkyCalc,
Gaia DR3, STScI CALSPEC, and the SVO Filter Profile Service). These datasets
carry their own citation and acknowledgement requirements. If you publish 
results obtained with nyx, cite the datasets you used as described in 
[licenses/DATA.rst](https://github.com/GerritRo/nyx/blob/main/licenses/DATA.rst).
