Metadata-Version: 2.4
Name: jwst-camino
Version: 0.0.3
Summary: CAMINO is a Python package for modelling and inferring wavefront aberrations from JWST/NIRCam observations.
Author: rayshrish
License: BSD-3-Clause
Keywords: python,jax,autodiff,optics,wavefront,jwst,nircam,camino
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.24
Requires-Dist: scipy>=1.10
Requires-Dist: astropy>=5.0
Requires-Dist: jax>=0.4
Requires-Dist: pandas>=1.5
Requires-Dist: equinox>=0.10
Requires-Dist: zodiax>=0.5
Requires-Dist: dLux>=0.15
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: zensical; extra == "dev"
Requires-Dist: mkdocstrings-python; extra == "dev"
Requires-Dist: nbconvert; extra == "dev"
Requires-Dist: jupyter; extra == "dev"
Dynamic: license-file

# camino
[![PyPI version](https://badge.fury.io/py/jwst-camino.svg)](https://badge.fury.io/py/jwst-camino)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Docs](https://img.shields.io/badge/docs-Zensical-blue)](https://rayshrish.github.io/camino/)
[![CI](https://github.com/rayshrish/camino/actions/workflows/documentation.yml/badge.svg)](https://github.com/rayshrish/camino/actions/workflows/documentation.yml)

CAMINO is a JAX-based package for modelling and inferring wavefront aberrations and JWST/NIRCam PSF behaviour.

Contributors: [Shrishmoy Ray](https://github.com/rayshrish), [Benjamin Pope](https://github.com/benjaminpope)

## What is camino?

camino is a Python package for modelling optical propagation, wavefront aberrations, and JWST/NIRCam-style inference workflows using JAX autodiff and dLux optics primitives.

## Installation

The package is currently being prepared for publication under the distribution name `jwst-camino`, while the import name remains `camino`.

```bash
pip install jwst-camino
```

You can also build from source:

```bash
git clone https://github.com/your-org/camino.git
cd camino
python -m pip install -e .
```

We recommend using a virtual environment to avoid dependency conflicts.

## Use & Documentation

The project documentation is being assembled in the `docs/` tree and includes placeholders for the landing page, concepts page, worked example, and API reference.

## Collaboration & Development

We welcome collaboration on the modelling, testing, and documentation work. If you want to contribute, please work from a branch and keep the code formatted with the configured pre-commit Black checks.
