zodi 0.1.0__tar.gz

zodi-0.1.0/.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/zodi
+    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

zodi-0.1.0/.github/workflows/release-please.yml

@@ -0,0 +1,22 @@
+on:
+  push:
+    branches:
+      - main
+
+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

zodi-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,45 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Test [${{ matrix.extras }}] py${{ matrix.python-version }} on ${{ matrix.platform }}
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+        platform: [ubuntu-latest, macos-latest]
+        extras: ["test", "test,jax"]
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v7
+      with:
+        enable-cache: true
+
+    - name: Create venv
+      run: uv venv .venv --python ${{ matrix.python-version }}
+
+    - name: Install package with test dependencies
+      run: uv pip install -e ".[${{ matrix.extras }}]"
+      env:
+        VIRTUAL_ENV: ${{ github.workspace }}/.venv
+
+    # The core leg is the product guarantee: numpy consumers never
+    # inherit jax through this package.
+    - name: Prove the core install carries no jax
+      if: matrix.extras == 'test'
+      run: .venv/bin/python -c "import importlib.util; assert importlib.util.find_spec('jax') is None"
+
+    - name: Diag imports
+      run: .venv/bin/python -c "import zodi; from zodi._interp import interp2d_bilinear_clamped; print('zodi import ok')"
+
+    - name: Run tests
+      run: .venv/bin/pytest tests/ -v --tb=short

zodi-0.1.0/.gitignore

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

zodi-0.1.0/.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: []

zodi-0.1.0/.readthedocs.yaml

@@ -0,0 +1,17 @@
+# Required
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+sphinx:
+  configuration: docs/conf.py

zodi-0.1.0/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.1.0 (2026-07-18)
+
+
+### Features
+
+* scaffold the library with array API dispatch, clamped interpolation, and a backend-parity suite ([b2cd5e7](https://github.com/CoreySpohn/zodi/commit/b2cd5e76a46904d931177a02ab290adbf8254231))
+* v0.1 core (Leinert zodi, exozodi chain + grey-scatterer flambda, units arbiter, cross-code validation, docs) ([31ffd72](https://github.com/CoreySpohn/zodi/commit/31ffd72039d12c04654f8f8c6dc0465faa421198))
+* wire release automation -- release-please, PyPI trusted publishing, hatch-vcs tag-driven versioning ([1b39f2c](https://github.com/CoreySpohn/zodi/commit/1b39f2cf3f3a5cc1eb3f0842f328019ecb36acf3))

zodi-0.1.0/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.

zodi-0.1.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: zodi
+Version: 0.1.0
+Summary: Zodiacal and exozodiacal light brightness conventions with a single-source numpy/JAX core
+Project-URL: Repository, https://github.com/CoreySpohn/zodi
+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.11
+Requires-Dist: array-api-compat>=1.9
+Requires-Dist: numpy
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: myst-nb; extra == 'docs'
+Requires-Dist: sphinx-autoapi; extra == 'docs'
+Requires-Dist: sphinx-book-theme; extra == 'docs'
+Provides-Extra: jax
+Requires-Dist: jax>=0.4.32; extra == 'jax'
+Requires-Dist: jaxlib>=0.4.32; extra == 'jax'
+Provides-Extra: test
+Requires-Dist: hypothesis; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/markdown
+
+# zodi
+
+Zodiacal and exozodiacal light brightness conventions for exoplanet imaging,
+from a single source that runs on numpy and JAX.
+
+Status: v0.1 core (pre-PyPI). The LBTI HOSTS population distributions land
+next.
+
+## What it owns
+
+- Local zodiacal light surface brightness: the Leinert et al. (1998)
+  Table 17 position dependence and Table 19 wavelength dependence, with the
+  interpolation, anchoring, and near-Sun conventions of the production
+  codes stated explicitly (`zodi.specific_intensity`, `zodi.zodi_flux_ratio`).
+- The exozodi chain of Stark et al. (2014) as implemented by EXOSIMS
+  (`zodi.exozodi_flux_ratio_v`, `zodi.jez0`, `zodi.scale_jez`), the three
+  published latitudinal models (`zodi.latitudinal_factor`), and the
+  grey-scatterer band correction in both production flavors: the
+  stellar-color scaling used by pyEDITH (`zodi.exozodi_flux_ratio_band`)
+  and the scattered-plus-thermal spectrum model used by EXOSIMS, with its
+  calibration as a closed-form least-squares fit
+  (`zodi.fit_grey_scatter_constants`).
+- Unit conversions between the dialects in common use: magnitudes per
+  square arcsecond, flux ratio per square arcsecond, spectral radiance,
+  photon rates, and MJy per steradian (`zodi.units`).
+
+Coming next: the LBTI HOSTS survey n-zodi population distributions as
+quantile functions (callers supply their own uniform draws).
+
+## Documentation and validation
+
+`docs/conventions.md` states every model, constant, and known cross-code
+difference with sources and measured deltas; `docs/validation.md` maps
+each claim to an executable check. Cross-validation scripts against
+EXOSIMS, skyscapes, and zodipy live in `scripts/` and are runnable by
+anyone with those packages installed. Current results: exact agreement
+with the EXOSIMS closed-form models and magnitude chain, float64
+round-off agreement with skyscapes, and 0.95-1.23 brightness ratios
+against the independent Kelsall model at 1.25 um.
+
+## Design
+
+One implementation serves both backends through the array API standard.
+Functions compute in the namespace of their array inputs (via
+`array-api-compat`), so numpy callers get numpy in and numpy out with no JAX
+anywhere in their dependency tree, while JAX callers get functions that jit,
+vmap, and differentiate natively. Hard dependencies are `numpy` and
+`array-api-compat` only; the `[jax]` extra exists so the test suite can run
+the JAX side. JAX users should enable float64:
+
+```python
+jax.config.update("jax_enable_x64", True)
+```
+
+Random sampling is deliberately absent from the library: distributions ship
+as quantile functions (inverse CDFs), and callers bring uniforms from their
+own generator, whether that is `numpy.random` or `jax.random`.
+
+## Not this library
+
+Structured circumstellar disks (rings, gaps, offsets) and scene rendering
+belong to scene simulators; solar-system ephemerides belong to the caller.
+For thermal-infrared zodiacal emission modeling, see
+[zodipy](https://github.com/Cosmoglobe/zodipy); this library covers the
+reflected-light brightness conventions used in exoplanet direct imaging.
+
+## Install
+
+PyPI release pending; for now:
+
+```
+pip install git+https://github.com/CoreySpohn/zodi.git
+```

zodi-0.1.0/README.md

@@ -0,0 +1,73 @@
+# zodi
+
+Zodiacal and exozodiacal light brightness conventions for exoplanet imaging,
+from a single source that runs on numpy and JAX.
+
+Status: v0.1 core (pre-PyPI). The LBTI HOSTS population distributions land
+next.
+
+## What it owns
+
+- Local zodiacal light surface brightness: the Leinert et al. (1998)
+  Table 17 position dependence and Table 19 wavelength dependence, with the
+  interpolation, anchoring, and near-Sun conventions of the production
+  codes stated explicitly (`zodi.specific_intensity`, `zodi.zodi_flux_ratio`).
+- The exozodi chain of Stark et al. (2014) as implemented by EXOSIMS
+  (`zodi.exozodi_flux_ratio_v`, `zodi.jez0`, `zodi.scale_jez`), the three
+  published latitudinal models (`zodi.latitudinal_factor`), and the
+  grey-scatterer band correction in both production flavors: the
+  stellar-color scaling used by pyEDITH (`zodi.exozodi_flux_ratio_band`)
+  and the scattered-plus-thermal spectrum model used by EXOSIMS, with its
+  calibration as a closed-form least-squares fit
+  (`zodi.fit_grey_scatter_constants`).
+- Unit conversions between the dialects in common use: magnitudes per
+  square arcsecond, flux ratio per square arcsecond, spectral radiance,
+  photon rates, and MJy per steradian (`zodi.units`).
+
+Coming next: the LBTI HOSTS survey n-zodi population distributions as
+quantile functions (callers supply their own uniform draws).
+
+## Documentation and validation
+
+`docs/conventions.md` states every model, constant, and known cross-code
+difference with sources and measured deltas; `docs/validation.md` maps
+each claim to an executable check. Cross-validation scripts against
+EXOSIMS, skyscapes, and zodipy live in `scripts/` and are runnable by
+anyone with those packages installed. Current results: exact agreement
+with the EXOSIMS closed-form models and magnitude chain, float64
+round-off agreement with skyscapes, and 0.95-1.23 brightness ratios
+against the independent Kelsall model at 1.25 um.
+
+## Design
+
+One implementation serves both backends through the array API standard.
+Functions compute in the namespace of their array inputs (via
+`array-api-compat`), so numpy callers get numpy in and numpy out with no JAX
+anywhere in their dependency tree, while JAX callers get functions that jit,
+vmap, and differentiate natively. Hard dependencies are `numpy` and
+`array-api-compat` only; the `[jax]` extra exists so the test suite can run
+the JAX side. JAX users should enable float64:
+
+```python
+jax.config.update("jax_enable_x64", True)
+```
+
+Random sampling is deliberately absent from the library: distributions ship
+as quantile functions (inverse CDFs), and callers bring uniforms from their
+own generator, whether that is `numpy.random` or `jax.random`.
+
+## Not this library
+
+Structured circumstellar disks (rings, gaps, offsets) and scene rendering
+belong to scene simulators; solar-system ephemerides belong to the caller.
+For thermal-infrared zodiacal emission modeling, see
+[zodipy](https://github.com/Cosmoglobe/zodipy); this library covers the
+reflected-light brightness conventions used in exoplanet direct imaging.
+
+## Install
+
+PyPI release pending; for now:
+
+```
+pip install git+https://github.com/CoreySpohn/zodi.git
+```

zodi-0.1.0/docs/conf.py

@@ -0,0 +1,28 @@
+"""Sphinx configuration."""
+
+from importlib.metadata import version as get_version
+
+project = "zodi"
+release = get_version("zodi")
+version = ".".join(release.split(".")[:2])
+
+extensions = [
+    "myst_nb",
+    "autoapi.extension",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.mathjax",
+]
+
+autoapi_dirs = ["../src"]
+autoapi_ignore = ["**/*version.py"]
+myst_enable_extensions = ["amsmath", "dollarmath"]
+
+html_theme = "sphinx_book_theme"
+html_context = {"default_mode": "dark"}
+source_suffix = {".rst": "restructuredtext", ".md": "myst-nb"}
+
+nb_execution_mode = "auto"
+nb_execution_timeout = 120
+nb_execution_raise_on_error = True