unzhakov/beta_shape_pnpi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add docs_check.py to quality gates, add bs_exp CLI, document pytest markers

Browse Source
This commit is contained in:
unzhakov
2026-05-22 15:18:00 +03:00
parent 5dd9c7977a
commit fd76eff109
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+7 -5
View File
@@ -52,11 +52,12 @@ State which phase you're in. Name phases explicitly.
All must pass before merge: All must pass before merge:
```bash ```bash
pytest pytest # all tests (markers: property, physics, api, quality, integration, slow, requires_ensdf)
nbmake notebooks/ nbmake notebooks/ # execute notebooks as tests
black --check . black --check . # formatting
ruff check . ruff check . # linting
mypy . mypy . # type checking (strict)
python scripts/docs_check.py # documentation consistency (version, file refs, CLI args)
``` ```
Run individually to identify failures. Run individually to identify failures.
@@ -67,6 +68,7 @@ After quality gates pass, run:
```bash ```bash
bs_pnpi --nuclide Tc99 -vv --output ./output/verification.csv --plot ./output/verification.png --log-file ./output/debug.log 2>&1 | tee ./output/debug_stdout.log bs_pnpi --nuclide Tc99 -vv --output ./output/verification.csv --plot ./output/verification.png --log-file ./output/debug.log 2>&1 | tee ./output/debug_stdout.log
bs_exp --help # verify experimental data CLI
``` ```
Verify parameter consistency across all components. Save artifacts to `./output/`. Verify parameter consistency across all components. Save artifacts to `./output/`.