jaxedith 0.0.2__tar.gz

jaxedith-0.0.2/.gitignore

@@ -0,0 +1,166 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+*_version.py
+.DS_Store
+input/
+output/
+scripts/
+*.png

jaxedith-0.0.2/.pre-commit-config.yaml

@@ -0,0 +1,20 @@
+repos:
+  - 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.8
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/compilerla/conventional-pre-commit
+    rev: v4.4.0
+    hooks:
+      - id: conventional-pre-commit
+        stages: [commit-msg]
+        args: []

jaxedith-0.0.2/.readthedocs.yaml

@@ -0,0 +1,20 @@
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        # Install with the [docs] flag for sphinx docs specific extensions
+        - docs
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py

jaxedith-0.0.2/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+## [0.0.2](https://github.com/CoreySpohn/jaxedith/compare/v0.0.1...v0.0.2) (2026-04-13)
+
+
+### Miscellaneous Chores
+
+* release 0.0.2 ([0403b67](https://github.com/CoreySpohn/jaxedith/commit/0403b67df165274c5a31468e4c8a113c49650adf))
+
+## 0.0.1 (2026-04-13)
+
+
+### Features
+
+* Add all things from the pyEDITH branch ([b0a0f5d](https://github.com/CoreySpohn/jaxEDITH/commit/b0a0f5d49ae77608d1d75abb16723a519e3b1ed7))
+
+
+### Miscellaneous Chores
+
+* release 0.0.1 ([164ba31](https://github.com/CoreySpohn/jaxEDITH/commit/164ba3136a758595a70fc4cf50fb93a9d801a3bb))

jaxedith-0.0.2/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.

jaxedith-0.0.2/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: jaxedith
+Version: 0.0.2
+Summary: JAX based HWO exposure time calculator
+Project-URL: Homepage, https://github.com/CoreySpohn/jaxedith
+Project-URL: Issues, https://github.com/CoreySpohn/jaxedith/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.11
+Requires-Dist: hwoutils
+Requires-Dist: jax>=0.8.1
+Requires-Dist: jaxlib>=0.8.1
+Requires-Dist: optixstuff
+Provides-Extra: dev
+Requires-Dist: pre-commit; 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: orbix; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Description-Content-Type: text/markdown
+
+# jaxedith
+JAX based HWO exposure time calculator. This library is set up to be a JAX based implementation of the [pyEDITH package](https://github.com/eleonoraalei/pyEDITH/).
+
+## Overview
+This package is currently in early development.

jaxedith-0.0.2/README.md

@@ -0,0 +1,5 @@
+# jaxedith
+JAX based HWO exposure time calculator. This library is set up to be a JAX based implementation of the [pyEDITH package](https://github.com/eleonoraalei/pyEDITH/).
+
+## Overview
+This package is currently in early development.

jaxedith-0.0.2/pyproject.toml

@@ -0,0 +1,59 @@
+[build-system]
+requires = ['hatchling', "hatch-fancy-pypi-readme", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "jaxedith"
+description = "JAX based HWO exposure time calculator"
+authors = [{ name = "Corey Spohn", email = "corey.a.spohn@nasa.gov" }]
+dynamic = ['readme', 'version']
+requires-python = ">=3.11"
+license = { file = "LICENSE" }
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Astronomy",
+]
+dependencies = ["hwoutils", "jax>=0.8.1", "jaxlib>=0.8.1", "optixstuff"]
+[project.optional-dependencies]
+dev = ["pre-commit"]
+docs = [
+    "sphinx",
+    "myst-nb",
+    "sphinx-book-theme",
+    "sphinx-autoapi",
+    "sphinx_autodoc_typehints",
+    "ipython",
+    "matplotlib",
+]
+test = ["nox", "pytest", "hypothesis", "pytest-cov", "orbix"]
+
+[project.urls]
+Homepage = "https://github.com/CoreySpohn/jaxedith"
+Issues = "https://github.com/CoreySpohn/jaxedith/issues"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/jaxedith/_version.py"
+
+[tool.hatch.metadata.hooks.fancy-pypi-readme]
+content-type = "text/markdown"
+
+[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]
+path = "README.md"
+
+[tool.ruff.lint]
+select = ["B", "D", "E", "F", "I", "UP", "RUF"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/jaxedith"]
+
+[tool.hatch.build.targets.sdist]
+exclude = ["/scripts", "/docs", "/tests", "/.github"]

jaxedith-0.0.2/src/jaxedith/__init__.py

@@ -0,0 +1,66 @@
+"""JAX ETC -- public API.
+
+This module provides the main user-facing functions for the JAX exposure time
+calculator. It bridges :mod:`optixstuff` hardware objects (stored as
+equinox modules) and astrophysical scene parameters to the pure-JAX count-rate
+and solver functions.
+
+Example:
+-------
+>>> from optixstuff import OpticalPath
+>>> from jaxedith import calc_exptime, CONFIG
+>>>
+>>> # Build optical_path from optixstuff objects
+>>> optical_path = OpticalPath(primary=..., coronagraph=..., detector=...)
+>>> scene = ETCScene(F0=..., Fs_over_F0=..., Fp_over_Fs=..., ...)
+>>>
+>>> t_exp = calc_exptime(optical_path, scene, config=CONFIG)
+"""
+
+try:
+    from ._version import __version__
+except ImportError:
+    __version__ = "unknown"
+
+# ── Re-exports ────────────────────────────────────────────────────────────────
+
+from .config import (
+    AYO_CONFIG,
+    CONFIG,
+    EXOSIMS_CHARACTERIZATION_CONFIG,
+    EXOSIMS_DETECTION_CONFIG,
+    ETCConfig,
+)
+from .core import (
+    calc_count_rates,
+    calc_exptime,
+    calc_exptime_spectrum,
+    calc_snr,
+)
+from .observation import (
+    calc_exptime_from_observation,
+    calc_exptime_from_system,
+    calc_snr_from_observation,
+    calc_snr_from_system,
+    observation_geometry,
+)
+from .scene import ETCScene
+
+__all__ = [
+    "AYO_CONFIG",
+    "CONFIG",
+    "EXOSIMS_CHARACTERIZATION_CONFIG",
+    "EXOSIMS_DETECTION_CONFIG",
+    "ETCConfig",
+    "ETCScene",
+    "__version__",
+    "calc_count_rates",
+    "calc_exptime",
+    "calc_exptime_from_observation",
+    "calc_exptime_from_system",
+    "calc_exptime_spectrum",
+    "calc_snr",
+    "calc_snr_from_observation",
+    "calc_snr_from_system",
+    "observation_geometry",
+]

jaxedith-0.0.2/src/jaxedith/_version.py

@@ -0,0 +1,24 @@
+# file generated by vcs-versioning
+# don't change, don't track in version control
+from __future__ import annotations
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+version: str
+__version__: str
+__version_tuple__: tuple[int | str, ...]
+version_tuple: tuple[int | str, ...]
+commit_id: str | None
+__commit_id__: str | None
+
+__version__ = version = '0.0.2'
+__version_tuple__ = version_tuple = (0, 0, 2)
+
+__commit_id__ = commit_id = None

jaxedith-0.0.2/src/jaxedith/config.py

@@ -0,0 +1,91 @@
+"""ETCConfig: equinox module that selects the ETC equation variant.
+
+The ``variant`` field is a plain Python string used for trace-time dispatch —
+it selects which solver function to call rather than branching inside a single
+function.  This means JIT compiles only the chosen code path and ``vmap``
+traces only one solver, avoiding dead-branch overhead.
+"""
+
+import equinox as eqx
+
+
+class ETCConfig(eqx.Module):
+    """Configuration that determines which ETC equation variant to use.
+
+    The ``variant`` field drives solver dispatch at trace time:
+
+    - ``"ayo"`` — AYO / Stark et al. equations (ADI background doubling,
+      data-driven noise floor).
+    - ``"jaxedith"`` — Same as AYO plus exozodi noise floor extension.
+    - ``"exosims_det"`` — EXOSIMS detection (no ADI factor, speckle residual).
+    - ``"exosims_char"`` — EXOSIMS characterization (Cp added to Cb).
+
+    All other fields are static parameters passed directly to the selected
+    solver — no boolean flags or ``jnp.where`` branching.
+
+    Attributes:
+        variant: Equation variant string (see above).
+        bg_multiplier: ADI background multiplier.  AYO/jaxedith: 2.0;
+            EXOSIMS: 1.0.
+        ppfact: Post-processing factor (EXOSIMS only).
+        stability_fact: Wavefront stability factor (EXOSIMS only).
+        overhead_multi: Multiplicative overhead factor.
+        overhead_fixed_s: Fixed overhead in seconds.
+        n_rolls: Number of telescope rolls.
+        include_exozodi_noise_floor: Whether the exozodi noise floor is
+            included (jaxedith extension).
+        npix_multiplier: Pixel count correction factor for the photometric
+            aperture.  ETC-specific, not a hardware property.
+    """
+
+    # --- Solver variant (trace-time dispatch) ---
+    variant: str = "jaxedith"
+
+    # --- Equation parameters ---
+    bg_multiplier: float = 2.0
+    ppfact: float = 1.0
+    stability_fact: float = 1.0
+
+    # --- Overheads ---
+    overhead_multi: float = 1.0
+    overhead_fixed_s: float = 0.0
+    n_rolls: int = 1
+
+    # --- Exozodi noise floor (jaxedith extension) ---
+    include_exozodi_noise_floor: bool = True
+
+    # --- Aperture correction ---
+    npix_multiplier: float = 1.0
+
+
+# ---------------------------------------------------------------------------
+# Presets
+# ---------------------------------------------------------------------------
+
+AYO_CONFIG = ETCConfig(
+    variant="ayo",
+    bg_multiplier=2.0,
+    include_exozodi_noise_floor=False,
+)
+"""AYO preset — original Stark et al. equations without exozodi noise floor."""
+
+CONFIG = ETCConfig(
+    variant="jaxedith",
+    bg_multiplier=2.0,
+    include_exozodi_noise_floor=True,
+)
+"""jaxedith preset — AYO equations plus exozodi noise floor."""
+
+EXOSIMS_DETECTION_CONFIG = ETCConfig(
+    variant="exosims_det",
+    bg_multiplier=1.0,
+    include_exozodi_noise_floor=False,
+)
+"""EXOSIMS detection preset — no ADI factor, speckle residual instead of noise floor."""
+
+EXOSIMS_CHARACTERIZATION_CONFIG = ETCConfig(
+    variant="exosims_char",
+    bg_multiplier=1.0,
+    include_exozodi_noise_floor=False,
+)
+"""EXOSIMS characterization preset — Cp added to Cb."""