optixstuff 0.0.1__tar.gz

optixstuff-0.0.1/.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

optixstuff-0.0.1/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 0.0.1 (2026-04-13)
+
+
+### Features
+
+* implement wavelength-dependent throughput elements and YippyCoronagraph integration ([a273eac](https://github.com/CoreySpohn/optixstuff/commit/a273eac61a97bbff00aee9e147f9b2736ac5e71a))
+* initial package scaffold ([909ab74](https://github.com/CoreySpohn/optixstuff/commit/909ab747971deca8c62570620b693361f55d3419))
+
+
+### Miscellaneous Chores
+
+* release 0.0.1 ([610191e](https://github.com/CoreySpohn/optixstuff/commit/610191ec673ba90d8380aa60fa2a45592cc14334))

optixstuff-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.

optixstuff-0.0.1/PKG-INFO

@@ -0,0 +1,136 @@
+Metadata-Version: 2.4
+Name: optixstuff
+Version: 0.0.1
+Summary: Hardware abstractions for the HWO direct imaging simulation suite
+Project-URL: Homepage, https://github.com/CoreySpohn/optixstuff
+Project-URL: Issues, https://github.com/CoreySpohn/optixstuff/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 :: 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
+Requires-Dist: equinox>=0.12.0
+Requires-Dist: interpax
+Requires-Dist: jax>=0.4.1
+Requires-Dist: jaxlib>=0.4.1
+Requires-Dist: yippy
+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: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Description-Content-Type: text/markdown
+
+# optixstuff
+
+Flux-level optical system abstractions for the HWO direct imaging simulation suite.
+
+## What optixstuff is
+
+`optixstuff` is the **radiometric hardware layer** for HWO simulations. It operates on
+**flux** — photon rates, throughput fractions, and detector-level noise — providing the
+shared interfaces that simulation tools and exposure time calculators build on top of.
+
+The same `OpticalPath` object drives both scalar ETC calculations (`jaxEDITH`) and full
+2D image generation (`coronagraphoto`), ensuring that the hardware model is consistent
+across all downstream science products.
+
+## What optixstuff is *not*
+
+`optixstuff` does not model diffraction, wavefront propagation, or E-field interference.
+That level of physical optics belongs to tools like [dLux](https://github.com/LouisDesdoigts/dLux)
+and [HCIPy](https://github.com/ehpor/hcipy), which generate PSFs from first principles.
+
+`optixstuff` and these wavefront tools are **complementary**: dLux/HCIPy compute the PSFs,
+which are delivered as yield input packages (YIPs). `optixstuff` consumes those PSFs as
+flux patterns (via [yippy](https://github.com/CoreySpohn/yippy)) and composes them with
+the rest of the observatory — throughput chain, detector QE, noise — to produce
+science-level outputs.
+
+## Architecture
+
+Built on [JAX](https://github.com/google/jax) and
+[Equinox](https://github.com/patrick-kidger/equinox), `optixstuff` provides:
+
+- **Abstract interfaces** — `AbstractPrimary`, `AbstractOpticalElement`,
+  `AbstractCoronagraph`, `AbstractDetector`
+- **Concrete implementations** — `SimplePrimary`, `ConstantThroughputElement`,
+  `SimpleDetector`
+- **Container** — `OpticalPath`, a composable hardware configuration passed to all
+  simulators
+
+Every abstract method accepts three fidelity axes — **wavelength**, **position**, and
+**time** — with defaults so that simple implementations can ignore unused axes while
+future high-fidelity models (wavelength-dependent coatings, position-dependent vignetting,
+time-dependent detector degradation) can use them without breaking the interface.
+
+### Ecosystem position
+
+```
+                          ┌───────────────────────────┐
+                          │  Physical optics           │
+                          │  (dLux, HCIPy, PROPER)     │
+                          │  E-fields → PSFs           │
+                          └──────────┬────────────────┘
+                                     │ YIP
+                          ┌──────────▼────────────────┐
+                          │  yippy                     │
+                          │  PSF interpolation         │
+                          └──────────┬────────────────┘
+                                     │ flux patterns
+              ┌──────────────────────▼────────────────────────┐
+              │                  optixstuff                    │
+              │  Telescope • Coronagraph • Detector • OpticalPath │
+              │  Throughput chains • QE • Noise rates          │
+              └────────┬──────────────────────┬───────────────┘
+                       │                      │
+            ┌──────────▼──────────┐ ┌────────▼───────────────┐
+            │  jaxEDITH           │ │  coronagraphoto         │
+            │  Scalar count rates │ │  2D image simulation    │
+            │  Exposure times     │ │  Multi-epoch scenes     │
+            └─────────────────────┘ └────────────────────────┘
+```
+
+## Installation
+
+```bash
+pip install optixstuff
+```
+
+## Status
+
+This package is in early development (pre-v0.1.0).

optixstuff-0.0.1/README.md

@@ -0,0 +1,79 @@
+# optixstuff
+
+Flux-level optical system abstractions for the HWO direct imaging simulation suite.
+
+## What optixstuff is
+
+`optixstuff` is the **radiometric hardware layer** for HWO simulations. It operates on
+**flux** — photon rates, throughput fractions, and detector-level noise — providing the
+shared interfaces that simulation tools and exposure time calculators build on top of.
+
+The same `OpticalPath` object drives both scalar ETC calculations (`jaxEDITH`) and full
+2D image generation (`coronagraphoto`), ensuring that the hardware model is consistent
+across all downstream science products.
+
+## What optixstuff is *not*
+
+`optixstuff` does not model diffraction, wavefront propagation, or E-field interference.
+That level of physical optics belongs to tools like [dLux](https://github.com/LouisDesdoigts/dLux)
+and [HCIPy](https://github.com/ehpor/hcipy), which generate PSFs from first principles.
+
+`optixstuff` and these wavefront tools are **complementary**: dLux/HCIPy compute the PSFs,
+which are delivered as yield input packages (YIPs). `optixstuff` consumes those PSFs as
+flux patterns (via [yippy](https://github.com/CoreySpohn/yippy)) and composes them with
+the rest of the observatory — throughput chain, detector QE, noise — to produce
+science-level outputs.
+
+## Architecture
+
+Built on [JAX](https://github.com/google/jax) and
+[Equinox](https://github.com/patrick-kidger/equinox), `optixstuff` provides:
+
+- **Abstract interfaces** — `AbstractPrimary`, `AbstractOpticalElement`,
+  `AbstractCoronagraph`, `AbstractDetector`
+- **Concrete implementations** — `SimplePrimary`, `ConstantThroughputElement`,
+  `SimpleDetector`
+- **Container** — `OpticalPath`, a composable hardware configuration passed to all
+  simulators
+
+Every abstract method accepts three fidelity axes — **wavelength**, **position**, and
+**time** — with defaults so that simple implementations can ignore unused axes while
+future high-fidelity models (wavelength-dependent coatings, position-dependent vignetting,
+time-dependent detector degradation) can use them without breaking the interface.
+
+### Ecosystem position
+
+```
+                          ┌───────────────────────────┐
+                          │  Physical optics           │
+                          │  (dLux, HCIPy, PROPER)     │
+                          │  E-fields → PSFs           │
+                          └──────────┬────────────────┘
+                                     │ YIP
+                          ┌──────────▼────────────────┐
+                          │  yippy                     │
+                          │  PSF interpolation         │
+                          └──────────┬────────────────┘
+                                     │ flux patterns
+              ┌──────────────────────▼────────────────────────┐
+              │                  optixstuff                    │
+              │  Telescope • Coronagraph • Detector • OpticalPath │
+              │  Throughput chains • QE • Noise rates          │
+              └────────┬──────────────────────┬───────────────┘
+                       │                      │
+            ┌──────────▼──────────┐ ┌────────▼───────────────┐
+            │  jaxEDITH           │ │  coronagraphoto         │
+            │  Scalar count rates │ │  2D image simulation    │
+            │  Exposure times     │ │  Multi-epoch scenes     │
+            └─────────────────────┘ └────────────────────────┘
+```
+
+## Installation
+
+```bash
+pip install optixstuff
+```
+
+## Status
+
+This package is in early development (pre-v0.1.0).

optixstuff-0.0.1/pyproject.toml

@@ -0,0 +1,63 @@
+[build-system]
+requires = ['hatchling', "hatch-fancy-pypi-readme", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "optixstuff"
+description = "Hardware abstractions for the HWO direct imaging simulation suite"
+authors = [{ name = "Corey Spohn", email = "corey.a.spohn@nasa.gov" }]
+dynamic = ['readme', 'version']
+requires-python = ">=3.11"
+license = { file = "LICENSE" }
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Astronomy",
+]
+dependencies = ["equinox>=0.12.0", "interpax", "jax>=0.4.1", "jaxlib>=0.4.1", "yippy"]
+
+[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"]
+
+[project.urls]
+Homepage = "https://github.com/CoreySpohn/optixstuff"
+Issues = "https://github.com/CoreySpohn/optixstuff/issues"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/optixstuff/_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.ruff.lint.per-file-ignores]
+"tests/**" = ["D"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/optixstuff"]
+
+[tool.hatch.build.targets.sdist]
+exclude = ["/scripts", "/docs", "/tests", "/.github"]

optixstuff-0.0.1/src/optixstuff/__init__.py

@@ -0,0 +1,43 @@
+"""optixstuff -- Hardware abstractions for the HWO simulation suite."""
+
+from optixstuff._version import __version__
+from optixstuff.coronagraph import AbstractCoronagraph, AbstractScalarOnlyCoronagraph
+from optixstuff.detector import (
+    AbstractDetector,
+    Detector,
+    SimpleDetector,
+    simulate_cic,
+    simulate_dark_current,
+    simulate_read_noise,
+)
+from optixstuff.optical_elements import (
+    AbstractOpticalElement,
+    AbstractUniformElement,
+    ConstantThroughputElement,
+    LinearThroughputElement,
+    OpticalFilter,
+)
+from optixstuff.optical_path import OpticalPath
+from optixstuff.primary import AbstractPrimary, SimplePrimary
+from optixstuff.yippy_coronagraph import YippyCoronagraph
+
+__all__ = [
+    "AbstractCoronagraph",
+    "AbstractDetector",
+    "AbstractOpticalElement",
+    "AbstractPrimary",
+    "AbstractScalarOnlyCoronagraph",
+    "AbstractUniformElement",
+    "ConstantThroughputElement",
+    "Detector",
+    "LinearThroughputElement",
+    "OpticalFilter",
+    "OpticalPath",
+    "SimpleDetector",
+    "SimplePrimary",
+    "YippyCoronagraph",
+    "__version__",
+    "simulate_cic",
+    "simulate_dark_current",
+    "simulate_read_noise",
+]

optixstuff-0.0.1/src/optixstuff/_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.1'
+__version_tuple__ = version_tuple = (0, 0, 1)
+
+__commit_id__ = commit_id = None