Skip to content

Commit a907c89

Browse files
authored
docs: add precipitation reviewer path
Add a lightweight reviewer path for the compact precipitation diagnostics mini-lab, including orientation, workflow review, reproducibility checks, and publication boundaries.
1 parent 0b41db7 commit a907c89

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Reviewer path
2+
3+
This reviewer path is a lightweight guide for reading the compact precipitation diagnostics mini-lab as a public scientific-computing workflow. It is intended to make the project easy to evaluate without presenting it as the repository's flagship release surface.
4+
5+
## 30-second orientation
6+
7+
Read the project README first. Confirm this is a sanitized scientific-computing mini-lab, not a course archive and not an operational forecast system.
8+
9+
Check the first screen for the project role:
10+
11+
- compact reviewer-facing precipitation diagnostics mini-lab
12+
- supporting scientific-data project inside `scientific-computing-toolkit`
13+
- not part of the `sbom-diff-and-risk` release surface
14+
- not a separate meteorology portfolio
15+
16+
## 5-minute workflow review
17+
18+
Inspect:
19+
20+
- [`docs/methodology.md`](methodology.md)
21+
- [`docs/inference-framework.md`](inference-framework.md)
22+
- [`reports/example-report.md`](../reports/example-report.md)
23+
- [`examples/sample_metadata.json`](../examples/sample_metadata.json)
24+
25+
This pass should answer whether the workflow is reproducible, scientifically bounded, and clear enough for a reviewer to follow from input assumptions to derived outputs.
26+
27+
## 15-minute reproducibility review
28+
29+
Run:
30+
31+
```bash
32+
python -m pip install -e .[dev]
33+
python -m pytest
34+
python scripts/run_preprocessing.py --help
35+
python scripts/run_eof_analysis.py --help
36+
python scripts/run_composite_analysis.py --help
37+
```
38+
39+
This review does not require raw climate datasets. The help commands verify that the public scripts expose their configuration surface without relying on local machine paths or restricted data files.
40+
41+
## Boundaries
42+
43+
Read:
44+
45+
- [`docs/data-policy.md`](data-policy.md)
46+
- [`PUBLICATION_BOUNDARIES.md`](../PUBLICATION_BOUNDARIES.md)
47+
48+
The project should be read as a reproducible spatiotemporal diagnostics module: it demonstrates data-policy discipline, analysis structure, and reviewer-friendly interpretation while keeping raw datasets, institutional course artifacts, personal identifiers, and local machine details out of the public repository.

0 commit comments

Comments
 (0)