Metadata-Version: 2.5
Name: spohnbook
Version: 0.0.2
Summary: The map, shared conventions and assembled examples of a suite of JAX libraries for exoplanet direct imaging
Project-URL: Repository, https://github.com/CoreySpohn/spohnbook
Project-URL: Documentation, https://spohnbook.readthedocs.io
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 :: 2 - Pre-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.11
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Provides-Extra: docs
Requires-Dist: coronagraphoto; extra == 'docs'
Requires-Dist: coronalyze; extra == 'docs'
Requires-Dist: eyepiece; extra == 'docs'
Requires-Dist: hwostyle; extra == 'docs'
Requires-Dist: hwoutils; extra == 'docs'
Requires-Dist: jaxedith; extra == 'docs'
Requires-Dist: myst-nb; extra == 'docs'
Requires-Dist: optixstuff; extra == 'docs'
Requires-Dist: orbix; extra == 'docs'
Requires-Dist: photomancy; extra == 'docs'
Requires-Dist: physicaloptix; extra == 'docs'
Requires-Dist: pyyaml; extra == 'docs'
Requires-Dist: skyscapes; extra == 'docs'
Requires-Dist: sphinx-book-theme; extra == 'docs'
Requires-Dist: tiptilt; extra == 'docs'
Requires-Dist: yippy; extra == 'docs'
Provides-Extra: test
Requires-Dist: hwoutils; extra == 'test'
Requires-Dist: ineedvalidation; extra == 'test'
Requires-Dist: jax; extra == 'test'
Requires-Dist: numpy; extra == 'test'
Requires-Dist: optixstuff; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pyyaml; extra == 'test'
Description-Content-Type: text/markdown

# The Spohn Book

`spohnbook`: the map of a suite of JAX libraries for exoplanet direct imaging, the
scientific conventions they share, and examples assembled across them.

The libraries cover orbits, astrophysical scenes, optics and coronagraphs,
exposure times, image simulation, post-processing and detection, Bayesian
inference, observation planning and observing campaigns. Each one is developed
and released on its own. This repository is where they are laid out together:
which library owns what, the units, signs, frames, time scales and measurement
conventions every boundary between them must satisfy, and worked examples that
run through several of them at once.

Documentation: https://spohnbook.readthedocs.io

## Status

Pre-alpha. The documentation site is the product; the package on PyPI carries
no code.

## License

MIT
