Commit 07404b7
* docs(#72): Sphinx/RTD site + JOSS paper skeleton + coverage ratchet 80->90
First bounded slice of roadmap issue #72 (docs + JOSS + coverage; SPEC 7 rng
was already landed on main and is out of scope here).
- Sphinx docs skeleton under docs/ (furo + MyST + autodoc/napoleon), Diataxis
structure, autogenerated API reference from liouscope.__all__. Builds clean
under `sphinx-build -W` (warnings-as-errors). Adds .readthedocs.yaml (v2,
fail_on_warning) + docs/requirements.txt + a `docs` optional-dependency group.
- JOSS paper skeleton: paper/paper.md + paper/paper.bib (JOSS 2026 sections).
All six bibliography DOIs resolver-verified; author ORCIDs and research-impact
evidence flagged TODO (not fabricated).
- Coverage ratchet: fail_under raised 80 -> 90 in pyproject [tool.coverage.report]
and CI --cov-fail-under; measured baseline branch coverage 94.61% (py3.14).
CONTRIBUTING updated to match.
Local verification (Windows, py3.14, this branch):
ruff check src tests benchmarks -> exit 0
mypy src/liouscope -> Success, 52 files
pytest tests/test_anchors.py -> 21 passed
pytest --cov --cov-fail-under=90 -> 533 passed, 94.61% (gate reached)
sphinx-build -W docs docs/_build/html -> build succeeded, 0 warnings
check_claim_safety.py / hardening.py -> both pass
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
* docs(#72): expand JOSS paper.md to full required section set
Bring paper/paper.md from a 585-word skeleton to a 1124-word (JOSS-style
body count) submission draft covering all 2026-required sections:
- State of the field: QuTiP/Trefethen-Embree context, complementary
(generator characterisation vs time evolution), no abuse of QuTiP.
- Software design: public API (build_liouvillian/steady_state/diagnose/
classify_mechanism), immutable typed result containers, six diagnostic
layers, column-stacking order='F' + Roth's identity guard, non-Hermitian
eigensolver (numpy.linalg.eig -> LAPACK zgeev), SPEC 7 rng keyword,
A-N anchor regressions, D1-D20 submission set within D1-D24 schema,
A1-A12-v3.1 taxonomy, fail-closed EnsembleEvidence claim gate (#78/E0706-13).
- Research impact: HONEST — first-party use/benchmarks only, no external
adoption yet (stated plainly); Zenodo/PyPI archived+citable; QuTiP CI
cross-check + anchors are internal verification, not external validation.
- AI usage disclosure: substantial — code/docs/paper co-developed with
Claude agents under AGENTS.md, human review+merge gate, agent branch
namespaces + labels, same required CI; cross-family review = independent
model review, explicitly NOT external scientific validation.
- Acknowledgements filled (NumPy/SciPy/QuTiP, SPEC 7).
Claim discipline: every technical statement is checkable against the repo;
no benchmark numbers asserted that are not reproducible. Author ORCID/
affiliation and funding remain marked TODO (must not be fabricated).
paper.bib unchanged (6 Crossref-verified DOIs intact). Coverage ratchet
(fail_under=90) untouched. Local chain green: ruff/mypy 0, 533 pytest pass,
cov 94.61%, sphinx -W 0 warnings.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 3edcbce commit 07404b7
16 files changed
Lines changed: 523 additions & 2 deletions
File tree
- .github/workflows
- docs
- _static
- explanation
- how-to
- reference
- tutorials
- paper
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
43 | 43 | | |
44 | 44 | | |
45 | 45 | | |
46 | | - | |
| 46 | + | |
47 | 47 | | |
48 | 48 | | |
49 | 49 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
10 | 25 | | |
11 | 26 | | |
12 | 27 | | |
| |||
24 | 39 | | |
25 | 40 | | |
26 | 41 | | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
27 | 48 | | |
28 | 49 | | |
29 | 50 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
19 | | - | |
| 19 | + | |
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
| |||
Whitespace-only changes.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
0 commit comments