camsim 0.1.0__tar.gz

camsim-0.1.0/.gitignore

@@ -0,0 +1,39 @@
+# macOS
+.DS_Store
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Python caches and test/lint artefacts
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.hypothesis/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+
+# Jupyter / Jupytext
+.ipynb
+*.ipynb
+.ipynb_checkpoints/
+.jupyter_cache/
+
+# Build artefacts
+build/
+dist/
+site/
+*.egg-info/
+.eggs/
+
+# Generated results and local caches
+results/cache/
+
+# Repository-internal process material and superseded archives
+.superpowers/
+archives/

camsim-0.1.0/CHANGELOG.md

@@ -0,0 +1,116 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The `[0.1.0]` release was approved by the project owner on 2026-10-27 after
+the G5 review recorded in `results/reports/validation_report.md`. The
+distribution version is `0.1.0`. A fresh `Unreleased` section opens for future
+changes.
+
+## [0.1.0] - 2026-10-27
+
+**Status: released.** G1-G4 are PASS and the G5 candidate was signed off. The
+tag `v0.1.0` and the GitHub/PyPI publication are the release steps recorded in
+the validation report and the release checklist.
+
+### Added
+
+#### Phase 0 — Foundation
+
+- Installable `camsim` package with a `src/` layout, a single version source
+  (`0.1.0`), lazy (PEP 562) public exports, and a `camsim` console entry
+  point with `info`, `schema`, `validate`, `render`, `characterize`, `measure`,
+  and `figures` subcommands.
+- Radiometric unit conversions and validated spectral types: `WavelengthGrid`,
+  `SpectralIrradiance`, photon-energy helpers, area-conserving spatial
+  resampling, and overlap-weighted wavelength integration.
+- Frame and colour contracts: `RawFrame` with self-describing metadata,
+  `RenderedImage`, `CFAPattern`, `ColorSpace`, and `ColorReference`.
+- Versioned Pydantic v2 configuration schema for sensors and ISPs with
+  unit-bearing field names, `extra="forbid"`, cross-field physical validation,
+  JSON Schema export, and provenance metadata.
+- Representative sensor and ISP presets (`flagship_phone_50mp`, default ISP).
+- MkDocs Material documentation site with concepts, architecture, validation,
+  and datasheet-mapping pages, including a Mermaid imaging-chain diagram.
+- Continuous integration on Ubuntu and macOS across Python 3.11, 3.12, and
+  3.13: ruff lint and format check, strict mypy, pytest with coverage, strict
+  documentation build, and wheel/sdist build.
+- Documentation workflow that builds with warnings as errors on pull requests
+  and deploys the site to GitHub Pages from `main`.
+- Contribution guide, Contributor Covenant code of conduct, changelog,
+  citation metadata, third-party notices, and Apache-2.0 licence.
+- Pre-commit hooks, Jupytext notebook pairing, Makefile targets (`setup`,
+  `test`, `lint`, `format`, `typecheck`, `coverage`, `docs`, `build`,
+  `notebooks`, `figures`, `gate`, `clean`), and the executable G0 gate test.
+
+#### Phase 1 — Scene and optics
+
+- Spectral scene rendering with photometric lux normalization, D65/3000 K/4000 K
+  illuminants, ColorChecker reflectance, slanted-edge, flat-patch, Siemens-star,
+  and glyph targets, and explicit energy-conserving spatial resampling.
+- Gaussian, Airy, and box point-spread functions with analytic MTF helpers,
+  lens geometry, and vignetting (uniform for the reference lens).
+- G1 validation report and figures covering photometry, PSF MTF, energy
+  conservation, edge-angle recovery, the spectral-cube contract, and the
+  reference lens.
+
+#### Phase 2 — Sensor
+
+- Spectral projection through QE, CFA, and IR-cut curves; shot, read, dark, and
+  fixed-pattern noise; full-well and ADC saturation with clipping masks; LCG/HCG
+  dual conversion gain; defects; binning; and the self-describing `RawFrame`.
+- EMVA 1288-style characterization recovering read noise, DSNU, PRNU, full well,
+  linearity, dynamic range, system gain, and dark current within stated
+  tolerances.
+- G2 validation report, machine-readable results, and six figures.
+
+#### Phase 3 — ISP
+
+- Fixed-order ISP: DPC, BLC, LSC, AWB, bilinear/MHC demosaicing, ridge CCM,
+  linear-light denoise, thresholded unsharp mask, tone/OETF, and output
+  primaries. Every stage before tone is linear float32.
+- RCCC baseline reconstruction (shape/linearity/smoke only) and a documented
+  Bayer-only colour and MTF caveat.
+- G3 validation report, machine-readable results, and the ISP stage gallery,
+  including ColorChecker ΔE2000, AWB, demosaic reference cross-checks, LSC,
+  denoise, sharpen, and RCCC evidence.
+
+#### Phase 4 — Metrics
+
+- Import-independent metrics harness: ISO 12233-style slanted-edge e-SFR/MTF,
+  spatial and temporal SNR, CIEDE2000/CIEDE76, acutance, chart layouts, and the
+  unified `measure_all` report with strict JSON serialization.
+- G4 validation report, machine-readable results, and analytic-reference
+  figures for MTF, SNR, colour, and acutance.
+
+#### Phase 5 — Consolidation
+
+- `Camera` orchestration with fixed exposure and opt-in auto-exposure
+  (`Camera.auto_expose`) that probes the real sensor, respects the preset's
+  physical windows, and reports every decision.
+- RAW and image IO, layout/report serialization, and the `render`,
+  `characterize`, `measure`, and `figures` CLI commands.
+- Deterministic pipeline benchmark with quick and full modes.
+- Consolidated G5 validation report (`results/reports/validation_report.md`),
+  cross-cutting denoise/sharpen/auto-exposure/RCCC checks, determinism and
+  import-independence evidence, and the `g5_*` summary figures.
+- G5 sign-off tests, documentation updates, citation metadata, and the release
+  candidate metadata.
+
+### Validation
+
+- G0: quality-gate commands pass locally; CI workflows (including examples
+  and notebooks) were added but execution is pending a push.
+- G1: 7/7 checks; G2: 16/16; G3: 21/21; G4: 31/31; G5 cross-cutting: 16/16.
+- Test suite: all tests pass; subject-module coverage is 91.73% against the
+  90% gate with the documented `*/camsim/viz/*` omission, and whole-package
+  coverage including viz is 83.55% (reviewed exception).
+- The validation is simulated: it is not a certified ISO 12233 or EMVA 1288
+  measurement, and the flagship preset is a representative engineering design
+  point, not a measurement of a specific commercial part.
+- **No machine-vision code or claim is included.** `camsim.tasks` remains a
+  gated docstring-only namespace.
+
+[0.1.0]: https://github.com/pengzhao-ai/camsim/releases/tag/v0.1.0

camsim-0.1.0/CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+message: "If you use camsim in your work, please cite it using the metadata below."
+type: software
+title: "camsim: deterministic camera sensor, ISP, and image-quality simulation"
+abstract: >-
+  camsim is a deterministic Python library that simulates a camera from spectral
+  scene irradiance through a lens and sensor model to a RAW frame, processes the
+  RAW frame through a modular image signal processor, and measures image quality
+  with standard metrics. This 0.1.0 release validates the scene/optics helpers,
+  sensor, ISP, metrics, camera orchestration, IO, and CLI. It is a simulated,
+  EMVA 1288-style and ISO 12233-style validation, not a certified measurement of
+  physical hardware. Machine-vision experiments are gated behind the G5 human
+  sign-off and are not included in 0.1.0.
+version: 0.1.0
+date-released: "2026-10-27"
+authors:
+  - family-names: Zhao
+    given-names: Peng
+license: Apache-2.0
+repository-code: "https://github.com/pengzhao-ai/camsim"
+url: "https://github.com/pengzhao-ai/camsim"
+keywords:
+  - camera simulation
+  - image quality
+  - image quality metrics
+  - image signal processor
+  - sensor modelling
+  - radiometry
+  - colorimetry
+  - reproducible research

camsim-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

camsim-0.1.0/NOTICE

@@ -0,0 +1,22 @@
+camsim
+Copyright 2026 Peng Zhao
+
+This product includes software, data, and fonts developed by third parties.
+The complete inventory, with copyright notices, licence names, and links to
+the full licence texts, is in THIRD_PARTY.md. The camsim source code itself is
+licensed under the Apache License, Version 2.0; see LICENSE.
+
+Material redistributed with, or embedded in output produced by, this project
+includes:
+
+- DejaVu fonts, bundled with Matplotlib and used for documentation and figure
+  text. Copyright (c) 2003 Bitstream, Inc.; DejaVu changes are in the public
+  domain.
+- ColorChecker 2005 spectral data, distributed by colour-science with the
+  notice "BabelColor ColorChecker data: Copyright (C) 2004-2012 Danny Pascale
+  (www.babelcolor.com); used by permission." The exact dataset used by camsim
+  is finalized in Phase 1 (Task 6).
+
+colour-science is a runtime dependency and is not modified or redistributed by
+this repository; its BSD-3-Clause licence and copyright are reproduced in
+THIRD_PARTY.md for attribution.