invariant-science 0.1.0__tar.gz

invariant_science-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Report a reproducible defect
+labels: bug
+---
+
+For a vulnerability, use the private reporting route in `SECURITY.md`.
+
+### What did you expect?
+
+State the check and why you expected it to pass, fail, or be inconclusive.
+
+### What happened?
+
+Include the status, CLI exit code if relevant, and the relevant error or report
+excerpt. Remove secrets, private data, and identifying paths.
+
+### How can we reproduce it?
+
+Paste the smallest runnable Python snippet or CLI commands and a synthetic
+input. Include array shapes and dtypes, tolerances, and any model assumptions.
+
+### Environment
+
+Include the operating system, Python, NumPy, and `invariant-science --version` output,
+and whether you installed from source, a wheel, or an sdist.

invariant_science-0.1.0/.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,15 @@
+---
+name: Documentation or installation problem
+about: Report a confusing instruction, example, or setup step
+labels: documentation
+---
+
+### Where did you get stuck?
+
+Link the page or give the command you ran. Include your operating system,
+Python version, and installation source.
+
+### What did you expect to happen?
+
+Include the actual output or wording that led you to expect something else.
+Remove private paths, credentials, and data from examples.

invariant_science-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Scientific check request
+about: Propose a numerical or scientific property worth verifying
+labels: enhancement
+---
+
+### What calculation needs this check?
+
+Describe the computation, its output, and what your current workflow misses.
+
+### What property should hold?
+
+State the equation or criterion, units, assumptions, and how you would choose
+tolerances. Link an analytical solution, reference implementation, or paper
+if available.
+
+### What should the report show?
+
+Give one small example that should pass and one that should fail. Describe
+what would make a result inconclusive or misleading.

invariant_science-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,88 @@
+name: CI
+on:
+  push:
+  pull_request:
+permissions:
+  contents: read
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+      - run: python -m pip install -e ".[dev]"
+      - run: python -m pytest -q -W error --cov=invariant_science --cov-branch --cov-report=term-missing
+      - run: python -m invariant_science demo --out reports/ci-demo
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.13"
+      - run: python -m pip install -e ".[dev]"
+      - run: ruff check src tests examples tools
+      - run: python -m mypy src/invariant_science --check-untyped-defs
+  tutorials:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+      - run: python -m pip install . pytest
+      - run: python examples/quickstart.py
+      - run: python examples/oscillator.py
+      - run: python examples/poisson.py
+      - run: python tools/build_showcase.py --out reports/showcase
+      - run: python -m pytest -q --tb=short examples/test_verification.py
+      - name: Check that a numerical regression fails pytest and leaves reports
+        env:
+          INVARIANT_INJECT_REGRESSION: "1"
+        run: |
+          status=0
+          python -m pytest -q --tb=short examples/test_verification.py || status=$?
+          test "$status" -eq 1
+          python -c 'import json; from pathlib import Path; assert json.loads(Path("reports/verification/position.json").read_text())["status"] == "FAIL"'
+      - uses: actions/upload-artifact@v7
+        if: ${{ !cancelled() }}
+        with:
+          name: tutorial-reports
+          path: reports/
+  package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.11"
+      - run: python -m pip install build "setuptools==77.0.3" wheel twine
+      - run: python -m build --no-isolation
+      - run: python tools/check_distribution.py dist
+      - run: python -m twine check --strict dist/*
+      - run: python -m venv .venv-wheel
+      - run: .venv-wheel/bin/python -m pip install dist/*.whl "numpy==2.1.0"
+      - run: .venv-wheel/bin/python -m pip check
+      - run: .venv-wheel/bin/python -I tools/smoke_install.py
+      - run: .venv-wheel/bin/python -m pip install "pytest>=8" "hypothesis>=6.100"
+      - run: .venv-wheel/bin/python -I -m pytest -q -W error
+      - run: python -m venv .venv-sdist
+      - run: .venv-sdist/bin/python -m pip install dist/*.tar.gz
+      - run: .venv-sdist/bin/python -m pip check
+      - run: .venv-sdist/bin/python -I tools/smoke_install.py

invariant_science-0.1.0/CHANGELOG.md

@@ -0,0 +1,74 @@
+# Changelog
+
+## Unreleased — final release audit
+
+- **Breaking preview migration:** replace the `invariant` import with
+  `invariant_science` and the `invariant` command with `invariant-science`.
+  Existing public packages own the old namespace and command. No compatibility
+  alias is installed. The distribution remains `invariant-science`, version
+  `0.1.0` (unpublished). See `docs/NAMESPACE_MIGRATION.md`.
+- Preserve report schema version 1 and its `environment.invariant` version key.
+- Add independent residual and convergence properties, malformed metadata and
+  filesystem error regressions; run coverage and type checking in CI.
+- Record final release gates, evidence, and remaining limitations.
+
+## Unreleased — first public release preparation
+
+- Add a five-minute quickstart, pytest regression examples, a copyable
+  GitHub Actions workflow, and a generated PASS and FAIL showcase.
+- Add Python 3.11 and 3.12 to the package and CI matrix. Use NumPy 2.3.4
+  as the minimum on Python 3.14 and keep NumPy 2.1 on Python 3.11–3.13.
+- Add CLI help and early report path validation. Identify the offending input
+  on file errors and print the first failing coordinate when available.
+- Use one version source for packaging, the Python API, CLI, and new reports.
+  Check wheel and sdist contents and smoke-test each installed artifact.
+
+## Unreleased — checks on existing computations
+
+- Add residual and observed convergence checks with explicit acceptance
+  criteria, standalone results, and JSON and HTML reporting.
+- Add the NumPy Poisson refinement case study with independent analytical
+  tests, pass and fail reports, and a reproducible overhead measurement.
+- Compare the verification workflow with NumPy testing, pytest, Hypothesis,
+  SciUnit and physverify in `docs/DIFFERENTIATION.md`.
+
+## Unreleased — scientific validation
+
+- Specify every supported check, tolerance semantics, numerical limitations,
+  status precedence and oscillator equations in `docs/SCIENTIFIC_VALIDATION.md`.
+- Reject boolean/text/masked/non-scalar tolerances and precision-losing tolerance
+  conversions; reject booleans hidden in numeric sequences. Non-finite singleton
+  conservation inputs now FAIL rather than being INCONCLUSIVE.
+- Add exact integer error magnitudes, worst-error locations, non-finite locations,
+  zero-reference/relative-overflow/relative-underflow counts and matrix assumptions.
+- Preserve report status precedence and add completion/status counts to all
+  formats, including explicit incomplete-verification messages.
+- Validate the oscillator against analytical solutions, discrete energy laws and
+  convergence order; check analytical velocity in both demonstrations. Physics
+  helpers now reject unsupported/non-finite/lossy inputs and overflowing outputs.
+- Add Hypothesis as a development dependency and rational/algebraic property
+  tests. Existing rounded floating-point boundary semantics remain explicit;
+  passing a tolerance check is not an exact real-arithmetic guarantee.
+
+## Unreleased — repository audit
+
+- Prevent false PASS from lossy large-integer coercion, masked inputs and empty
+  or invalid public report models; conservatively reject wider comparison dtypes.
+- Bound failure-coordinate and exact-integer temporary allocations.
+- Validate numeric NPY snapshots before construction, enforce configurable file
+  limits, bind hashes to loaded bytes and normalize input errors to CLI exit 2.
+- Reject complex real-valued parameters and avoid avoidable energy overflow.
+- Reject lossy JSON object keys; include evidence in HTML/Markdown reports.
+- Correct the setuptools minimum, ship scientific docs in sdists, and add
+  regression and artifact checks. See docs/AUDIT_REPORT.md for compatibility notes.
+
+## [0.1.0] — initial source preview (unpublished)
+
+- Typed numerical check results and report statuses.
+- Strict-shape comparisons with numerical diagnostics.
+- Finite, symmetric, Hermitian and conservation checks.
+- Atomic JSON, HTML and Markdown report exports.
+- Ideal oscillator Euler vs Verlet demonstration.
+- Command-line demo and `.npy` comparison.
+- Initial tests, CI workflow, contributor guidance.
+- Analytical reference check in demo, CI assertion helper and CLI input hashes.

invariant_science-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,7 @@
+# Community conduct
+
+Be welcoming and respectful. Critique ideas and evidence rather than people.
+Do not engage in harassment, threats, discrimination or sharing private data.
+Report concerns privately to the maintainers through a secure GitHub contact
+channel once configured. Maintainers may remove harmful content or restrict
+participation. A named responsible contact must be configured before launch.

invariant_science-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing to INVARIANT
+
+Start with the [five-minute quickstart](docs/QUICKSTART.md) and the
+[first contribution ideas](docs/FIRST_CONTRIBUTIONS.md). Search existing
+issues before opening one. Small documentation fixes and self-contained
+regressions can go straight to a pull request. Discuss new checks, API changes,
+or tolerance semantics in an issue first.
+
+## Set up the development environment
+
+Use Python 3.11–3.14. Create a virtual environment as shown in the
+[quickstart](docs/QUICKSTART.md), then run these commands from the source folder.
+
+```sh
+python -m pip install -e ".[dev]"
+python -m pytest -q -W error --cov=invariant_science --cov-branch --cov-report=term-missing
+python -m ruff check src tests examples tools
+python -m mypy src/invariant_science --check-untyped-defs
+```
+
+On Windows, you can use `.venv\Scripts\python.exe` in place of `python`.
+Run a focused file with `python -m pytest -q tests/test_checks.py`.
+
+- `src/invariant_science/` contains the checks, report models, exporters, and CLI.
+- `tests/` covers numerical contracts, input validation, and reports.
+- `examples/` contains standalone tutorials and the sample CI workflow.
+- `tools/build_showcase.py` rebuilds the offline showcase from CLI reports.
+
+## Submit a change
+
+1. Describe the observed behavior, expected result, and why the change is needed.
+2. For a scientific check, state the property, units, tolerance choice, and
+   assumptions. Include a PASS case and a case that fails for the intended
+   reason. Use an analytical or independent reference when possible.
+3. Add or update focused regression tests and documentation. Run the affected
+   examples and include the commands and results in the pull request.
+4. Keep runtime dependencies minimal and use synthetic or redistributable inputs.
+   Remove private data and secrets from reports before attaching them.
+
+For release checks, build into a fresh directory and inspect the artifacts.
+
+```sh
+python -m build --outdir dist
+python tools/check_distribution.py dist
+python -m twine check --strict dist/*
+```
+
+The [release checklist](docs/LAUNCH_PLAN.md#first-public-release-checklist)
+covers fresh installs, version checks, and publication prerequisites. See the
+[code of conduct](CODE_OF_CONDUCT.md) and [security policy](SECURITY.md).

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

invariant_science-0.1.0/MANIFEST.in

@@ -0,0 +1,9 @@
+include CHANGELOG.md CODE_OF_CONDUCT.md CONTRIBUTING.md SECURITY.md
+include .github/workflows/ci.yml
+recursive-include .github/ISSUE_TEMPLATE *.md
+recursive-include docs *.md
+recursive-include docs/assets *.svg
+recursive-include docs/poisson-reports *.html *.json
+recursive-include site *.html *.json
+recursive-include examples *.py *.yml
+recursive-include tools *.py