spohnbook 0.0.1__tar.gz

spohnbook-0.0.1/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,50 @@
+name: Publish to PyPI
+
+on: push
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v6
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v7
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python distribution to PyPI
+    if: startsWith(github.ref, 'refs/tags/')
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/spohnbook
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v8
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

spohnbook-0.0.1/.github/workflows/release-please.yml

@@ -0,0 +1,23 @@
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+name: release-please
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v5
+        with:
+          # Personal access token stored as an action secret; the default
+          # GITHUB_TOKEN cannot be used because tags it pushes do not
+          # trigger the publish-to-pypi workflow.
+          token: ${{ secrets.MY_RELEASE_PLEASE_TOKEN }}
+          release-type: simple

spohnbook-0.0.1/.github/workflows/tests.yml

@@ -0,0 +1,116 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    # Weekly, so the compatibility job notices new dependency releases.
+    - cron: "0 6 * * 1"
+  workflow_dispatch:
+
+jobs:
+  locked:
+    name: Locked build (requirements-docs.txt)
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+
+    - name: Install the locked environment
+      run: |
+        uv venv .venv --python 3.12
+        uv pip sync --python .venv/bin/python requirements-docs.txt
+        uv pip install --python .venv/bin/python --no-deps -e .
+        mkdir -p docs/_evidence
+
+    - name: Run tests and record the evidence ledger
+      run: >-
+        .venv/bin/python -m pytest tests -v --tb=short
+        --vv-evidence docs/_evidence/ledger.json 2>&1 | tee docs/_evidence/pytest.log
+
+    - name: Record the build manifest
+      if: always()
+      run: >-
+        .venv/bin/python tools/record_build.py --resolution locked
+        --ledger docs/_evidence/ledger.json --fetch-inputs
+        --output docs/_evidence/build-manifest.json
+        --command "pytest tests --vv-evidence; sphinx -W --keep-going -D nb_execution_mode=force"
+
+    - name: Build the documentation, executing every example
+      if: always()
+      run: >-
+        .venv/bin/python -m sphinx -W --keep-going -D nb_execution_mode=force
+        -b html docs docs/_build/html 2>&1 | tee docs/_evidence/sphinx.log
+
+    - name: Check that every published page and anchor still resolves
+      if: always()
+      run: >-
+        SPOHNBOOK_HTML_DIR=docs/_build/html
+        .venv/bin/python -m pytest tests/test_handbook.py -v -k rendered
+
+    - name: Upload the rendered site, logs, ledger, manifest and lock
+      if: always()
+      uses: actions/upload-artifact@v7
+      with:
+        name: locked-build
+        path: |
+          docs/_build/html
+          docs/_evidence
+          requirements-docs.txt
+
+  compatibility:
+    name: Compatibility build (latest PyPI releases)
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+
+    - name: Install the newest releases of every dependency
+      run: |
+        uv venv .venv --python 3.12
+        uv pip install --python .venv/bin/python -e ".[test,docs]"
+        mkdir -p docs/_evidence
+
+    - name: Run tests and record the evidence ledger
+      run: >-
+        .venv/bin/python -m pytest tests -v --tb=short
+        --vv-evidence docs/_evidence/ledger.json 2>&1 | tee docs/_evidence/pytest.log
+
+    - name: Record the build manifest, listing every difference from the lock
+      if: always()
+      run: >-
+        .venv/bin/python tools/record_build.py --resolution latest
+        --ledger docs/_evidence/ledger.json --fetch-inputs
+        --output docs/_evidence/build-manifest.json
+        --command "pytest tests --vv-evidence; sphinx -W --keep-going -D nb_execution_mode=force"
+
+    - name: Build the documentation, executing every example
+      if: always()
+      run: >-
+        .venv/bin/python -m sphinx -W --keep-going -D nb_execution_mode=force
+        -b html docs docs/_build/html 2>&1 | tee docs/_evidence/sphinx.log
+
+    - name: Upload the rendered site, logs, ledger and manifest
+      if: always()
+      uses: actions/upload-artifact@v7
+      with:
+        name: compatibility-build
+        path: |
+          docs/_build/html
+          docs/_evidence

spohnbook-0.0.1/.gitignore

@@ -0,0 +1,229 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer,
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# hatch-vcs generated version file
+*_version.py
+
+# uv lockfile (not committed for this library; see comment above)
+uv.lock
+
+# Generated at documentation build time
+docs/_generated/
+docs/_evidence/
+dist-bundle/

spohnbook-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+  - repo: local
+    hooks:
+      - id: no-internal-refs
+        name: no internal research references
+        entry: python3 tools/check_internal_refs.py
+        language: system
+        types: [text]
+        exclude: ^(CHANGELOG\.md|tools/check_internal_refs\.py)$
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v6.0.0"
+    hooks:
+      - id: trailing-whitespace
+      - id: name-tests-test
+        args: [--pytest-test-first]
+      - id: end-of-file-fixer
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.2
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v4.3.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: []

spohnbook-0.0.1/.readthedocs.yaml

@@ -0,0 +1,25 @@
+# Required
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+  jobs:
+    # Record the evidence the rendered case states are computed from. A failing
+    # test is recorded in the ledger and shown on the evidence page, so it does
+    # not stop the site from building.
+    pre_build:
+      - mkdir -p docs/_evidence
+      - python -m pytest tests --vv-evidence docs/_evidence/ledger.json || echo "tests failed; the ledger records it"
+      - python tools/record_build.py --resolution locked --ledger docs/_evidence/ledger.json --fetch-inputs --output docs/_evidence/build-manifest.json --command "readthedocs pre_build" || echo "the manifest is incomplete"
+
+python:
+  install:
+    # Every edition builds with the dependency lock recorded at its tag.
+    - requirements: requirements-docs.txt
+    - method: pip
+      path: .
+
+sphinx:
+  configuration: docs/conf.py

spohnbook-0.0.1/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+## 0.0.1 (2026-09-24)
+
+
+### Features
+
+* **book:** add citation metadata, release policy and the bundle tool ([8c6f5a0](https://github.com/CoreySpohn/spohnbook/commit/8c6f5a06315f02c7364603b598fd18116e22a37f))
+* **book:** add the photon-to-electron reference case ([06a4bc7](https://github.com/CoreySpohn/spohnbook/commit/06a4bc7f22808e318aca8f61b6cb06a549570a2f))
+* **book:** add the scope, reading routes, contributing and citing pages ([98ce52e](https://github.com/CoreySpohn/spohnbook/commit/98ce52ecd83dd08e5358b889b8da110d83d3fb41))
+* **book:** add the source catalog, profiles and computed evidence ([4f0ede7](https://github.com/CoreySpohn/spohnbook/commit/4f0ede702428ab61fedf6e4fb1c41ba964495a54))
+* **book:** cite sources, move findings out and unify decision register ([0330fd1](https://github.com/CoreySpohn/spohnbook/commit/0330fd10b02f3a9dc9b329a57b8cd02bfb914136))
+* **book:** make the book citable, grounded and reproducible ([7e9ba00](https://github.com/CoreySpohn/spohnbook/commit/7e9ba000dfd860c7358a66f913458a1fc06b6c9e))
+* **book:** state each example's scope and evidence before its code ([9ea5f15](https://github.com/CoreySpohn/spohnbook/commit/9ea5f1513d85349d293806aa1ae2a7efd64b7efd))
+* **docs:** publish the conventions handbook as its first public edition ([3810018](https://github.com/CoreySpohn/spohnbook/commit/38100186e278f972725793f793d2ea2a463ee3df))
+* scaffold the spohnbook documentation umbrella with the library map and a first assembled example ([2fbde73](https://github.com/CoreySpohn/spohnbook/commit/2fbde735927ef03b74025c5a454cec088567c23e))
+
+
+### Bug Fixes
+
+* **book:** mark evidence stale across commits and record input bytes ([503bb16](https://github.com/CoreySpohn/spohnbook/commit/503bb16176fc58f23ab049aa070e0f4702b3e7e2))
+* **book:** repair the profile link in the reference case scope table ([8749324](https://github.com/CoreySpohn/spohnbook/commit/8749324c657c8abf1240c2de068f789780006339))
+* **docs:** use second-level headings in the generated map table ([89e593f](https://github.com/CoreySpohn/spohnbook/commit/89e593fb3420a4c4f9c0e9c8c4c94edb0a5d56e3))
+* **map:** align dependency lists with the computed registry ([5891eef](https://github.com/CoreySpohn/spohnbook/commit/5891eeff755eb93856be64c7bc2229abb9731910))
+
+
+### Miscellaneous Chores
+
+* release 0.0.1 ([96683fd](https://github.com/CoreySpohn/spohnbook/commit/96683fd5afc0840b63c1809e81202ebc15178d39))

spohnbook-0.0.1/CITATION.cff

@@ -0,0 +1,22 @@
+cff-version: 1.2.0
+message: >-
+  Cite the edition (version and tag) you used. A development build is not an
+  edition; cite its commit and state that it is a draft. No DOI has been minted.
+title: "The Spohn Book"
+abstract: >-
+  The map, shared conventions and assembled examples of a suite of JAX
+  libraries for exoplanet direct imaging. Draft editions: conventions marked
+  pending or proposed are not adopted.
+type: software
+authors:
+  - family-names: Spohn
+    given-names: Corey
+license: MIT
+repository-code: "https://github.com/CoreySpohn/spohnbook"
+url: "https://spohnbook.readthedocs.io"
+keywords:
+  - exoplanets
+  - direct imaging
+  - coronagraphy
+  - conventions
+  - Habitable Worlds Observatory

spohnbook-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+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.

spohnbook-0.0.1/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.5
+Name: spohnbook
+Version: 0.0.1
+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

spohnbook-0.0.1/README.md

@@ -0,0 +1,23 @@
+# 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