physverify 0.4.1__tar.gz → 0.5.0__tar.gz

physverify-0.5.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: physverify
+Version: 0.5.0
+Summary: Verification checks for physics simulation code: manufactured solutions, order-of-accuracy studies and a seeded-bug benchmark.
+Author: Ram Chandra Giri
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/rcgiri-physics/physverify
+Project-URL: Documentation, https://rcgiri-physics.github.io/physverify/
+Project-URL: Issues, https://github.com/rcgiri-physics/physverify/issues
+Project-URL: Changelog, https://github.com/rcgiri-physics/physverify/blob/main/CHANGELOG.md
+Keywords: verification,method of manufactured solutions,numerical methods,physics,simulation,testing
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Framework :: Pytest
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Education
+Classifier: Topic :: Software Development :: Testing
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.24
+Provides-Extra: symbolic
+Requires-Dist: sympy>=1.12; extra == "symbolic"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-cov>=6.1; extra == "dev"
+Requires-Dist: hypothesis>=6; extra == "dev"
+Requires-Dist: sympy>=1.12; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs<2,>=1.6; extra == "docs"
+Requires-Dist: mkdocs-material<10,>=9.5; extra == "docs"
+Dynamic: license-file
+
+# physverify
+
+[![tests](https://github.com/rcgiri-physics/physverify/actions/workflows/ci.yml/badge.svg)](https://github.com/rcgiri-physics/physverify/actions/workflows/ci.yml) [![PyPI](https://img.shields.io/pypi/v/physverify)](https://pypi.org/project/physverify/) [![Python](https://img.shields.io/pypi/pyversions/physverify)](https://pypi.org/project/physverify/) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.23534512.svg)](https://doi.org/10.5281/zenodo.23534512) [![Docs](https://img.shields.io/badge/docs-site-blue)](https://rcgiri-physics.github.io/physverify/)
+
+**Checks that a simulation solves the equations it claims, at the order of accuracy it claims, not just that it runs.**
+
+physverify is actively evolving (v0.5.0), welcoming contributions and test cases from the computational physics community. Scope: numerical solutions of ODEs and PDEs (time integration, convergence, conservation), plus a few Monte Carlo checks. It needs only NumPy.
+
+![The check loop: your solver and an independent description of the physics go in; physverify runs the solver at several resolutions, measures the error and reports a verdict with a reason](https://raw.githubusercontent.com/rcgiri-physics/physverify/main/docs/images/check-loop.svg)
+
+```bash
+pip install physverify
+physverify demo
+```
+
+The demo checks a correct solver (all checks pass), then the same solver with the damping 10% too large (all fail):
+
+![Error against step size: the correct solver follows the slope-2 line, the broken one levels off](https://raw.githubusercontent.com/rcgiri-physics/physverify/main/docs/images/convergence.svg)
+
+New to this? [Start here](https://rcgiri-physics.github.io/physverify/start-here/) walks through installation and a first check in about ten minutes, with a prompt to paste if you use an AI coding assistant.
+
+## Use it on your own code
+
+- **Any project, no set-up:** `physverify scan PATH` reads the code (it runs nothing) and flags Runge-Kutta methods that do not have their stated order (written as tables, as class attributes or as stages in code), grid spacings that do not match their grid, near-miss physical constants, and inverse function pairs worth a round-trip test.
+- **An ODE solver:** `physverify init verify_solver.py --solver mysolver --order 4` writes a spec; fill in the equations (from the physics, not from your code) and run `physverify run verify_solver.py`.
+- **A Runge-Kutta table:** `check_tableau(A, b, c, claimed=3)` from `physverify.butcher` checks its order, stage order and stability from the coefficients alone.
+- **Errors you already have:** `check_order(hs, errors, expected=2)` gives PASS, FAIL or INCONCLUSIVE with a reason.
+
+## Run it in CI
+
+A failed check fails the job, like a broken unit test ([CI guide](https://rcgiri-physics.github.io/physverify/ci/): options, pre-commit, pytest):
+
+```yaml
+      - uses: rcgiri-physics/physverify@v0.5.0
+        with:
+          specs: tests/verify_*.py
+```
+
+[Getting started](https://rcgiri-physics.github.io/physverify/getting-started/) · [Recipes](https://rcgiri-physics.github.io/physverify/recipes/) · [What a PASS means](https://rcgiri-physics.github.io/physverify/assumptions/) · [Troubleshooting](https://rcgiri-physics.github.io/physverify/troubleshooting/) · [API](https://rcgiri-physics.github.io/physverify/api/)
+
+## Does it catch bugs?
+
+Of 37 bugs seeded into five small solvers, it flagged 35 (plain "compare with one answer" tests: 27), with no false alarms. The bugs and checks were written by the same person, so this shows the tool works as designed, not how it does on other people's code. On public physics repositories, 74 defects were reported to authors; 14 of them were found by a physverify check as such, 11 by simply running the code, and the rest by the per-repository test scripts or by reading the code. `physverify scan` alone, with no script, now finds 18 of the 74, up from 2 in its first version, and found 7 new defects in the same repositories ([which found what](https://github.com/rcgiri-physics/physverify/blob/main/results/corpus/FINDINGS_BY_METHOD.md)). The counts describe that sample only and are not a bug rate. Details: [results](https://rcgiri-physics.github.io/physverify/results/), and [results/README.md](https://github.com/rcgiri-physics/physverify/blob/main/results/README.md) to regenerate every table.
+
+## Limits
+
+Works best for ODEs; PDEs only in 1D so far. Your code needs a way to add a source term, or a small wrapper that can itself be wrong. A PASS means these checks found nothing wrong; it does not prove the simulation correct, and it is only as independent as the reference you wrote: see [What a PASS means](https://rcgiri-physics.github.io/physverify/assumptions/).
+
+## Contributing, citing, licence
+
+Help is welcome: a trial report on your own solver, seeded bugs written by someone other than the author, adapters, documentation. See [CONTRIBUTING.md](https://github.com/rcgiri-physics/physverify/blob/main/CONTRIBUTING.md), the [code of conduct](https://github.com/rcgiri-physics/physverify/blob/main/CODE_OF_CONDUCT.md), [SUPPORT.md](https://github.com/rcgiri-physics/physverify/blob/main/SUPPORT.md) for help, [SECURITY.md](https://github.com/rcgiri-physics/physverify/blob/main/SECURITY.md) on running untrusted code, and [AGENTS.md](https://github.com/rcgiri-physics/physverify/blob/main/AGENTS.md) for AI assistants. To cite, use [doi:10.5281/zenodo.23534512](https://doi.org/10.5281/zenodo.23534512) or [CITATION.cff](https://github.com/rcgiri-physics/physverify/blob/main/CITATION.cff). Changes: [CHANGELOG.md](https://github.com/rcgiri-physics/physverify/blob/main/CHANGELOG.md); plans: [ROADMAP.md](https://github.com/rcgiri-physics/physverify/blob/main/ROADMAP.md). MIT licence, copyright (c) 2026 Ram Chandra Giri.

physverify-0.5.0/README.md

@@ -0,0 +1,51 @@
+# physverify
+
+[![tests](https://github.com/rcgiri-physics/physverify/actions/workflows/ci.yml/badge.svg)](https://github.com/rcgiri-physics/physverify/actions/workflows/ci.yml) [![PyPI](https://img.shields.io/pypi/v/physverify)](https://pypi.org/project/physverify/) [![Python](https://img.shields.io/pypi/pyversions/physverify)](https://pypi.org/project/physverify/) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.23534512.svg)](https://doi.org/10.5281/zenodo.23534512) [![Docs](https://img.shields.io/badge/docs-site-blue)](https://rcgiri-physics.github.io/physverify/)
+
+**Checks that a simulation solves the equations it claims, at the order of accuracy it claims, not just that it runs.**
+
+physverify is actively evolving (v0.5.0), welcoming contributions and test cases from the computational physics community. Scope: numerical solutions of ODEs and PDEs (time integration, convergence, conservation), plus a few Monte Carlo checks. It needs only NumPy.
+
+![The check loop: your solver and an independent description of the physics go in; physverify runs the solver at several resolutions, measures the error and reports a verdict with a reason](https://raw.githubusercontent.com/rcgiri-physics/physverify/main/docs/images/check-loop.svg)
+
+```bash
+pip install physverify
+physverify demo
+```
+
+The demo checks a correct solver (all checks pass), then the same solver with the damping 10% too large (all fail):
+
+![Error against step size: the correct solver follows the slope-2 line, the broken one levels off](https://raw.githubusercontent.com/rcgiri-physics/physverify/main/docs/images/convergence.svg)
+
+New to this? [Start here](https://rcgiri-physics.github.io/physverify/start-here/) walks through installation and a first check in about ten minutes, with a prompt to paste if you use an AI coding assistant.
+
+## Use it on your own code
+
+- **Any project, no set-up:** `physverify scan PATH` reads the code (it runs nothing) and flags Runge-Kutta methods that do not have their stated order (written as tables, as class attributes or as stages in code), grid spacings that do not match their grid, near-miss physical constants, and inverse function pairs worth a round-trip test.
+- **An ODE solver:** `physverify init verify_solver.py --solver mysolver --order 4` writes a spec; fill in the equations (from the physics, not from your code) and run `physverify run verify_solver.py`.
+- **A Runge-Kutta table:** `check_tableau(A, b, c, claimed=3)` from `physverify.butcher` checks its order, stage order and stability from the coefficients alone.
+- **Errors you already have:** `check_order(hs, errors, expected=2)` gives PASS, FAIL or INCONCLUSIVE with a reason.
+
+## Run it in CI
+
+A failed check fails the job, like a broken unit test ([CI guide](https://rcgiri-physics.github.io/physverify/ci/): options, pre-commit, pytest):
+
+```yaml
+      - uses: rcgiri-physics/physverify@v0.5.0
+        with:
+          specs: tests/verify_*.py
+```
+
+[Getting started](https://rcgiri-physics.github.io/physverify/getting-started/) · [Recipes](https://rcgiri-physics.github.io/physverify/recipes/) · [What a PASS means](https://rcgiri-physics.github.io/physverify/assumptions/) · [Troubleshooting](https://rcgiri-physics.github.io/physverify/troubleshooting/) · [API](https://rcgiri-physics.github.io/physverify/api/)
+
+## Does it catch bugs?
+
+Of 37 bugs seeded into five small solvers, it flagged 35 (plain "compare with one answer" tests: 27), with no false alarms. The bugs and checks were written by the same person, so this shows the tool works as designed, not how it does on other people's code. On public physics repositories, 74 defects were reported to authors; 14 of them were found by a physverify check as such, 11 by simply running the code, and the rest by the per-repository test scripts or by reading the code. `physverify scan` alone, with no script, now finds 18 of the 74, up from 2 in its first version, and found 7 new defects in the same repositories ([which found what](https://github.com/rcgiri-physics/physverify/blob/main/results/corpus/FINDINGS_BY_METHOD.md)). The counts describe that sample only and are not a bug rate. Details: [results](https://rcgiri-physics.github.io/physverify/results/), and [results/README.md](https://github.com/rcgiri-physics/physverify/blob/main/results/README.md) to regenerate every table.
+
+## Limits
+
+Works best for ODEs; PDEs only in 1D so far. Your code needs a way to add a source term, or a small wrapper that can itself be wrong. A PASS means these checks found nothing wrong; it does not prove the simulation correct, and it is only as independent as the reference you wrote: see [What a PASS means](https://rcgiri-physics.github.io/physverify/assumptions/).
+
+## Contributing, citing, licence
+
+Help is welcome: a trial report on your own solver, seeded bugs written by someone other than the author, adapters, documentation. See [CONTRIBUTING.md](https://github.com/rcgiri-physics/physverify/blob/main/CONTRIBUTING.md), the [code of conduct](https://github.com/rcgiri-physics/physverify/blob/main/CODE_OF_CONDUCT.md), [SUPPORT.md](https://github.com/rcgiri-physics/physverify/blob/main/SUPPORT.md) for help, [SECURITY.md](https://github.com/rcgiri-physics/physverify/blob/main/SECURITY.md) on running untrusted code, and [AGENTS.md](https://github.com/rcgiri-physics/physverify/blob/main/AGENTS.md) for AI assistants. To cite, use [doi:10.5281/zenodo.23534512](https://doi.org/10.5281/zenodo.23534512) or [CITATION.cff](https://github.com/rcgiri-physics/physverify/blob/main/CITATION.cff). Changes: [CHANGELOG.md](https://github.com/rcgiri-physics/physverify/blob/main/CHANGELOG.md); plans: [ROADMAP.md](https://github.com/rcgiri-physics/physverify/blob/main/ROADMAP.md). MIT licence, copyright (c) 2026 Ram Chandra Giri.

{physverify-0.4.1 → physverify-0.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "physverify"
-version = "0.4.1"
+version = "0.5.0"
 description = "Verification checks for physics simulation code: manufactured solutions, order-of-accuracy studies and a seeded-bug benchmark."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -32,13 +32,14 @@ dependencies = ["numpy>=1.24"]
 
 [project.urls]
 Homepage = "https://github.com/rcgiri-physics/physverify"
-Documentation = "https://github.com/rcgiri-physics/physverify/blob/main/docs/technical.md"
+Documentation = "https://rcgiri-physics.github.io/physverify/"
 Issues = "https://github.com/rcgiri-physics/physverify/issues"
 Changelog = "https://github.com/rcgiri-physics/physverify/blob/main/CHANGELOG.md"
 
 [project.optional-dependencies]
 symbolic = ["sympy>=1.12"]
-dev = ["pytest>=8", "hypothesis>=6", "sympy>=1.12"]
+dev = ["pytest>=8", "pytest-cov>=6.1", "hypothesis>=6", "sympy>=1.12"]
+docs = ["mkdocs>=1.6,<2", "mkdocs-material>=9.5,<10"]
 
 [project.scripts]
 physverify = "physverify.cli:main"
@@ -51,4 +52,4 @@ where = ["src"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]
-pythonpath = ["src"]
+pythonpath = ["src", "benchmark"]

{physverify-0.4.1 → physverify-0.5.0}/src/physverify/__init__.py

@@ -6,7 +6,7 @@ from .order import check_order, fit_order, pairwise_orders
 from .order import check_exact
 from .studies import invariant_study, ode_checks, patch_study, reference_study
 
-__version__ = "0.4.1"
+__version__ = "0.5.0"
 
 __all__ = [
     "Check",

{physverify-0.4.1 → physverify-0.5.0}/src/physverify/checks.py

@@ -42,6 +42,7 @@ class OrderResult(Result):
     fitted: float = float("nan")
     hs: tuple = ()
     errors: tuple = ()
+    acceptance: str = ""  # the rule a PASS had to meet, in words (reported in the JSON output)
 
 
 @dataclass

{physverify-0.4.1 → physverify-0.5.0}/src/physverify/cli.py

@@ -1,9 +1,10 @@
 """Command line.
 
     physverify run SPEC.py [SPEC.py ...] [--json FILE|-] [--html FILE] [--markdown FILE] [--quiet]
+    physverify demo        (a correct and a broken solver, no files needed)
     physverify init [SPEC.py] [--solver MODULE] [--function NAME] [--dim N] [--order P]
-    physverify matrix [OUT.md]
-    physverify compare [OUT.md]
+    physverify scan PATH   (reads the source, runs nothing: constants, RK tables, grid spacing, inverse pairs,
+                           undefined names, removed APIs, typo-like literals, unit tables)
     physverify hook        (Claude Code PostToolUse hook; see docs/agent.md)
     physverify mcp         (MCP server on stdio; see docs/agent.md)
 
@@ -42,7 +43,7 @@ def expand_specs(patterns) -> list[str]:
 
 
 def _cmd_run(args) -> int:
-    from .report import load_spec, run_checks, to_html, to_json, to_markdown, to_text
+    from .report import NOTE, load_spec, run_checks, to_html, to_json, to_markdown, to_text
 
     try:
         args.specs = expand_specs(args.specs)
@@ -56,6 +57,9 @@ def _cmd_run(args) -> int:
         except Exception as exc:
             print(f"physverify: cannot load {spec}: {type(exc).__name__}: {exc}", file=sys.stderr)
             return 2
+        if not checks:
+            print(f"physverify: {spec}: checks() returned no checks, so nothing was tested", file=sys.stderr)
+            return 2
         outcomes += run_checks(checks, args.budget)
     source = ", ".join(str(Path(s)) for s in args.specs)
     if args.json == "-":
@@ -63,6 +67,7 @@ def _cmd_run(args) -> int:
     else:
         if not args.quiet:
             print(to_text(outcomes))
+            print(NOTE)
         if args.json:
             Path(args.json).write_text(to_json(outcomes, source), encoding="utf-8")
     if args.html:
@@ -87,16 +92,10 @@ def _cmd_init(args) -> int:
     return 0
 
 
-def _cmd_matrix(args) -> int:
-    from . import matrix
-
-    return matrix.main([args.out] if args.out else [])
-
-
-def _cmd_compare(args) -> int:
-    from . import compare
+def _cmd_demo(args) -> int:
+    from .demo import main as demo_main
 
-    return compare.main([args.out] if args.out else [])
+    return demo_main()
 
 
 def _cmd_hook(args) -> int:
@@ -123,6 +122,37 @@ def _cmd_smoke(args) -> int:
     return 1 if bad else 0
 
 
+def _cmd_scan(args) -> int:
+    import json
+
+    from .scan import STAGES, WARN, scan, to_dict
+
+    stages = args.only.split(",") if args.only else STAGES
+    unknown = set(stages) - set(STAGES)
+    if unknown:
+        print(f"physverify: unknown stage {', '.join(sorted(unknown))}; choose from {', '.join(STAGES)}", file=sys.stderr)
+        return 2
+    if not Path(args.path).exists():
+        print(f"physverify: {args.path} does not exist", file=sys.stderr)
+        return 2
+    findings, unparsed = scan(args.path, stages=stages)
+    if args.json:
+        text = json.dumps(to_dict(findings, unparsed), indent=1)
+        if args.json == "-":
+            print(text)
+        else:
+            Path(args.json).write_text(text, encoding="utf-8")
+    if args.json != "-":
+        for f in findings:
+            print(f)
+        for u in unparsed:
+            print(f"NOTE parse     {u}")
+        warn = sum(f.level == WARN for f in findings)
+        print(f"{warn} warnings, {len(findings) - warn} notes, {len(unparsed)} files not parsed"
+              " (the scan reads the code and runs nothing; a clean scan means only that these patterns were not found)")
+    return 1 if any(f.level == WARN for f in findings) else 0
+
+
 def _cmd_references(args) -> int:
     from . import references
 
@@ -149,6 +179,9 @@ def build_parser() -> argparse.ArgumentParser:
                           " and a check still running at twice the budget is reported INCONCLUSIVE")
     run.set_defaults(func=_cmd_run)
 
+    d = sub.add_parser("demo", help="run the checks on a correct and on a broken example solver (no files needed)")
+    d.set_defaults(func=_cmd_demo)
+
     i = sub.add_parser("init", help="write a starter spec for a fixed-step ODE solver")
     i.add_argument("spec", nargs="?", default="verify_solver.py", help="spec file to write (default verify_solver.py)")
     i.add_argument("--solver", default="solver", help="module that holds the solver, importable from the spec's folder (default solver)")
@@ -159,14 +192,6 @@ def build_parser() -> argparse.ArgumentParser:
     i.add_argument("--force", action="store_true", help="overwrite an existing file")
     i.set_defaults(func=_cmd_init)
 
-    m = sub.add_parser("matrix", help="run the seeded-bug benchmark")
-    m.add_argument("out", nargs="?", help="also write the tables next to this Markdown file")
-    m.set_defaults(func=_cmd_matrix)
-
-    c = sub.add_parser("compare", help="compare the families with plain tests on the seeded bugs")
-    c.add_argument("out", nargs="?", help="also write the table to this Markdown file")
-    c.set_defaults(func=_cmd_compare)
-
     h = sub.add_parser("hook", help="Claude Code PostToolUse hook: reads the event on stdin, exits 2 on a failed check")
     h.set_defaults(func=_cmd_hook)
 
@@ -175,6 +200,12 @@ def build_parser() -> argparse.ArgumentParser:
     sm.add_argument("--timeout", type=float, default=60.0, help="seconds per script (default 60)")
     sm.set_defaults(func=_cmd_smoke)
 
+    sc = sub.add_parser("scan", help="look for common defects without a spec file; reads the code and runs nothing")
+    sc.add_argument("path", help="a Python file or a folder")
+    sc.add_argument("--only", metavar="STAGES", help="comma-separated stages: constants,tables,grid,pairs,names,api,literals,units (default all)")
+    sc.add_argument("--json", metavar="FILE", help="write findings as JSON to FILE, or to stdout with -")
+    sc.set_defaults(func=_cmd_scan)
+
     r = sub.add_parser("references", help="list the exact reference solutions in physverify.references")
     r.set_defaults(func=_cmd_references)
 

{physverify-0.4.1 → physverify-0.5.0}/src/physverify/constants.py

@@ -34,6 +34,23 @@ KNOWN = {
     "m_p": ((1.67262192369e-27, 1.67262192595e-27), "kg", "CODATA 2018: 1.67262192369e-27, 2022: 1.67262192595e-27"),
     "epsilon_0": ((8.8541878128e-12,), "F/m", "8.8541878128e-12"),
     "T_c (2D Ising)": ((2 / math.log(1 + math.sqrt(2)),), "J/k_B", "2 / ln(1 + sqrt 2) = 2.269185314"),
+    # exact by definition (SI 2019, IAU 2012, international units)
+    "N_A": ((6.02214076e23,), "1/mol", "exact: 6.02214076e23"),
+    "R (gas constant)": ((8.314462618,), "J/(mol K)", "N_A k_B = 8.314462618..."),
+    "sigma (Stefan-Boltzmann)": ((5.670374419e-8,), "W m^-2 K^-4", "5.670374419e-8"),
+    "astronomical unit": ((149597870700.0, 149597870.7, 1.495978707e13), "m, km or cm", "exact: 149597870700 m (IAU 2012)"),
+    "light year": ((9460730472580800.0,), "m", "exact: 9460730472580800 m (Julian year)"),
+    "parsec": ((3.0856775814913673e16,), "m", "648000/pi au = 3.0856775814913673e16 m"),
+    "standard atmosphere": ((101325.0,), "Pa", "exact: 101325 Pa"),
+    "torr": ((101325 / 760,), "Pa", "exact: 101325/760 = 133.32236842 Pa (mmHg is 133.322387415 Pa)"),
+    "nautical mile": ((1852.0,), "m", "exact: 1852 m"),
+    # the same constants in CGS, so a CGS block can be compared with an SI one
+    "h (CGS)": ((6.62607015e-27,), "erg s", "exact: 6.62607015e-27"),
+    "k_B (CGS)": ((1.380649e-16,), "erg/K", "exact: 1.380649e-16"),
+    "c (CGS)": ((2.99792458e10,), "cm/s", "exact: 2.99792458e10"),
+    "e (esu)": ((4.803204712570263e-10,), "statC", "4.803204712570263e-10"),
+    "m_e (g)": ((9.1093837015e-28, 9.1093837139e-28), "g", "CODATA 2018: 9.1093837015e-28, 2022: 9.1093837139e-28"),
+    "G (CGS)": ((6.67430e-8, 6.674e-8), "cm^3 g^-1 s^-2", "CODATA 2018: 6.67430e-8"),
 }
 
 

physverify-0.5.0/src/physverify/demo.py

@@ -0,0 +1,75 @@
+"""`physverify demo`: the damped-oscillator example, shipped in the package.
+
+It runs the checks on a correct midpoint solver, then on a copy whose damping
+is 10% too large, so a first run needs only `pip install physverify`.
+The same solver and spec, as files to copy, are in examples/ in the repository.
+"""
+
+from __future__ import annotations
+
+import numpy as np
+
+from .studies import ode_checks
+from .mms import ManufacturedODE
+
+OMEGA, GAMMA = 3.0, 0.4
+
+
+def make_solver(damping_factor: float = 1.0):
+    """Midpoint method for x'' = -omega^2 x - 2 gamma x', with an additive source term."""
+
+    def rhs(t, y):
+        damping = 2.0 * GAMMA * damping_factor
+        return np.array([y[1], -(OMEGA**2) * y[0] - damping * y[1]])
+
+    def integrate(source, y0, t_end, n_steps, trajectory=False):
+        h = t_end / n_steps
+        y = np.array(y0, dtype=float)
+        states = [y]
+        for i in range(n_steps):
+            t = i * h
+            k1 = rhs(t, y) + source(t)
+            mid = y + 0.5 * h * k1
+            y = y + h * (rhs(t + 0.5 * h, mid) + source(t + 0.5 * h))
+            states.append(y)
+        return np.array(states) if trajectory else y
+
+    return integrate
+
+
+def reference_rhs(t, y):
+    """The equations, written from the physics, not copied from the solver."""
+    return np.array([y[1], -(OMEGA**2) * y[0] - 2.0 * GAMMA * y[1]])
+
+
+def checks(damping_factor: float = 1.0):
+    integrate = make_solver(damping_factor)
+    mms = ManufacturedODE(lambda t: np.array([np.sin(1.3 * t) + 0.2, 1.04 * np.cos(1.3 * t)]), reference_rhs)
+    return ode_checks(
+        "midpoint damped oscillator",
+        integrate,
+        rhs_ref=reference_rhs,
+        mms=mms,
+        y0_free=np.array([1.0, 0.0]),
+        t_end=1.0,
+        ns=(10, 20, 40, 80, 160),
+        order=2.0,
+        patch=(np.array([0.5, -0.3]), np.array([0.8, 1.1])),
+        integrate_trajectory=lambda s, y0, t, n: integrate(s, y0, t, n, trajectory=True),
+    )
+
+
+def main() -> int:
+    """Exit 0 when the correct solver passes and the broken one fails, as they should."""
+    from .report import NOTE, run_checks, to_text
+
+    print("1. A correct midpoint solver for a damped oscillator:\n")
+    good = run_checks(checks())
+    print(to_text(good))
+    print("\n2. The same solver with the damping 10% too large (a typical slip):\n")
+    bad = run_checks(checks(damping_factor=1.1))
+    print(to_text(bad))
+    ok = not any(o.result.failed for o in good) and any(o.result.failed for o in bad)
+    print(f"\n{NOTE}")
+    print("\nTo check your own solver, start a spec with:  physverify init verify_solver.py --solver mysolver --order 2")
+    return 0 if ok else 1

physverify-0.5.0/src/physverify/identities.py

@@ -0,0 +1,157 @@
+"""Checks that need no exact solution: round trips, derivatives, sibling agreement and identities.
+
+These are the checks that found most of the bugs in the batch-8 corpus study (popular libraries):
+two functions that should agree but do not (an air-absorption term with the opposite sign in one
+of two reverberation formulas), an operation that should be undone by its inverse but is not
+(a zero-time rotation that shifts an image by half a pixel), an analytic derivative compared with
+finite differences, and textbook identities (Poisson's equation, unitarity, conservation).
+
+Each function returns a `Result` (PASS or FAIL with the worst case in the message); wrap it in a
+`Check("limit", label, lambda: ...)` to run it with the others. Values may be real or complex scalars
+or arrays. The reference side must come from the physics, not from the code under test: a round trip
+or a sibling comparison can pass when both sides share the same mistake.
+"""
+
+from __future__ import annotations
+
+from typing import Callable, Iterable
+
+import numpy as np
+
+from .checks import FAIL, PASS, Result
+
+
+def _worst(got, ref, rtol: float, atol: float):
+    """Largest violation of |got - ref| <= atol + rtol |ref|, as (excess, abs error, where)."""
+    g = np.asarray(got)
+    r = np.asarray(ref)
+    if g.shape != r.shape:
+        try:
+            g, r = np.broadcast_arrays(g, r)
+        except ValueError:
+            raise ValueError(f"shapes differ: got {np.shape(got)}, reference {np.shape(ref)}") from None
+    err = np.abs(g - r)
+    tol = atol + rtol * np.abs(r)
+    excess = err - tol
+    if excess.size == 0:
+        return -np.inf, 0.0, ()
+    if not np.all(np.isfinite(err)):
+        i = np.unravel_index(int(np.argmax(~np.isfinite(err))), err.shape)
+        return np.inf, np.inf, i
+    i = np.unravel_index(int(np.argmax(excess)), excess.shape)
+    return float(excess[i]), float(err[i]), i
+
+
+def _verdict(what: str, cases, rtol: float, atol: float) -> Result:
+    """cases: iterable of (label, got, ref). PASS when every case is within tolerance."""
+    worst = None
+    n = 0
+    for label, got, ref in cases:
+        n += 1
+        excess, err, where = _worst(got, ref, rtol, atol)
+        if worst is None or excess > worst[0]:
+            worst = (excess, err, label, where, got, ref)
+    if worst is None:
+        raise ValueError(f"{what}: no inputs given")
+    excess, err, label, where, got, ref = worst
+    at = f" at index {tuple(int(k) for k in where)}" if where else ""
+    detail = f"worst case {label}{at}: |difference| = {err:.3g} (rtol {rtol:g}, atol {atol:g})"
+    if excess <= 0:
+        return Result(PASS, f"{what}: {n} case{'s' if n != 1 else ''} within tolerance; {detail}")
+    g = np.asarray(got)[where] if where else got
+    r = np.asarray(ref)[where] if where else ref
+    return Result(FAIL, f"{what}: {detail}; got {g!r}, expected {r!r}")
+
+
+def check_roundtrip(forward: Callable, inverse: Callable, inputs: Iterable, *, rtol: float = 1e-9, atol: float = 0.0) -> Result:
+    """inverse(forward(x)) == x for every x in `inputs`.
+
+    Catches conversions that disagree with their own inverse: a reference pixel off by half a pixel,
+    a dewpoint formula that does not invert the saturation formula, a unit conversion with the wrong
+    constant on one side. Both functions come from the code under test, so a PASS says only that
+    they are consistent, not that either is right.
+    """
+    cases = []
+    for x in inputs:
+        cases.append((repr(x) if np.ndim(x) == 0 else f"input of shape {np.shape(x)}", inverse(forward(x)), x))
+    return _verdict("round trip inverse(forward(x)) = x", cases, rtol, atol)
+
+
+def check_agree(a: Callable, b: Callable, inputs: Iterable, *, rtol: float = 1e-9, atol: float = 0.0,
+                names: tuple[str, str] = ("a", "b")) -> Result:
+    """Two implementations that must give the same answer do: a(*x) == b(*x) for each x in `inputs`.
+
+    Use it for sibling code paths (a 2D and a 3D version, a fast path and a slow path, the `min` and
+    `max` variants, two formulas that coincide in a limit). Each element of `inputs` is a tuple of
+    arguments, or a single argument.
+    """
+    cases = []
+    for x in inputs:
+        args = x if isinstance(x, tuple) else (x,)
+        cases.append((repr(x), a(*args), b(*args)))
+    return _verdict(f"{names[0]} agrees with {names[1]}", cases, rtol, atol)
+
+
+def fd_derivative(f: Callable, x, *, h: float | None = None, order: int = 1):
+    """Central finite-difference derivative of f at x (scalar x), with one Richardson step.
+
+    `order` is 1 or 2 (first or second derivative). The default step is cbrt(machine epsilon) times
+    max(1, |x|) for the first derivative and its square root for the second; the Richardson step
+    combines h and h/2 to cancel the leading error term.
+    """
+    x = float(x)
+    if order == 1:
+        h = h or np.cbrt(np.finfo(float).eps) * max(1.0, abs(x))
+        d = lambda s: (np.asarray(f(x + s)) - np.asarray(f(x - s))) / (2 * s)  # noqa: E731
+    elif order == 2:
+        h = h or np.finfo(float).eps ** 0.25 * max(1.0, abs(x))
+        d = lambda s: (np.asarray(f(x + s)) - 2 * np.asarray(f(x)) + np.asarray(f(x - s))) / (s * s)  # noqa: E731
+    else:
+        raise ValueError("order must be 1 or 2")
+    return (4 * d(h / 2) - d(h)) / 3
+
+
+def check_derivative(f: Callable, df: Callable, points: Iterable, *, order: int = 1, h: float | None = None,
+                     rtol: float = 1e-6, atol: float = 1e-10) -> Result:
+    """An analytic derivative `df` agrees with a finite-difference derivative of `f` at each point.
+
+    This is how a thermodynamic-consistency claim is settled cheaply: a reader's derivation said an
+    activity-coefficient derivative dropped a term, and comparing it with finite differences of the
+    activity coefficients themselves showed agreement to 1e-10, so the claim was wrong. The default
+    tolerance allows for the finite-difference error; tighten it only with a well-scaled `h`.
+    """
+    cases = [(f"x = {p!r}", df(p), fd_derivative(f, p, h=h, order=order)) for p in points]
+    return _verdict(f"{'first' if order == 1 else 'second'} derivative agrees with finite differences", cases, rtol, atol)
+
+
+def check_identity(cases: Iterable, *, rtol: float = 1e-9, atol: float = 0.0, what: str = "identity") -> Result:
+    """Each (label, lhs, rhs) in `cases` satisfies lhs == rhs.
+
+    For identities written from the physics: Poisson's equation (Laplacian of the potential equals
+    4 pi G rho), unitarity of a lossless scattering matrix (S^H S = I), E^2 = p^2 + m^2, a limit that
+    must reproduce a simpler formula. Compute the right-hand side yourself, not with the code under test.
+    """
+    return _verdict(what, list(cases), rtol, atol)
+
+
+def laplacian_fd(f: Callable, point, *, h: float = 1e-3):
+    """Cartesian Laplacian of a scalar field f(x) (x a 1D array) by second-order central differences."""
+    x = np.asarray(point, dtype=float)
+    f0 = f(x)
+    total = 0.0
+    for k in range(x.size):
+        e = np.zeros_like(x)
+        e[k] = h
+        total = total + (f(x + e) - 2 * f0 + f(x - e)) / (h * h)
+    return total
+
+
+def check_unitary(matrix, *, atol: float = 1e-10) -> Result:
+    """A matrix (or a stack of matrices, last two axes) is unitary: M^H M = I.
+
+    A lossless network's scattering matrix, a time-evolution operator, a rotation.
+    """
+    m = np.asarray(matrix)
+    eye = np.eye(m.shape[-1])
+    prod = np.einsum("...ji,...jk->...ik", m.conj(), m)
+    return _verdict("unitarity M^H M = I", [("matrix", prod, np.broadcast_to(eye, prod.shape))], 0.0, atol)