nickh007 commited on
Commit
097c93d
·
verified ·
1 Parent(s): 5d58d31

Sync from source tree: verify.py first-command docs + measured test badge

Browse files
Files changed (1) hide show
  1. README.md +44 -13
README.md CHANGED
@@ -21,7 +21,7 @@ configs:
21
 
22
  # sparam-conformance
23
 
24
- ![CI](https://github.com/nickharris808/sparam-conformance/actions/workflows/ci.yml/badge.svg) ![Licence](https://img.shields.io/badge/data-CC--BY--4.0-green) ![Cases](https://img.shields.io/badge/cases-11%20labelled-blue) ![Tests](https://img.shields.io/badge/tests-57%20passing-brightgreen)
25
 
26
  📖 **[Documentation site](https://nickharris808.github.io/physics-lint/)** — the portfolio narrative, the concepts, a full walkthrough, and what all of this proves (and does not).
27
 
@@ -43,10 +43,41 @@ opinion. We know `active_gain` is non-passive because we built 3× gain into it.
43
  ```bash
44
  git clone https://github.com/nickharris808/sparam-conformance.git && cd sparam-conformance
45
 
 
46
  python score.py --checker mypackage.mychecker:run # grade your checker
47
  python generate.py # optional: rebuild the corpus
48
  ```
49
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
50
  The corpus is committed, so scoring needs nothing installed beyond your own
51
  checker. `generate.py` is only needed if you want to prove the files came from
52
  the generator — it rebuilds them byte-identically, and CI checks that it does.
@@ -154,19 +185,19 @@ asymmetry for reciprocity, row power for energy. A corpus whose ground truth is
154
  wrong is worse than no corpus, because every checker scored against it inherits
155
  the error.
156
 
157
- That check earned its place: it caught **three wrong labels** during development.
158
- The "passive" resonator had σ_max = 1.2441 and was not passive at all; a case
159
- meant to isolate energy was also non-reciprocal; and `negative_resistance`
160
- unavoidably breaks energy conservation too, which the original label denied.
161
-
162
- That 1.2441 is the one figure on this page you cannot reproduce from the
163
- committed corpus — it belonged to a superseded generator revision, and the
164
- resonator that ships today has σ_max ≤ 1, which the test suite asserts. It is
165
- recorded because "we found bugs in our own ground truth" is worth more with a
166
- number attached than without one.
167
-
168
  Generation is deterministic, files are SHA-256 pinned in the manifest, and both
169
- properties are tested.
 
 
 
 
 
 
 
 
 
 
 
170
 
171
  ## Scope, honestly
172
 
 
21
 
22
  # sparam-conformance
23
 
24
+ ![CI](https://github.com/nickharris808/sparam-conformance/actions/workflows/ci.yml/badge.svg) ![Licence](https://img.shields.io/badge/data-CC--BY--4.0-green) ![Cases](https://img.shields.io/badge/cases-11%20labelled-blue) ![Tests](https://img.shields.io/badge/tests-61%20collected-brightgreen)
25
 
26
  📖 **[Documentation site](https://nickharris808.github.io/physics-lint/)** — the portfolio narrative, the concepts, a full walkthrough, and what all of this proves (and does not).
27
 
 
43
  ```bash
44
  git clone https://github.com/nickharris808/sparam-conformance.git && cd sparam-conformance
45
 
46
+ python3 verify.py # check what you downloaded
47
  python score.py --checker mypackage.mychecker:run # grade your checker
48
  python generate.py # optional: rebuild the corpus
49
  ```
50
 
51
+ `verify.py` is the one command that works before you have anything else. It uses
52
+ only the standard library — no install, no dependencies, nothing from the
53
+ repository that produced the corpus:
54
+
55
+ ```
56
+ $ python3 verify.py
57
+ sparam-conformance corpus verification (stdlib only)
58
+
59
+ cases 11
60
+ physically valid 7
61
+ physically invalid 4
62
+ laws 5
63
+ sha256 matched 11/11
64
+
65
+ self-consistent: every file matches its recorded digest, and every
66
+ label agrees with itself
67
+
68
+ scope: internal consistency only. The digests ship in this download,
69
+ so this detects corruption, not substitution. It does not re-derive
70
+ the physics -- run score.py against a checker for that.
71
+ ```
72
+
73
+ It verifies that every file matches the SHA-256 recorded in the index, that the
74
+ index and manifest agree, and that no label contradicts itself. It exits 1 if
75
+ any of that fails, so it is usable as a CI step. It deliberately does **not**
76
+ re-derive the physics: a corpus that graded its own ground truth would be
77
+ arguing with itself. That is what `score.py` is for. Nor is it an authenticity
78
+ check — the digests ship inside the same download, so it catches corruption and
79
+ inconsistent editing, not deliberate substitution.
80
+
81
  The corpus is committed, so scoring needs nothing installed beyond your own
82
  checker. `generate.py` is only needed if you want to prove the files came from
83
  the generator — it rebuilds them byte-identically, and CI checks that it does.
 
185
  wrong is worse than no corpus, because every checker scored against it inherits
186
  the error.
187
 
 
 
 
 
 
 
 
 
 
 
 
188
  Generation is deterministic, files are SHA-256 pinned in the manifest, and both
189
+ properties are tested. `verify.py` re-checks those digests on your machine, so a
190
+ corrupted or half-edited copy is caught before you score anything against it.
191
+
192
+ The re-derivation is not ceremonial — it rejects labels. Three were corrected
193
+ before release: a resonator labelled passive measured σ_max = 1.2441 and was
194
+ not; a case meant to isolate an energy violation was also non-reciprocal; and
195
+ `negative_resistance` unavoidably breaks energy conservation, which its first
196
+ label denied. Every one was caught by the independent check rather than by a
197
+ user, which is the entire argument for running it. (That 1.2441 belonged to a
198
+ superseded generator revision; the resonator that ships has σ_max ≤ 1, asserted
199
+ in the suite, so it is the one figure here you cannot reproduce from the
200
+ committed files.)
201
 
202
  ## Scope, honestly
203