v0.3.0 — Transparency & Discoverability Overhaul
What's New
This release transforms scpn-quantum-control from an opaque prototype into a self-contained research asset. The technical substance (199 tests, 0.05% VQE on IBM Heron r2, 98% line coverage) was already solid — now it's visible.
Added
- README rewrite: motivating abstract explaining SCPN→XY isomorphism, "Background" section with Kuramoto-to-Hamiltonian derivation, all 4 figures embedded with captions, expanded example table with descriptions, "Related Repositories" section
- Paper 27 citation: formal working paper reference in README and docs/equations.md
- docs/equations.md: SCPN overview and UPDE definition added; equations document is now self-contained
- examples/README.md: guided walkthrough of all 6 examples with physics context
- HARDWARE_RESULTS.md: layer naming convention section explaining L1-L16 mapping
- Docstrings: 27 public functions and 3 classes documented across 15 source files
- GitHub discoverability: 10 repository topics, description, issue templates, PR template
Changed
- CI mypy scope: expanded from
bridge/only to fullmypy(27 source files, zero errors) - VALIDATION.md: test count 88→199, classical references now point to in-repo functions instead of external packages
- Badges: test count 88→199, added version badge
Install
pip install scpn-quantum-control==0.3.0
Stats
- 199 tests, 98% line coverage
- 27 source files pass mypy strict
- 0.05% VQE ground-state error on IBM Heron r2 (156 qubits)
- 4 figures embedded in README with captions
Full changelog: https://github.com/anulum/scpn-quantum-control/blob/main/CHANGELOG.md