Add a browsable index so the Hub viewer can render the corpus

README.md

@@ -14,11 +14,14 @@ tags:
 pretty_name: S-Parameter Physical Conformance Corpus
 size_categories:
   - n<1K
+configs:
+  - config_name: index
+    data_files: data/index.jsonl
 ---
 
 # sparam-conformance
 
-![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-46%20passing-brightgreen)
+![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-47%20passing-brightgreen)
 
 **A labelled corpus of S-parameter networks with ground-truth physical verdicts —
 and a scorer that grades any checker against it.**
@@ -164,6 +167,9 @@ score.py                  scorer + adapter contract
 sparam_lint_adapter.py    reference adapter (5 lines)
 data/*.s2p, *.s4p         the corpus
 data/manifest.json        labels, tags, SHA-256 digests
+data/index.jsonl          the manifest flattened one-row-per-case, so the
+                          Hub viewer can render it (generated by build_index.py)
+build_index.py            regenerates index.jsonl from the manifest
 tests/                    label verification + scorer tests
 ```
 

build_index.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+"""Flatten the manifest into a tabular index the Hub dataset viewer can render.
+
+The corpus itself is Touchstone text, which no dataset viewer parses, so a
+reader landing on the Hub page would otherwise see nothing at all. This emits
+one row per case -- labels, expected failures, digest -- so the contents are
+browsable in the page without downloading anything.
+
+The .sNp files remain the data; this is a view of the manifest, generated from
+it, never edited by hand.
+"""
+from __future__ import annotations
+
+import json
+import pathlib
+
+HERE = pathlib.Path(__file__).resolve().parent
+DATA = HERE / "data"
+
+
+def build() -> list[dict]:
+    m = json.loads((DATA / "manifest.json").read_text())
+    rows = []
+    for c in m["cases"]:
+        expect = c["expect"]
+        rows.append({
+            "name": c["name"],
+            "file": c["file"],
+            "n_ports": c["n_ports"],
+            "z0_ohm": c["z0_ohm"],
+            "physically_realizable": c["physical"],
+            "expected_to_pass_all_laws": c["expect_all_pass"],
+            "expected_failures": sorted(k for k, v in expect.items() if not v),
+            "tags": c.get("tags", []),
+            "note": c.get("note", ""),
+            "sha256": c.get("sha256", ""),
+        })
+    return rows
+
+
+def main() -> int:
+    rows = build()
+    out = DATA / "index.jsonl"
+    with out.open("w") as fh:
+        for r in rows:
+            fh.write(json.dumps(r, sort_keys=True) + "\n")
+    print(f"{out.relative_to(HERE)}: {len(rows)} rows")
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

data/index.jsonl

@@ -0,0 +1,11 @@
+{"expected_failures": [], "expected_to_pass_all_laws": true, "file": "passive_line.s2p", "n_ports": 2, "name": "passive_line", "note": "Lossy 20 ps delay line, 0.5 dB insertion loss. The baseline sane case.", "physically_realizable": true, "sha256": "74d631c14f5c18e9e9cf06bde2579628ff15820fc4b652035cd09d2809f4166d", "tags": ["passive", "2port"], "z0_ohm": 50.0}
+{"expected_failures": [], "expected_to_pass_all_laws": true, "file": "passive_resonator.s2p", "n_ports": 2, "name": "passive_resonator", "note": "Shunt resonator, Q=30 at 20 GHz. Sharp phase slope near resonance -- the case where a group-delay check without phase unwrapping fails.", "physically_realizable": true, "sha256": "1a4b1e2f9f873fcdc03327dababdccce6fc3d6ab0a0968ac70b2f03a803c3f39", "tags": ["passive", "2port", "sharp_phase"], "z0_ohm": 50.0}
+{"expected_failures": [], "expected_to_pass_all_laws": true, "file": "passive_attenuator.s2p", "n_ports": 2, "name": "passive_attenuator", "note": "Ideal 10 dB matched attenuator.", "physically_realizable": true, "sha256": "ee4b89263c942825af357be7f0273716d62ea984da5d441bcaf204c70f59963d", "tags": ["passive", "2port"], "z0_ohm": 50.0}
+{"expected_failures": [], "expected_to_pass_all_laws": true, "file": "matched_load.s2p", "n_ports": 2, "name": "matched_load", "note": "All-zero S: perfectly matched, fully absorbing. A degenerate but legal network; checkers that divide by |S| must not blow up.", "physically_realizable": true, "sha256": "7a60bff097406dfcb7cab59bcc837935353727634161806c53eae99ba865470b", "tags": ["passive", "2port", "degenerate"], "z0_ohm": 50.0}
+{"expected_failures": [], "expected_to_pass_all_laws": true, "file": "marginal_lossless.s2p", "n_ports": 2, "name": "marginal_lossless", "note": "Lossless line with sigma_max = 1 - 1e-12. Sits on the passivity boundary; a checker with a too-tight tolerance false-alarms here.", "physically_realizable": true, "sha256": "2dc0808d30a664b78cc263f06a9a46b48f7920bb3e9a132d56dfe4364d9179b4", "tags": ["passive", "2port", "boundary"], "z0_ohm": 50.0}
+{"expected_failures": [], "expected_to_pass_all_laws": true, "file": "passive_4port.s4p", "n_ports": 4, "name": "passive_4port", "note": "Four-port with two independent thru paths. Exercises N>2 handling.", "physically_realizable": true, "sha256": "1c24a1157c72806fa771c2e592eb8751724c8ba5cae446dc7b798dd8b0302f17", "tags": ["passive", "4port"], "z0_ohm": 50.0}
+{"expected_failures": ["energy_conservation", "passivity"], "expected_to_pass_all_laws": false, "file": "active_gain.s2p", "n_ports": 2, "name": "active_gain", "note": "Delay line with 3x through-path gain. Creates energy: fails both the spectral-norm and the row-power tests.", "physically_realizable": false, "sha256": "3f78dfcd6598f6734633a65a37e30edc8c4486c89d0c2e29cc52720780f22c32", "tags": ["nonphysical", "2port"], "z0_ohm": 50.0}
+{"expected_failures": ["energy_conservation", "passivity"], "expected_to_pass_all_laws": false, "file": "energy_row_violation.s2p", "n_ports": 2, "name": "energy_row_violation", "note": "Row power > 1 when port 1 is driven.", "physically_realizable": false, "sha256": "05e30904110032dc75777b11b96dbde5398ae9e922ab64a89704f9675db7ae83", "tags": ["nonphysical", "2port"], "z0_ohm": 50.0}
+{"expected_failures": ["energy_conservation", "passivity", "positive_real_z0"], "expected_to_pass_all_laws": false, "file": "negative_resistance.s2p", "n_ports": 2, "name": "negative_resistance", "note": "|S11| > 1 gives Re(Z_in) < 0: negative resistance at the port. It unavoidably breaks energy conservation too -- a reflection coefficient above unity returns more power than arrives -- so this case cannot isolate a single law, and the label says so.", "physically_realizable": false, "sha256": "2eb111856d1bfcdfb53e93f873704073f21af7926cb2ed18f5b2ef5b3114fdcc", "tags": ["nonphysical", "2port"], "z0_ohm": 50.0}
+{"expected_failures": ["group_delay_nonneg"], "expected_to_pass_all_laws": false, "file": "noncausal_advance.s2p", "n_ports": 2, "name": "noncausal_advance", "note": "Phase advances with frequency: the output precedes the input. Passive and reciprocal, so ONLY the causality check should fire.", "physically_realizable": false, "sha256": "ede95a08f616205688b97eac8c7665b2491ce4a038767614ebc69ad0730ffe5c", "tags": ["nonphysical", "2port", "isolates_one_law"], "z0_ohm": 50.0}
+{"expected_failures": ["reciprocity"], "expected_to_pass_all_laws": false, "file": "ferrite_isolator.s2p", "n_ports": 2, "name": "ferrite_isolator", "note": "A ferrite isolator. NON-RECIPROCAL BY DESIGN and entirely realizable -- the medium is not reciprocal. The reciprocity check correctly fires, and that is a true positive for the law but NOT a defect in the device. Any tool reporting this must let the user say so.", "physically_realizable": true, "sha256": "574d727015c7c3bb436bf1f9723098ac12a73e0392d3e2045a1b356c53e57f30", "tags": ["physical", "2port", "expected_law_failure"], "z0_ohm": 50.0}

tests/test_conformance.py

@@ -187,3 +187,29 @@ def test_reference_adapter_conforms():
     assert r["checker_errors"] == 0
     assert r["false_pass"] == 0, f"sparam-lint false passes: {r['per_case']}"
     assert r["passed"]
+
+
+# ------------------------------------------------------- viewer index
+
+def test_index_matches_the_manifest_exactly():
+    """The browsable index is a view of the manifest, never a second source."""
+    import json as _json
+    import subprocess
+    import sys as _sys
+    here = Path(__file__).resolve().parents[1]
+    idx = here / "data" / "index.jsonl"
+    assert idx.exists(), "index.jsonl missing -- run build_index.py"
+    rows = [_json.loads(x) for x in idx.read_text().splitlines() if x.strip()]
+    man = _json.loads((here / "data" / "manifest.json").read_text())
+    assert len(rows) == len(man["cases"]) == man["n_cases"]
+    by_name = {r["name"]: r for r in rows}
+    for c in man["cases"]:
+        r = by_name[c["name"]]
+        assert r["physically_realizable"] == c["physical"]
+        assert r["expected_failures"] == sorted(
+            k for k, v in c["expect"].items() if not v)
+    # and it must regenerate identically
+    before = idx.read_bytes()
+    subprocess.run([_sys.executable, str(here / "build_index.py")],
+                   capture_output=True, check=True)
+    assert idx.read_bytes() == before, "index.jsonl is stale vs the manifest"