Development
Keep the guide, API and downloadable fixtures tied to one source revision. Most feature updates should touch one guide section, its focused example or check, and the revision notes.
{{REVISION_NOTICE}}
From a clean checkout with Python 3 and Doxygen 1.9.8 installed, run the standalone manual build and strict link checker. They do not configure CMake or fetch solver dependencies:
python3 docs/tools/build_docs.py --output build/guide-docs
python3 docs/tools/check_docs.py build/guide-docs/site
python3 -m http.server 8000 --directory build/guide-docs/siteOpen http://localhost:8000/. The builder only replaces an output directory carrying its exact ownership marker; choose a dedicated ignored path under build/. The notice identifies the current source SHA and says when the manual working tree includes uncommitted changes.
| Workflow | Source and API | Evidence and limit |
|---|---|---|
| First seismogram | app/yspec.cpp, YSpec/Input.hpp, YSpec/Run.hpp | Small first-run JSON + checked finite text trace and Matplotlib plot; workflow illustration, not convergence evidence |
| Snapshot grid | app/yspec-snapshot.cpp, YSpec/Snapshots.hpp, YSpec/Run.hpp | Small tutorial fixture with reduced dimensions; canonical examples/snapshot.json remains unchanged |
| High-level library traces | examples/library.cpp, YSpec/Synthetics.hpp, YSpec/Seismograms.hpp | Existing compiled example and CTest case; its scalar result is revision/compiler dependent |
| Input validation | src/InputSections.cpp, tests/TestInput.cpp, YSpec/Input.hpp | Defaults, groups, profiles, instruments, forces and invalid fields; schemas are not duplicated here |
| Strain traces | YSpec/Synthetics.hpp, YSpec/Seismograms.hpp | Existing CTest checks strain/displacement differences and reciprocity; no CLI or JSON interface |
| Radial kernels | YSpec/Kernels.hpp, src/Kernels.cpp, tests/TestKernels.cpp | Existing finite-difference checks by gravity treatment; radial, isotropy-constrained perturbations only |
| Fortran references | tests/regression/, tests/fortran/ | Saved comparisons for listed cases; regeneration uses an external Fortran checkout and is not docs CI |
For the wider coverage list, start from the existing README test summary and inspect the named test files at the same source revision.
implementation_status.md; approval and a source commit precede any website pin update.