physicaloptix 0.0.1__tar.gz

physicaloptix-0.0.1/.gitignore

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

physicaloptix-0.0.1/.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.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: []

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

physicaloptix-0.0.1/.zenodo.json

@@ -0,0 +1,28 @@
+{
+  "upload_type": "software",
+  "creators": [
+    {
+      "orcid": "0000-0002-3138-0240",
+      "affiliation": "NASA Goddard Space Flight Center, Greenbelt, MD",
+      "name": "Spohn, Corey"
+    }
+  ],
+  "license": "MIT",
+  "title": "physicaloptix",
+  "description": "physicaloptix is an open-source JAX library providing physical-optics PSF and diffraction modeling, built on dLux, for the Habitable Worlds Observatory direct imaging simulation suite.",
+  "keywords": [
+    "physical optics",
+    "point spread function",
+    "diffraction",
+    "Habitable Worlds Observatory",
+    "direct imaging",
+    "JAX"
+  ],
+  "related_identifiers": [
+    {
+      "identifier": "https://github.com/CoreySpohn/physicaloptix",
+      "relation": "isSupplementTo",
+      "scheme": "url"
+    }
+  ]
+}

physicaloptix-0.0.1/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## 0.0.1 (2026-06-27)
+
+
+### Features
+
+* Initial commit ([8ce773d](https://github.com/CoreySpohn/physicaloptix/commit/8ce773d3a96b000e1bbaf0525030c1a8801333c6))
+
+
+### Miscellaneous Chores
+
+* release 0.0.1 ([155d963](https://github.com/CoreySpohn/physicaloptix/commit/155d96329592b79d33db01981350de5023da7c07))
+
+## Changelog

physicaloptix-0.0.1/CITATION.cff

@@ -0,0 +1,12 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+type: software
+title: physicaloptix
+abstract: "physicaloptix is an open-source JAX library providing physical-optics PSF and diffraction modeling, built on dLux, for the Habitable Worlds Observatory direct imaging simulation suite."
+authors:
+  - family-names: Spohn
+    given-names: Corey
+    orcid: "https://orcid.org/0000-0002-3138-0240"
+    affiliation: "NASA Goddard Space Flight Center"
+repository-code: "https://github.com/CoreySpohn/physicaloptix"
+license: MIT

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

physicaloptix-0.0.1/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: physicaloptix
+Version: 0.0.1
+Summary: Physical optics (PSFs and diffraction) for the HWO direct imaging simulation suite
+Project-URL: Homepage, https://github.com/CoreySpohn/physicaloptix
+Project-URL: Issues, https://github.com/CoreySpohn/physicaloptix/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: dlux
+Requires-Dist: equinox>=0.12.0
+Requires-Dist: jax>=0.4.1
+Requires-Dist: jaxlib>=0.4.1
+Requires-Dist: numpy
+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'
+Requires-Dist: sphinxcontrib-mermaid; 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
+
+# physicaloptix
+
+Physical optics — PSFs and diffraction — for the HWO direct-imaging
+simulation suite.
+
+## What physicaloptix is
+
+`physicaloptix` turns an [optixstuff](https://github.com/CoreySpohn/optixstuff)
+hardware description into point-spread functions by wave-optics propagation,
+using [dLux](https://github.com/LouisDesdoigts/dLux) as the (hidden, swappable)
+backend. It is a downstream consumer of optixstuff — parallel to
+[coronagraphoto](https://github.com/CoreySpohn/coronagraphoto) (2D image
+simulation) and [jaxEDITH](https://github.com/CoreySpohn/jaxedith)
+(exposure-time and yield calculations) — so optixstuff itself stays free of
+diffraction code.
+
+The key piece is `DLuxCoronagraph`, which implements optixstuff's
+`AbstractCoronagraph`. Build one from an optixstuff primary and hand it to any
+downstream tool: it is consumed as an `AbstractCoronagraph`, so coronagraphoto
+and jaxEDITH get dLux-propagated PSFs by dependency injection, without depending
+on physicaloptix or dLux themselves.
+
+```python
+import physicaloptix as po
+
+coro = po.DLuxCoronagraph.from_primary(primary)      # optixstuff in, dLux hidden
+psf = coro.on_axis_psf(600.0, pixel_scale_rad, npix)  # PSF out
+```
+
+## What physicaloptix is *not*
+
+- **Not a hardware model.** The telescope / coronagraph / detector description
+  lives in [optixstuff](https://github.com/CoreySpohn/optixstuff); physicaloptix
+  consumes it.
+- **Not a PSF interpolator.** That's [yippy](https://github.com/CoreySpohn/yippy)'s
+  job (a sampled YIP table). physicaloptix is its functional sibling — live
+  propagation — and both back the same `AbstractCoronagraph` slot.
+- **Not a scene model.** Stars, planets, disks, and zodi live in
+  [skyscapes](https://github.com/CoreySpohn/skyscapes).
+
+## Architecture
+
+Built on [JAX](https://github.com/google/jax),
+[Equinox](https://github.com/patrick-kidger/equinox), and
+[dLux](https://github.com/LouisDesdoigts/dLux), `physicaloptix` provides:
+
+- **The optixstuff -> dLux adapter** — `to_dlux_aperture`, a `singledispatch`
+  that renders each optixstuff primary type into a dLux aperture (segmented hex
+  -> `MultiAperture`, simple circular -> `CircularAperture`).
+- **A dLux-backed coronagraph** — `DLuxCoronagraph`, an optixstuff
+  `AbstractCoronagraph` producing `on_axis_psf` / `off_axis_psf` by propagation.
+- **A facade** — `psf(primary, ...)`, a one-liner from primary to PSF.
+
+### Ecosystem position
+
+```mermaid
+flowchart TB
+    optix["<b>optixstuff</b><br/>Telescope · Coronagraph · Detector · OpticalPath"]
+    physopt["<b>physicaloptix</b><br/>dLux-backed PSFs / diffraction<br/>DLuxCoronagraph"]
+    yippy["<b>yippy</b><br/>Sampled-YIP PSF interpolation"]
+    corono["<b>coronagraphoto</b><br/>2D image simulation"]
+    jaxedith["<b>jaxEDITH</b><br/>Exposure-time / yield"]
+
+    optix --> physopt
+    optix --> yippy
+    physopt -- AbstractCoronagraph --> corono
+    physopt -- AbstractCoronagraph --> jaxedith
+    yippy -- AbstractCoronagraph --> corono
+```
+
+## Installation
+
+```bash
+pip install physicaloptix
+```
+
+## Status
+
+This package is in early development (pre-v0.1.0). No coronagraph mask
+(focal-plane / Lyot) is modelled yet, so `on_axis_psf` is currently the
+telescope PSF.

physicaloptix-0.0.1/README.md

@@ -0,0 +1,81 @@
+# physicaloptix
+
+Physical optics — PSFs and diffraction — for the HWO direct-imaging
+simulation suite.
+
+## What physicaloptix is
+
+`physicaloptix` turns an [optixstuff](https://github.com/CoreySpohn/optixstuff)
+hardware description into point-spread functions by wave-optics propagation,
+using [dLux](https://github.com/LouisDesdoigts/dLux) as the (hidden, swappable)
+backend. It is a downstream consumer of optixstuff — parallel to
+[coronagraphoto](https://github.com/CoreySpohn/coronagraphoto) (2D image
+simulation) and [jaxEDITH](https://github.com/CoreySpohn/jaxedith)
+(exposure-time and yield calculations) — so optixstuff itself stays free of
+diffraction code.
+
+The key piece is `DLuxCoronagraph`, which implements optixstuff's
+`AbstractCoronagraph`. Build one from an optixstuff primary and hand it to any
+downstream tool: it is consumed as an `AbstractCoronagraph`, so coronagraphoto
+and jaxEDITH get dLux-propagated PSFs by dependency injection, without depending
+on physicaloptix or dLux themselves.
+
+```python
+import physicaloptix as po
+
+coro = po.DLuxCoronagraph.from_primary(primary)      # optixstuff in, dLux hidden
+psf = coro.on_axis_psf(600.0, pixel_scale_rad, npix)  # PSF out
+```
+
+## What physicaloptix is *not*
+
+- **Not a hardware model.** The telescope / coronagraph / detector description
+  lives in [optixstuff](https://github.com/CoreySpohn/optixstuff); physicaloptix
+  consumes it.
+- **Not a PSF interpolator.** That's [yippy](https://github.com/CoreySpohn/yippy)'s
+  job (a sampled YIP table). physicaloptix is its functional sibling — live
+  propagation — and both back the same `AbstractCoronagraph` slot.
+- **Not a scene model.** Stars, planets, disks, and zodi live in
+  [skyscapes](https://github.com/CoreySpohn/skyscapes).
+
+## Architecture
+
+Built on [JAX](https://github.com/google/jax),
+[Equinox](https://github.com/patrick-kidger/equinox), and
+[dLux](https://github.com/LouisDesdoigts/dLux), `physicaloptix` provides:
+
+- **The optixstuff -> dLux adapter** — `to_dlux_aperture`, a `singledispatch`
+  that renders each optixstuff primary type into a dLux aperture (segmented hex
+  -> `MultiAperture`, simple circular -> `CircularAperture`).
+- **A dLux-backed coronagraph** — `DLuxCoronagraph`, an optixstuff
+  `AbstractCoronagraph` producing `on_axis_psf` / `off_axis_psf` by propagation.
+- **A facade** — `psf(primary, ...)`, a one-liner from primary to PSF.
+
+### Ecosystem position
+
+```mermaid
+flowchart TB
+    optix["<b>optixstuff</b><br/>Telescope · Coronagraph · Detector · OpticalPath"]
+    physopt["<b>physicaloptix</b><br/>dLux-backed PSFs / diffraction<br/>DLuxCoronagraph"]
+    yippy["<b>yippy</b><br/>Sampled-YIP PSF interpolation"]
+    corono["<b>coronagraphoto</b><br/>2D image simulation"]
+    jaxedith["<b>jaxEDITH</b><br/>Exposure-time / yield"]
+
+    optix --> physopt
+    optix --> yippy
+    physopt -- AbstractCoronagraph --> corono
+    physopt -- AbstractCoronagraph --> jaxedith
+    yippy -- AbstractCoronagraph --> corono
+```
+
+## Installation
+
+```bash
+pip install physicaloptix
+```
+
+## Status
+
+This package is in early development (pre-v0.1.0). No coronagraph mask
+(focal-plane / Lyot) is modelled yet, so `on_axis_psf` is currently the
+telescope PSF.

physicaloptix-0.0.1/pyproject.toml

@@ -0,0 +1,73 @@
+[build-system]
+requires = ['hatchling', "hatch-fancy-pypi-readme", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "physicaloptix"
+description = "Physical optics (PSFs and diffraction) 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",
+]
+# NOTE: requires the optixstuff release that adds SegmentedPrimary + spectral
+# detector QE (the local workspace optixstuff already has them).
+dependencies = [
+    "dLux",
+    "equinox>=0.12.0",
+    "jax>=0.4.1",
+    "jaxlib>=0.4.1",
+    "numpy",
+    "optixstuff",
+]
+
+[project.optional-dependencies]
+dev = ["pre-commit"]
+docs = [
+    "sphinx",
+    "myst-nb",
+    "sphinx-book-theme",
+    "sphinx-autoapi",
+    "sphinx_autodoc_typehints",
+    "sphinxcontrib-mermaid",
+    "ipython",
+    "matplotlib",
+]
+test = ["nox", "pytest", "hypothesis", "pytest-cov"]
+
+[project.urls]
+Homepage = "https://github.com/CoreySpohn/physicaloptix"
+Issues = "https://github.com/CoreySpohn/physicaloptix/issues"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/physicaloptix/_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/physicaloptix"]
+
+[tool.hatch.build.targets.sdist]
+exclude = ["/scripts", "/docs", "/tests", "/.github"]

physicaloptix-0.0.1/src/physicaloptix/__init__.py

@@ -0,0 +1,22 @@
+"""physicaloptix -- physical optics (PSFs and diffraction) for the HWO suite.
+
+A downstream consumer of optixstuff that produces PSFs via dLux, parallel to
+coronagraphoto (image sim) and jaxedith (ETC). optixstuff stays free of dLux and
+physical optics; diffraction lives here, with dLux as the (hidden, swappable)
+backend.
+
+``DLuxCoronagraph`` implements optixstuff's ``AbstractCoronagraph``, so
+coronagraphoto / jaxedith get dLux-propagated PSFs by dependency injection: build
+one from an optixstuff primary and hand it over, no dLux in sight.
+"""
+
+from physicaloptix._version import __version__
+from physicaloptix.apertures import to_dlux_aperture
+from physicaloptix.coronagraph import DLuxCoronagraph, psf
+
+__all__ = [
+    "DLuxCoronagraph",
+    "__version__",
+    "psf",
+    "to_dlux_aperture",
+]

physicaloptix-0.0.1/src/physicaloptix/_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

physicaloptix-0.0.1/src/physicaloptix/apertures.py

@@ -0,0 +1,51 @@
+"""Render optixstuff primaries into dLux apertures (the optixstuff -> dLux seam).
+
+This is where the (unavoidable) translation from an optixstuff hardware
+description to a dLux object lives -- once, dispatched by primary type, so callers
+work with optixstuff objects and never construct dLux apertures by hand.
+"""
+
+import functools
+
+import dLux as dl
+import numpy as np
+from optixstuff import SegmentedPrimary, SimplePrimary
+
+
+@functools.singledispatch
+def to_dlux_aperture(primary):
+    """Render an optixstuff primary into a dLux aperture layer.
+
+    Register a new primary type with ``@to_dlux_aperture.register`` rather than
+    branching here -- O(primary types), not a growing if/elif.
+
+    Args:
+        primary: An :class:`optixstuff.AbstractPrimary` concrete instance.
+
+    Returns:
+        A dLux aperture layer (e.g. ``MultiAperture`` or ``CircularAperture``).
+    """
+    raise NotImplementedError(f"no dLux adapter for {type(primary).__name__}")
+
+
+@to_dlux_aperture.register
+def _(primary: SegmentedPrimary):
+    centres = np.asarray(primary.segment_centres_m)
+    seg_rmax = float(primary.segment_flat_to_flat_m) / np.sqrt(3.0)
+    segments = []
+    for x, y in centres:
+        transform = dl.CoordTransform(
+            translation=[float(x), float(y)], rotation=float(np.pi / 6)
+        )  # flat-top hexagons
+        segments.append(
+            dl.RegPolyAperture(
+                nsides=6, rmax=seg_rmax, transformation=transform, softening=1.0
+            )
+        )
+    return dl.MultiAperture(segments, normalise=True)
+
+
+@to_dlux_aperture.register
+def _(primary: SimplePrimary):
+    # no segment geometry -> model the circumscribing circle
+    return dl.CircularAperture(radius=float(primary.diameter_m) / 2.0, normalise=True)

physicaloptix-0.0.1/src/physicaloptix/coronagraph.py

@@ -0,0 +1,120 @@
+"""A dLux-backed optixstuff coronagraph.
+
+``DLuxCoronagraph`` satisfies optixstuff's ``AbstractCoronagraph`` interface, so
+coronagraphoto / jaxedith consume it as any other coronagraph -- the dLux optical
+system is hidden inside. This is the sibling of yippy's sampled-YIP coronagraph:
+yippy interpolates a precomputed PSF table, this propagates live (freeze-to-table
+is a planned bridge).
+"""
+
+import dLux as dl
+import equinox as eqx
+import jax.numpy as jnp
+import numpy as np
+from optixstuff.coronagraph import AbstractCoronagraph
+
+from physicaloptix.apertures import to_dlux_aperture
+
+ARCSEC = 180.0 / np.pi * 3600.0  # arcsec per radian
+
+
+class DLuxCoronagraph(AbstractCoronagraph):
+    """An optixstuff coronagraph whose PSFs come from live dLux propagation.
+
+    Build it from an optixstuff primary with :meth:`from_primary`; it then
+    satisfies the ``AbstractCoronagraph`` interface (``on_axis_psf`` /
+    ``off_axis_psf`` plus the scalar ETC methods).
+
+    No coronagraph mask is modelled yet, so ``on_axis_psf`` is presently the
+    telescope PSF -- a suppression-free degenerate coronagraph. Adding an
+    occulter / Lyot-stop layer is the next step.
+    """
+
+    _aperture: eqx.Module
+    _diameter_m: float
+    _wf_npixels: int = eqx.field(static=True)
+    pixel_scale_lod: float
+    IWA: float
+    OWA: float
+    _raw_contrast: float
+    _core_throughput: float
+
+    def __init__(
+        self,
+        aperture: eqx.Module,
+        diameter_m: float,
+        *,
+        wf_npixels: int = 256,
+        pixel_scale_lod: float = 0.25,
+        IWA: float = 3.0,
+        OWA: float = 30.0,
+        raw_contrast: float = 1e-10,
+        core_throughput: float = 0.2,
+    ) -> None:
+        """Wrap a dLux aperture as an optixstuff coronagraph."""
+        self._aperture = aperture
+        self._diameter_m = diameter_m
+        self._wf_npixels = wf_npixels
+        self.pixel_scale_lod = pixel_scale_lod
+        self.IWA = IWA
+        self.OWA = OWA
+        self._raw_contrast = raw_contrast
+        self._core_throughput = core_throughput
+
+    @classmethod
+    def from_primary(cls, primary, **kwargs) -> "DLuxCoronagraph":
+        """Build from an optixstuff primary (the optixstuff -> dLux seam)."""
+        return cls(to_dlux_aperture(primary), float(primary.diameter_m), **kwargs)
+
+    def _optics(self, pixel_scale_rad, npixels):
+        return dl.AngularOpticalSystem(
+            wf_npixels=self._wf_npixels,
+            diameter=self._diameter_m,
+            layers=[("pupil", self._aperture)],
+            psf_npixels=int(npixels),
+            psf_pixel_scale=float(pixel_scale_rad) * ARCSEC,
+            oversample=1,
+        )
+
+    # -- image interface (consumed by coronagraphoto) ---------------------
+    def on_axis_psf(self, wavelength_nm, pixel_scale_rad, npixels):
+        """On-axis PSF via dLux (telescope PSF until a mask is added)."""
+        optics = self._optics(pixel_scale_rad, npixels)
+        return optics.propagate(jnp.array([wavelength_nm * 1e-9]))
+
+    def off_axis_psf(self, wavelength_nm, separation_lod, pixel_scale_rad, npixels):
+        """Off-axis (planet) PSF, placed along +x by convention."""
+        optics = self._optics(pixel_scale_rad, npixels)
+        wl_m = wavelength_nm * 1e-9
+        offset = jnp.array([separation_lod * wl_m / self._diameter_m, 0.0])
+        return optics.propagate(jnp.array([wl_m]), offset)
+
+    # -- scalar interface (consumed by jaxedith) -- placeholders ----------
+    def throughput(self, separation_lod, wavelength_nm, *, time_s=0.0):
+        """Core throughput (constant eta_p placeholder)."""
+        return self._core_throughput
+
+    def core_area(self, separation_lod, wavelength_nm, *, time_s=0.0):
+        """Photometric core area in (lambda/D)^2 (placeholder)."""
+        return 1.0
+
+    def core_mean_intensity(self, separation_lod, wavelength_nm, *, time_s=0.0):
+        """Mean stellar leakage (constant raw_contrast placeholder)."""
+        return self._raw_contrast
+
+    def occulter_transmission(self, separation_lod, wavelength_nm, *, time_s=0.0):
+        """Off-axis sky transmission (no occulter modelled -> 1)."""
+        return 1.0
+
+    def __repr__(self):
+        """One-line summary."""
+        return (
+            f"DLuxCoronagraph(D={self._diameter_m:.3g} m, "
+            f"wf_npix={self._wf_npixels}, no mask [telescope PSF])"
+        )
+
+
+def psf(primary, wavelength_nm, pixel_scale_rad, npixels, **kwargs):
+    """One-liner facade: optixstuff primary -> on-axis PSF, no visible dLux."""
+    coro = DLuxCoronagraph.from_primary(primary, **kwargs)
+    return coro.on_axis_psf(wavelength_nm, pixel_scale_rad, npixels)