Skip to content

Add the student layout rule for Validation pages to AGENTS.md #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timlichtenberg merged 3 commits into from
Oct 27, 2026
Merged

Add the student layout rule for Validation pages to AGENTS.md #24

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76cf508
Sync the shared AGENTS.md rules for student-readable docs
timlichtenberg Oct 25, 2026
6e03075
Merge remote-tracking branch 'origin/main' into tl/agents-student-docs
timlichtenberg Oct 26, 2026
687a0b2
Merge remote-tracking branch 'origin/main' into tl/agents-student-docs
timlichtenberg Oct 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ pytest -x -v --showlocals tests/test_<file>.py::test_function
make clean; make -j CFLAGS_EXTRA="-O0 -fsanitize=address" # debug or sanitizer build
```

<!-- fwl-core:begin sha256=1adfa510a4f117ec -->
<!-- fwl-core:begin sha256=a068b422083dfd1c -->
## PROTEUS ecosystem rules

PROTEUS couples separate module repositories into one model of the evolution of rocky planets and their atmospheres. Its config selects one module per process; the config values are the lowercase names:
Expand All @@ -48,7 +48,9 @@ A module change to anything PROTEUS calls or reads (a function signature, a conf

### Validation

A new or changed physics routine gets the validation cases named in its confirmed plan: an analytical law, a published figure or table, or a cross-code check. Each case is a `reference_pinned` test that runs the real code on real data, with no mocks, asserts the tolerance, and writes its light and dark plot through the `validation_plot` fixture of proteus-mpl. `pytest -m reference_pinned --validation-plots` makes all plots again. Line plots are SVG, maps are AVIF; each file is at most 60 kB, under `docs/assets/validation/`. Each case has a subsection on its page in the Validation tab, with the reference, the tolerance, the test id and the command. Data read from a published figure comes from 2 independent figlab reads that agree within the stated error, as a CSV with its provenance under `tests/validation/data/`.
A new or changed physics routine gets the validation cases named in its confirmed plan: an analytical law, a published figure or table, or a cross-code check. Each case is a `reference_pinned` test that runs the real code on real data, with no mocks, asserts the tolerance, and writes its light and dark plot through the `validation_plot` fixture of proteus-mpl. `pytest -m reference_pinned --validation-plots` makes all plots again. Line plots are SVG, maps are AVIF; each file is at most 60 kB, under `docs/assets/validation/`. Data read from a published figure comes from 2 independent figlab reads that agree within the stated error, as a CSV with its provenance under `tests/validation/data/`.

Write the Validation pages and each new Explanation section for a student who knows physics but not this code, in simple English. A Validation page opens with `## What this page checks`. Each case has the bold lead-ins **Why this check exists.**, **What it tests.**, **How we know the right answer.** and **Why it matters.**, the plot pair with **How to read the plot.**, and a collapsed `??? info "Test details"` box with the reference, the tolerance, the test id and the command. The full layout is in [Writing Validation and Explanation pages](https://proteus-framework.org/PROTEUS/Community/CONTRIBUTING.html#writing-validation-and-explanation-pages).

### Code

Expand Down
Loading