nickh007 commited on
Commit
7937a4b
·
verified ·
1 Parent(s): 0f2b353

docs: complete the card + contributing guide + completeness guard

Browse files
Files changed (1) hide show
  1. README.md +11 -1
README.md CHANGED
@@ -21,13 +21,15 @@ 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-51%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
 
28
  **A labelled corpus of S-parameter networks with ground-truth physical verdicts —
29
  and a scorer that grades any checker against it.**
30
 
 
 
31
  There is no public dataset of *physically invalid* S-parameter files. Everyone
32
  building an RF validation tool tests it on files that happen to be lying around,
33
  which means nobody knows whether their checker catches the cases that matter.
@@ -302,3 +304,11 @@ The corpus is synthetic and contains no proprietary or measured data.
302
  - [`sparam-lint`](https://github.com/nickharris808/sparam-lint) — the reference checker (Apache-2.0)
303
  - [ChipletOS](https://chipletos.com) — scattering synthesis that is passive *by
304
  construction*, so it cannot fail these laws whatever its parameters
 
 
 
 
 
 
 
 
 
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
 
28
  **A labelled corpus of S-parameter networks with ground-truth physical verdicts —
29
  and a scorer that grades any checker against it.**
30
 
31
+ ## Why this exists
32
+
33
  There is no public dataset of *physically invalid* S-parameter files. Everyone
34
  building an RF validation tool tests it on files that happen to be lying around,
35
  which means nobody knows whether their checker catches the cases that matter.
 
304
  - [`sparam-lint`](https://github.com/nickharris808/sparam-lint) — the reference checker (Apache-2.0)
305
  - [ChipletOS](https://chipletos.com) — scattering synthesis that is passive *by
306
  construction*, so it cannot fail these laws whatever its parameters
307
+
308
+ ## Contributing
309
+
310
+ One non-negotiable rule here: every label must be **derived from construction**, never from another tool's opinion — and re-verified independently in the test suite. [`CONTRIBUTING.md`](CONTRIBUTING.md) has the detail. Each sibling repository states its own, and they differ — that is deliberate, and it is why each is trustworthy on its own terms.
311
+
312
+ ## Citation
313
+
314
+ [`CITATION.cff`](CITATION.cff) is machine-readable; GitHub renders a “Cite this repository” button from it.