makewfs 1.0.0__tar.gz

makewfs-1.0.0/.gitignore

@@ -0,0 +1,231 @@
+# 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
+
+# makewfs generated artifacts
+*.coverage
+.coverage
+*.npy
+*.npz
+*.fits
+*.fit
+*.png
+validation-metrics.json
+benchmark-results.json
+*.gif
+.vscode

makewfs-1.0.0/AGENTS.md

@@ -0,0 +1,223 @@
+# AGENTS.md
+
+This file is the operating guide for AI agents working in `makewfs`. It applies
+to the entire repository.
+
+## Start here
+
+Before changing anything:
+
+1. Read `README.md` and the complete `ROADMAP.md`.
+2. Read `pyproject.toml` when present, the relevant source/tests/docs, and any
+   linked ADR once those files exist.
+3. Run `git status --short --branch`. Preserve all user changes and unrelated
+   work; never reset or overwrite them.
+4. Identify the smallest unchecked roadmap item that contains the requested work
+   and state its acceptance criteria.
+5. Inspect the public sibling API before proposing cross-repository work:
+   `/home/donkeykong/pyturb` for atmosphere and
+   `/home/donkeykong/getframes` for detector/radiometry.
+
+The repository is currently in the Shack-Hartmann and fixed-mask four-face
+pyramid stage, with deterministic source spectral/angular quadrature, measured
+source curves and user-supplied angular kernels, physical SH sampling controls,
+analytic segmented/rotated pupils, and a documented SH sodium-range geometry
+model. It also includes a versioned labelled documentation gallery, benchmark
+reference snapshot, non-editable-wheel clean-room smoke evidence, released
+wavelength-resolved detector QE through `getframes>=2.1.1`, and public
+end-to-end CuPy execution with CPU parity tests. The GPU path uses
+`numerics.device = "gpu"` and the sibling `getframes` CuPy detector. Do not
+present range-resolved turbulent LGS OPD or broad independent-reference parity
+as implemented until their gates pass.
+
+## Product boundary
+
+`makewfs` owns wavefront-sensor image formation:
+
+```text
+pupil OPD/phase + static config
+              |
+              v
+       makewfs optics
+              |
+              v
+ photon rate [photons/s/native detector pixel]
+              |
+              v
+     getframes.Camera.expose[_spectral]
+              |
+              v
+        Frame data [ADU]
+```
+
+- Atmosphere, frozen flow, Cn2 profiles, off-axis footprints, and LGS cone-effect
+  phase belong to `pyturb`.
+- QE, shot/read/dark noise, gain, detector artifacts, digitization, calibration,
+  and detector presets belong to `getframes`.
+- Reconstruction, centroid/slopes, DMs, and controllers belong to downstream AO
+  software.
+- `makewfs` may model finite guide-source and sodium-layer image morphology
+  because it is part of WFS image formation, but it never predicts LGS return
+  flux or evolves the sodium layer.
+
+Do not copy sibling physics for convenience. If their public API is insufficient,
+write a failing integration test/design note, use the conditional gates in
+`ROADMAP.md`, and make the smallest change in the owning repository.
+
+## Stable contracts to protect
+
+- The per-frame runtime inputs are the wavefront and an optional noise seed. All
+  instrument/source/detector choices live in versioned config.
+- OPD metres are the canonical internal wavefront quantity. Phase-radian input
+  must declare its reference wavelength; units are never inferred.
+- Arrays use `(y, x)` order and documented centered pixel coordinates. Never fix
+  a sign or transpose mismatch by visual trial and error—add an analytic ramp test.
+- Ideal output is a non-negative photon-rate map in photons/s/native detector
+  pixel. Only `getframes` turns it into electrons or ADU.
+- Intensities, not fields, are summed over incoherent wavelengths, modulation
+  points, finite-source samples, and sodium slices.
+- Cropping reports lost flux; it does not renormalize it away.
+- The intended top-level API is `load_config`, `WavefrontSensor`, and `simulate`.
+  Keep other implementation objects out of `makewfs.__init__` unless an API review
+  explicitly accepts them.
+- The optical core must not import `pyturb`. Only the detector adapter imports
+  `getframes.Camera`; radiometry may import documented `getframes` radiometry APIs.
+
+## Numerical and physics standards
+
+- Start from a derivation, primary paper, or maintained independent reference.
+  Cite it in the module and user guide.
+- Every physics feature needs a quantitative assertion against theory or an
+  independent calculation. “The plot looks right” is not validation.
+- Required invariants include piston invariance, non-negative intensity, explicit
+  flux accounting, photon-rate linearity, stable axis/sign conventions, and
+  convergence with numerical sampling.
+- Use explicit centered FFT helpers and normalization. Do not scatter `fftshift`
+  conventions through sensor implementations.
+- Use flux-conserving pixel-area integration/rebinning; interpolation is not a
+  substitute for integrating detector pixels.
+- Preserve `float32/complex64` and `float64/complex128` pairs. Test both; do not
+  allow silent promotion in a hot path.
+- Randomness uses passed `numpy.random.Generator` instances or reproducibly
+  derived named seeds. Never use global `np.random` state.
+- Static grids, masks, ramps, normalization constants, and detector construction
+  are cached on the persistent sensor. Benchmark construction separately from
+  warm per-frame operation.
+- Write array operations behind `ArrayBackend`. Sensor engines must not call
+  NumPy allocation, FFT, or reduction functions directly. File readers and
+  source/config parsing are explicit host operations; the detector boundary
+  preserves the selected backend. Use `ArrayBackend.scalar` or `to_host` only at
+  named metadata/file crossings.
+  The backend-audit AST test and injected-CPU parity tests must remain green.
+- CPU correctness comes first. The private `_backend=cupy_backend()` hook remains
+  an implementation/testing escape hatch. The supported GPU contract is the
+  serializable `numerics.device = "gpu"` field and requires device-resident
+  `getframes`; never reimplement detector behavior in this repository.
+
+## Configuration rules
+
+- TOML is canonical. All physical keys include units in their names.
+- Config models are immutable and contain only serializable intent, never runtime
+  arrays, FFT plans, RNG state, or camera state.
+- Reject unknown keys, incompatible alternatives, non-finite values, invalid
+  ranges, mismatched detector geometry, and unsupported schema versions with
+  path-specific actionable messages.
+- Resolve file references relative to the config file. Hash referenced masks,
+  curves, and static OPD for provenance.
+- A new user-facing field requires validation tests, serialization/digest tests,
+  config-reference documentation, and at least one example where appropriate.
+- Backward-incompatible schema changes require a schema-version change and a
+  migration/stability note.
+
+## Code organization
+
+Follow the target layout in `ROADMAP.md`:
+
+- `config.py` parses and validates; it does not propagate optics.
+- `wavefront.py`, `pupil.py`, and `sampling.py` hold shared numerical rules.
+- `sensors/` contains deterministic ideal optical engines and no camera noise.
+- `radiometry.py` produces source photon budgets using public `getframes` tools.
+- `detector.py` is a narrow adapter to `getframes.Camera.expose` and the
+  optional public `expose_spectral` cube API.
+- `api.py` owns the user facade and caching lifecycle.
+- `validation/` produces theory/reference evidence; `benchmarks/` measures speed;
+  neither is imported by the runtime package.
+
+Keep functions small enough that their units and normalization can be tested in
+isolation. Prefer immutable dataclasses and pure numerical kernels. Public APIs
+have type hints and NumPy-style docstrings. Internal names start with `_` unless
+another module has a deliberate need for them.
+
+## Tests and quality gate
+
+Once Phase 0 creates the tooling, the normal pre-handoff gate is:
+
+```bash
+ruff check .
+ruff format --check .
+python -m mypy
+pytest --cov=makewfs --cov-branch --cov-report=term-missing
+mkdocs build --strict
+python -m build
+```
+
+Run `python -m mypy` from a clean Python 3.10 environment, as the CI lint job
+does. The configured mypy target is the minimum supported Python version, so the
+type-check environment must also resolve the Python 3.10 dependency markers
+(including `tomli`) and a NumPy release whose stubs support Python 3.10. Running
+the Python 3.10-targeted check from a newer environment can instead install
+newer-only NumPy stubs and omit the conditional `tomli` dependency.
+
+Also run the narrowest relevant tests while iterating. Mark slow statistical,
+validation, GPU, and example tests explicitly; ordinary tests must stay quick.
+When sibling packages are installed, run `python -m pytest -m interop` as a
+separate compatibility check.
+
+Test public behavior, units, signs, shapes, failure modes, precision, and seeded
+reproducibility. Statistical tests use ensemble uncertainty and non-flaky
+tolerances. Independent reference packages such as HCIPy are optional validation
+dependencies, never core dependencies.
+
+When CUDA 12 CuPy and a device are available, also run `python -m pytest -q -m
+gpu`. GPU tests are optional and must verify CPU optical parity, device-resident
+detector/truth arrays, direct `pyturb` interoperability, and seeded detector
+behavior; they must not make ordinary CI depend on CUDA.
+
+For performance changes, run the affected warm and cold benchmarks and report the
+hardware/dependency context. Do not claim a speedup from one timing sample or
+weaken physics accuracy to win a benchmark without an explicit documented mode.
+The representative CI guard is reproducible locally with:
+
+```bash
+python benchmarks/run.py --representative --frames 1 --output /tmp/makewfs-benchmark.json
+python benchmarks/check_regression.py /tmp/makewfs-benchmark.json
+MPLBACKEND=Agg python examples/gallery.py
+```
+
+## Documentation and examples
+
+- Every public feature lands with its API docstring and the relevant user guide.
+- Every configuration field appears in the configuration reference with units,
+  default, allowed range, interactions, and an example.
+- Examples are scripts plus TOML, deterministic by default, headless, and able to
+  save plots. Give them a reduced CI mode; never rely on an interactive notebook
+  as the only executable form.
+- Plot labels include units and state whether an image is ideal photon rate,
+  expected electrons, or noisy ADU.
+- Be explicit about approximations, especially partial sampling, chromatic
+  pyramid behavior, LGS mean-altitude OPD, and detector cropping.
+- Update `CHANGELOG.md` under Unreleased for user-visible changes.
+
+## Roadmap and handoff discipline
+
+- Work in dependency order. Shared contracts/ADRs precede parallel sensor work.
+- Take bounded vertical slices; avoid sweeping “implement a whole phase” changes.
+- Check a roadmap box only when implementation, tests, docs, and required
+  validation/benchmark are all complete and passing.
+- Do not mark conditional sibling work as required until its gate is demonstrated.
+- At handoff, summarize files changed, assumptions, physics/reference basis,
+  commands run and results, benchmark impact, and remaining roadmap items.
+- Maintain this file: update it when the repository layout, quality-gate commands,
+  stable contracts, or current implementation stage changes.
+- If blocked, document the exact failing contract and evidence. Do not work around
+  it by absorbing atmosphere or detector behavior into this repository.

makewfs-1.0.0/CHANGELOG.md

@@ -0,0 +1,130 @@
+# Changelog
+
+All notable changes to `makewfs` are documented here.
+
+## [Unreleased]
+
+## [1.0.0] - 2026-07-26
+
+- Prepared the first stable public release with versioned package metadata,
+  PyPI/CI badges, citation and release documentation, and a trusted-publishing
+  GitHub Actions workflow using the `pypi` environment.
+- Fixed the benchmark runner on Python 3.10 by using the portable
+  `datetime.timezone.utc` API.
+- Raised the detector dependency to released `getframes>=2.1.1`, made
+  wavelength-resolved detector QE and full spectral truth part of the supported
+  contract, and removed the pre-release integrated-signal compatibility path.
+- Added an R-band HAKA camera-LUT analysis using representative A0 V through M3
+  V continua and generated open-loop Maunakea states. It reports mean active
+  4x4-lenslet intensity SNR with OCAM2K photon, EM-excess, dark, CIC, read, and
+  quantization noise, fits a smooth ceiling-aware broken-power-law cadence floor
+  only to the R>=10 fine-adjustment tail, asymptotes to the true 2067 Hz OCAM2K
+  limit, and emits a smooth saturation-constrained policy that never slows below
+  that empirical model merely to recover per-frame SNR.
+- Generalized the HAKA broadband photon-budget helper from fixed Johnson V
+  normalization to an explicit Johnson normalization band, retaining V as the
+  showcase and eng519 default.
+- Fixed temporal integration to average and forward wavelength-resolved photon
+  cubes to the detector, preserving configured spectral QE instead of silently
+  falling back to scalar QE.
+- Fixed even-sized Shack-Hartmann focal-plane registration: zero slope now lies
+  at the intersection of the central four detector pixels, using half-integer
+  Fourier samples rather than an asymmetric integer-grid crop.
+- Added a Keck II HAKA open-loop worked example with a generated 36-segment
+  Keck pupil including a live-data-fitted circle-plus-hexagon secondary shadow
+  and six 26 mm support arms, exact
+  57x57-by-4x4 (228x228) Shack-Hartmann/OCAM2K geometry,
+  magnitude-dependent EM gain and frame rate, temporally integrated `pyturb`
+  Maunakea OPD, exposure-matched master-dark subtraction, GIF/MP4 output, and a
+  reproducibility manifest with per-frame photon/electron/count flux auditing.
+  The supplied real eng519 V=10.16 RTC cube constrains the roughly 54-lenslet pupil
+  diameter, compact quadcell sampling, and the eight-output 4x2 OCAM geometry,
+  outside-pupil dark/bias levels, and relative conversion gains. With no matched
+  dark cube, the RTC comparison subtracts a per-output/repeated-4x4 template and
+  per-frame output drift inferred outside the pupil, then reports real and
+  simulated lenslet signal/morphology without global rescaling. The
+  eng519 comparison now simulates V=10.16 at 750 fps, retains every tenth
+  generated phase-screen exposure like the telemetry, and writes a side-by-side
+  GIF. The magnitude showcase advances frozen flow by a visible minimum cadence
+  at every magnitude without changing the physical detector exposure. HAKA NGS
+  photon formation now integrates a V-normalized 6600 K spectrum over the full
+  400--950 nm band, applies measured Mauna Kea extinction at the observed
+  airmass, applies 0.88 reflectivity to the aluminum primary, secondary, and
+  tertiary, uses the sampled clear-pupil collecting area, and passes the
+  resolved spectral cube through OCAM2K's wavelength-dependent QE. The reference
+  renders now use the Keck-characterized approximately 28 output e-/ADU OCAM2K
+  conversion. Team-confirmed independent bench measurements now establish the
+  downstream HAKA throughput as 28.7%; it is applied as physical radiometry after
+  the telescope mirrors rather than inferred or fitted by the RTC comparison.
+  The regenerated eng519 comparison has a real/simulation signal ratio of
+  1.00029.
+- Added a reproducible warm HAKA CPU/GPU benchmark. It times non-periodic Mauna
+  Kea atmosphere evolution, the full eight-wavelength 57x57 Shack--Hartmann
+  propagation, and noisy OCAM2K exposure while excluding static setup and
+  synchronizing CUDA batches. Its local GIF shows CPU/GPU detector streams over
+  equal wall-clock playback with measured FPS, real-time factor, frame counter,
+  and atmosphere time overlays.
+- Removed generated PNG/GIF artifacts from version control and ignore them
+  globally; example scripts continue to create them locally on demand.
+- Added public end-to-end GPU execution through `numerics.device = "gpu"`.
+  CuPy OPD, SH/PWFS optics, wavelength-resolved photon maps, the `getframes`
+  detector chain, truth, and ADU remain device-resident. The runtime reports an
+  actionable error when the installed `getframes` lacks its GPU camera contract.
+- Added direct `pyturb` GPU OPD → Shack–Hartmann → GPU ADU integration coverage,
+  updated SH/PWFS CUDA parity tests, synchronized GPU benchmark mode, and measured
+  detector-only timing.
+- Added a paired CPU/GPU bulk-throughput artifact and rendered comparison for
+  representative SH, broadband LGS, and modulated pyramid workflows, with
+  README and performance-guide results plus exact reproduction commands.
+- Optimized persistent SH/PWFS execution by caching source/range geometry,
+  modulation phasors, resampling grids, flux normalization, and monochromatic
+  spectral views; using native orthonormal FFT scaling and an intensity-only SH
+  transform; removing redundant validations/resampling; and batching GPU
+  metadata scalar transfers. On the RTX 5090 reference matrix this improves CPU
+  throughput by 1.19x–1.73x and GPU throughput by 1.42x–2.58x over the initial
+  end-to-end implementation while retaining the physics/parity gates.
+
+- Expanded optical verification with a direct-DFT pyramid reference,
+  multi-amplitude HCIPy SH response curves, HCIPy low-order pyramid response
+  maps, supplementary local OOPAO comparisons, and quantitative SH/pyramid
+  metrics in the deterministic validation report.
+- Fixed the pyramid propagation grid to honor `numerics.fft_oversampling`, so
+  the diffraction halo no longer wraps onto the pupil rims; cropped flux is
+  reported as captured rate and independent HCIPy parity improved.
+- Reconfigured the shipped example TOMLs to be representative demonstrations:
+  pyramid pupils are now separated (`pupil_separation_pixels` larger than
+  `pixels_across_pupil`) and source photon rates correspond to a bright guide
+  star so detector frames show spots above read noise.
+- Added deterministic broadband/finite-source quadrature, measured SED and
+  transmission curves, physical SH sampling, field stops, optical blur,
+  detector margins, and sodium-range SH elongation examples.
+- Added strict configuration-reference documentation for every v1 table and
+  key, plus validation and benchmark smoke reports in CI.
+- Added headless worked-example CI smoke tests, deterministic plotting backend
+  selection, and a 90% enforced branch-coverage gate.
+- Added configuration-relative three-column angular source kernels for measured
+  or resolved guide-star morphologies, with normalized state provenance.
+- Added rotated analytic segment-gap pupils and a cached physical-coordinate
+  lenslet-grid rotation/offset path with aligned-grid parity tests.
+- Added an optional HCIPy ideal-pyramid cross-check and a dedicated validation
+  CI job; HCIPy remains outside runtime dependencies.
+- Added configuration-relative measured SH optical blur kernels with unit-sum
+  validation, cached convolution, and provenance hashes.
+- Added a public API/configuration stability audit and same-run benchmark
+  regression envelopes for representative CPU kernels.
+- Added versioned benchmark snapshots and isolated non-editable-wheel
+  interoperability verification for `pyturb` 1.0 and `getframes`.
+- Added a versioned labelled SVG capability gallery with units, color bars,
+  seeds, configuration digests, and modeling notes.
+- Added wavelength-resolved detector QE through the public `getframes` spectral
+  cube contract, with truth preservation and a shipped comparison example.
+- Formalized the private optical `ArrayBackend` boundary and added static
+  leakage/parity checks so a future device backend does not require sensor
+  mathematics to be rewritten.
+- Added the original private CUDA 12 CuPy optical path with SH/pyramid parity
+  tests; it is retained as a compatibility hook underneath the public
+  configuration-driven GPU path.
+- Added the monochromatic CPU four-face pyramid engine, modulation support, a
+  complete pyramid example configuration, and symmetry/flux/detector tests.
+- Added the implementation roadmap and agent guide.
+- Added the initial configuration and numerical implementation foundation.

makewfs-1.0.0/CITATION.cff

@@ -0,0 +1,12 @@
+cff-version: 1.2.0
+message: "If you use makewfs in your research, please cite this software."
+title: "makewfs: configuration-driven adaptive-optics wavefront-sensor image simulation"
+type: software
+authors:
+  - family-names: Taylor
+    given-names: Jacob
+version: 1.0.0
+date-released: 2026-07-26
+license: MIT
+repository-code: "https://github.com/jacotay7/makewfs"
+url: "https://jacotay7.github.io/makewfs/"

makewfs-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing to makewfs
+
+`makewfs` is a numerical optics package. A contribution is complete only when
+its behavior, units, tests, documentation, and performance implications are
+clear.
+
+Read [AGENTS.md](AGENTS.md) and the relevant section of [ROADMAP.md](ROADMAP.md)
+before starting. Keep atmosphere physics in `pyturb` and detector physics in
+`getframes`.
+
+## Development setup
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e ".[dev,examples]"
+```
+
+For local sibling development, install the checked-out packages separately:
+
+```bash
+python -m pip install -e ../getframes
+python -m pip install -e ../pyturb
+```
+
+## Quality gate
+
+```bash
+ruff check .
+ruff format --check .
+mypy
+python -m pytest -q --cov=makewfs --cov-branch --cov-report=term-missing
+mkdocs build --strict
+python -m build
+```
+
+Physics changes require an analytic or independent-reference assertion. Keep
+randomness on explicit seeded generators, state all array units, and update the
+configuration reference and changelog for public changes.
+
+## Pull requests
+
+Keep changes focused. Describe the numerical model, source/reference used for
+validation, tests run, benchmark impact, and any conditional upstream work.

makewfs-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jacob Taylor
+
+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.