eyepiece 0.0.1__tar.gz

eyepiece-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

eyepiece-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: []

eyepiece-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

eyepiece-0.0.1/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+## 0.0.1 (2026-08-11)
+
+
+### Features
+
+* call-time style resolution with zero-style light fallback ([7888620](https://github.com/CoreySpohn/eyepiece/commit/7888620d77f6f5ac93379f8eab2d9733fea55376))
+* complex-field 2x2 show_field with SubFigure embedding ([4c92480](https://github.com/CoreySpohn/eyepiece/commit/4c924806f2b9e790aa7d1b4a8facd68901482deb))
+* corner plots, hist-vs-pdf overlay, covariance ellipse ([72da7be](https://github.com/CoreySpohn/eyepiece/commit/72da7be3d67a1560d7ef44f76bc54b6369b3a780))
+* flat public namespace and firewall guard tests ([7d7b0a2](https://github.com/CoreySpohn/eyepiece/commit/7d7b0a208ce1113c9f8efaeec58bf05cc00a5fea))
+* imshow_log, imshow_diverging, and shared-norm compare_row ([223c945](https://github.com/CoreySpohn/eyepiece/commit/223c9455007f2806c52919ce9ef7f6a750400447))
+* mode-aware save_fig with directory anchoring ([74118de](https://github.com/CoreySpohn/eyepiece/commit/74118de9115036858dcb00308187a67a6ef9f87b))
+* multi-sink grab-frame record() and animate() facade ([c217283](https://github.com/CoreySpohn/eyepiece/commit/c21728317626305f8c94bbdbe0401e26813c7962))
+* pixel-edge extent and axis-label helpers ([47a052a](https://github.com/CoreySpohn/eyepiece/commit/47a052a56169595c569bee1ca0f386b4fd303a6e))
+* PlotResult/MosaicResult return contract and artist key vocabulary ([cf3f06c](https://github.com/CoreySpohn/eyepiece/commit/cf3f06cac4273dda8181119b926fabb78429fba5))
+* scaffold eyepiece package ([b08f5cb](https://github.com/CoreySpohn/eyepiece/commit/b08f5cb5ab550380df7d8e4232b0fcf584a94dbf))
+* SourceStyles, Frame, and docs skeleton ([ea20c94](https://github.com/CoreySpohn/eyepiece/commit/ea20c947b4aa30a4064cd9ce1873c7480cb13e8b))
+* trajectory trail with depth cues, sky_fan, fading_track, schematic rail ([5aa3967](https://github.com/CoreySpohn/eyepiece/commit/5aa39679828f726562a616f35fa1f9f17028469f))
+
+
+### Bug Fixes
+
+* compare_row single-image squeeze, empty-list guard, update range docs ([f6aae74](https://github.com/CoreySpohn/eyepiece/commit/f6aae741c5b147623833fdda462f101bdc904c36))
+* identity-based eq/hash on PlotResult and MosaicResult ([ce629a3](https://github.com/CoreySpohn/eyepiece/commit/ce629a31dcdf66fd1ccba4175cb9a567f61cc4d1))
+* restore internal-ref guard coverage with hook-safe pattern forms ([c693619](https://github.com/CoreySpohn/eyepiece/commit/c693619b35c042f1de4f615d62dd023ec850fa48))
+* sky_fan errorbar artist, schematic lines key and highlight guard ([ba0cec3](https://github.com/CoreySpohn/eyepiece/commit/ba0cec34374f76c8ec0b142ae2b5536ad3f50e5c))
+* validate configured ffmpeg path and cover anim mechanics with tests ([6c1613b](https://github.com/CoreySpohn/eyepiece/commit/6c1613b3d9ee664f6b6c4ec08a9f4388406dbc25))
+
+
+### Miscellaneous Chores
+
+* release 0.0.1 ([8b60e62](https://github.com/CoreySpohn/eyepiece/commit/8b60e62610407673d4f2426243831bb0784de8fd))

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

eyepiece-0.0.1/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.5
+Name: eyepiece
+Version: 0.0.1
+Summary: Plotting and animation primitives for astronomical imaging simulations: ax-first stateless figure functions, a multi-sink animation recorder, and styled figure saving.
+Project-URL: Homepage, https://github.com/CoreySpohn/eyepiece
+Project-URL: Issues, https://github.com/CoreySpohn/eyepiece/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: hwostyle>=1.3.0
+Requires-Dist: matplotlib>=3.8
+Requires-Dist: numpy
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: imageio-ffmpeg; extra == 'docs'
+Requires-Dist: ipython; 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: hwo
+Requires-Dist: hwoutils; extra == 'hwo'
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Description-Content-Type: text/markdown
+
+# eyepiece
+
+Plotting and animation primitives for astronomical imaging simulations.
+
+## What eyepiece is
+
+`eyepiece` provides ax-first, stateless figure functions for the plots that
+recur across direct-imaging work: log-scaled and diverging image displays,
+complex-field panels, corner plots, orbit and sky-track scenes, optical-train
+schematics, and a multi-sink animation recorder that grabs frames once and
+writes them to any combination of gif, mp4, and html. Every primitive takes
+plain arrays in and returns a small result object holding the axes and the
+artists it drew, so callers can update or extend a figure without re-deriving
+which line or image object came from where.
+
+Figure style (color, colormaps, and mode) is resolved through
+[hwostyle](https://github.com/HabitableWorldsObservatory/hwostyle) at call
+time, not at import time. `import eyepiece` never activates a style or
+touches matplotlib's rcParams. Without an active hwostyle mode, primitives
+fall back to a fixed light-mode palette, so eyepiece also works as a
+standalone plotting library.
+
+## What eyepiece is not
+
+- **Not a simulation library.** eyepiece takes arrays and returns figures; it
+  never imports a simulation, orbit, or optics package.
+- **Not a style engine.** Color, colormap, and mode definitions live in
+  hwostyle; eyepiece only reads them at call time.
+- **Not a data pipeline.** Aggregating or transforming simulation output
+  before plotting is the caller's job.
+
+## Status
+
+eyepiece is in early development. The package currently exposes only its
+version; the plotting and animation API is under active construction.
+
+## Installation
+
+```bash
+pip install eyepiece
+```
+
+Unit conversions used by a small number of layout helpers (arcsecond and AU
+extents) are optional and pull in [hwoutils](https://github.com/CoreySpohn/hwoutils):
+
+```bash
+pip install eyepiece[hwo]
+```
+
+## License
+
+MIT

eyepiece-0.0.1/README.md

@@ -0,0 +1,52 @@
+# eyepiece
+
+Plotting and animation primitives for astronomical imaging simulations.
+
+## What eyepiece is
+
+`eyepiece` provides ax-first, stateless figure functions for the plots that
+recur across direct-imaging work: log-scaled and diverging image displays,
+complex-field panels, corner plots, orbit and sky-track scenes, optical-train
+schematics, and a multi-sink animation recorder that grabs frames once and
+writes them to any combination of gif, mp4, and html. Every primitive takes
+plain arrays in and returns a small result object holding the axes and the
+artists it drew, so callers can update or extend a figure without re-deriving
+which line or image object came from where.
+
+Figure style (color, colormaps, and mode) is resolved through
+[hwostyle](https://github.com/HabitableWorldsObservatory/hwostyle) at call
+time, not at import time. `import eyepiece` never activates a style or
+touches matplotlib's rcParams. Without an active hwostyle mode, primitives
+fall back to a fixed light-mode palette, so eyepiece also works as a
+standalone plotting library.
+
+## What eyepiece is not
+
+- **Not a simulation library.** eyepiece takes arrays and returns figures; it
+  never imports a simulation, orbit, or optics package.
+- **Not a style engine.** Color, colormap, and mode definitions live in
+  hwostyle; eyepiece only reads them at call time.
+- **Not a data pipeline.** Aggregating or transforming simulation output
+  before plotting is the caller's job.
+
+## Status
+
+eyepiece is in early development. The package currently exposes only its
+version; the plotting and animation API is under active construction.
+
+## Installation
+
+```bash
+pip install eyepiece
+```
+
+Unit conversions used by a small number of layout helpers (arcsecond and AU
+extents) are optional and pull in [hwoutils](https://github.com/CoreySpohn/hwoutils):
+
+```bash
+pip install eyepiece[hwo]
+```
+
+## License
+
+MIT

eyepiece-0.0.1/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ['hatchling', "hatch-fancy-pypi-readme", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[project]
+name = "eyepiece"
+description = "Plotting and animation primitives for astronomical imaging simulations: ax-first stateless figure functions, a multi-sink animation recorder, and styled figure saving."
+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 = ["matplotlib>=3.8", "numpy", "hwostyle>=1.3.0"]
+
+[project.optional-dependencies]
+hwo = ["hwoutils"]
+docs = ["sphinx", "myst-nb", "sphinx-book-theme", "sphinx-autoapi", "sphinx_autodoc_typehints", "ipython", "imageio-ffmpeg"]
+test = ["pytest", "pytest-cov"]
+dev = ["pre-commit"]
+
+[project.urls]
+Homepage = "https://github.com/CoreySpohn/eyepiece"
+Issues = "https://github.com/CoreySpohn/eyepiece/issues"
+
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/eyepiece/_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/eyepiece"]
+
+[tool.hatch.build.targets.sdist]
+exclude = ["/scripts", "/docs", "/tests", "/.github"]

eyepiece-0.0.1/src/eyepiece/__init__.py

@@ -0,0 +1,70 @@
+"""Plotting and animation primitives for astronomical imaging simulations.
+
+eyepiece provides a small set of pure functions for rendering, comparing,
+and animating simulated images (point spread functions, coronagraph
+detection maps, complex optical fields, and the like). Every public name
+lives at the top level of this package; the submodules that implement them
+(``images``, ``layout``, ``output``, ``anim``) are internal organization
+and are not part of the public API.
+
+Example::
+
+    import eyepiece as ep
+
+    result = ep.imshow_log(image)
+    ep.save_fig(result.fig, "psf")
+
+The library never imports a simulation library and never mutates
+matplotlib's global state at import time; style is applied explicitly by
+the caller (see ``eyepiece._style``), not captured when this package loads.
+"""
+
+from eyepiece._result import MosaicResult, PlotResult
+from eyepiece._version import __version__
+from eyepiece.anim import animate, record
+from eyepiece.images import compare_row, imshow_diverging, imshow_log, show_field
+from eyepiece.layout import (
+    Frame,
+    SourceStyles,
+    extent_arcsec,
+    extent_au,
+    extent_lod,
+    extent_lod_from_pixels,
+    label_arcsec,
+    label_au,
+    label_lod,
+)
+from eyepiece.output import save_fig
+from eyepiece.scene import fading_track, sky_fan, trail
+from eyepiece.schematic import schematic
+from eyepiece.stats import corner, corner_overlay, cov_ellipse, hist_vs_pdf
+
+__all__ = [
+    "Frame",
+    "MosaicResult",
+    "PlotResult",
+    "SourceStyles",
+    "__version__",
+    "animate",
+    "compare_row",
+    "corner",
+    "corner_overlay",
+    "cov_ellipse",
+    "extent_arcsec",
+    "extent_au",
+    "extent_lod",
+    "extent_lod_from_pixels",
+    "fading_track",
+    "hist_vs_pdf",
+    "imshow_diverging",
+    "imshow_log",
+    "label_arcsec",
+    "label_au",
+    "label_lod",
+    "record",
+    "save_fig",
+    "schematic",
+    "show_field",
+    "sky_fan",
+    "trail",
+]