Metadata-Version: 2.4
Name: hwosim
Version: 0.0.1
Summary: A JAX-based toolkit for end-to-end HWO mission simulations, integrating yippy, orbix, coronagraphoto, and coronalyze.
Project-URL: Homepage, https://github.com/CoreySpohn/hwosim
Project-URL: Issues, https://github.com/CoreySpohn/hwosim/issues
Author-email: Corey Spohn <corey.a.spohn@nasa.gov>
License: MIT License
        
        Copyright (c) 2026 Corey Spohn
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.10
Requires-Dist: coronagraphoto
Requires-Dist: coronalyze
Requires-Dist: equinox
Requires-Dist: jax
Requires-Dist: jaxlib
Requires-Dist: orbix
Requires-Dist: yippy
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: docs
Requires-Dist: ipython; extra == 'docs'
Requires-Dist: matplotlib; extra == 'docs'
Requires-Dist: myst-nb; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-autoapi; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
Requires-Dist: sphinx-book-theme; extra == 'docs'
Provides-Extra: test
Requires-Dist: hypothesis; extra == 'test'
Requires-Dist: nox; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

<p align="center">
  <a href="https://pypi.org/project/hwosim/"><img src="https://img.shields.io/pypi/v/hwosim.svg?style=flat-square&logo=pypi" alt="PyPI"/></a>
  <a href="https://hwosim.readthedocs.io"><img src="https://readthedocs.org/projects/hwosim/badge/?version=latest&style=flat-square" alt="Documentation Status"/></a>
  <a href="https://github.com/CoreySpohn/hwosim/actions/workflows/tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/CoreySpohn/hwosim/tests.yml?branch=main&style=flat-square&logo=github&label=tests" alt="Tests"/></a>
  <a href="https://github.com/CoreySpohn/hwosim/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" alt="License"></a>
  <a href="https://github.com/CoreySpohn/hwosim"><img src="https://img.shields.io/badge/python-3.10%20|%203.11%20|%203.12-blue.svg?style=flat-square&logo=python" alt="Python Versions"></a>
</p>

---

# hwosim

**hwosim** is a JAX-based toolkit for running end-to-end Habitable Worlds Observatory (HWO) mission simulations. It ties together the full suite of HWO direct imaging simulation tools:

- **[yippy](https://github.com/CoreySpohn/yippy)** — Coronagraph performance modeling
- **[orbix](https://github.com/CoreySpohn/orbix)** — Orbital dynamics and target scheduling
- **[coronagraphoto](https://github.com/CoreySpohn/coronagraphoto)** — Image simulation for coronagraphic observations
- **[coronalyze](https://github.com/CoreySpohn/coronalyze)** — Post-processing and SNR analysis
- All the other ones I need to still write

## Key Features

*   **Mission Simulation**: End-to-end simulation pipelines from target selection through observation and analysis
*   **Yield Estimation**: Detection completeness and exoplanet yield calculations
*   **Integration Orchestration**: Unified interface across the HWO simulation suite
*   **JAX-Native**: Fully JIT-compilable, differentiable, and GPU-accelerated

## Installation

With [uv](https://docs.astral.sh/uv/) (recommended):

```bash
uv pip install hwosim
```

Or with pip:

```bash
pip install hwosim
```

*(Note: You may need to install JAX separately to match your specific hardware acceleration requirements.)*

## Quick Start

```python
import hwosim
```

## Documentation

Full documentation is available at [hwosim.readthedocs.io](https://hwosim.readthedocs.io).
