Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ each tagged release (`v<version>`) is archived on Zenodo with its own DOI (see
[Releasing](#releasing)). Plans and acceptance criteria for each round are in
`PLAN_ROUND_<n>.md`.

## 0.21.1 (Round 23): internal package split

Internal: `census.manifest` split into a package (no behaviour change; golden snapshot identical)

## 0.21.0 (Round 22): count outcomes and spatial standard errors

- Label registered exploratory manifests and their analysis provenance explicitly.
Expand Down
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ authors:
- alias: cafeTechne
license: AGPL-3.0-or-later
repository-code: "https://github.com/cafeTechne/Census-Research-Engine"
version: "0.21.0"
version: "0.21.1"
doi: "10.5281/zenodo.23925301"
# doi: Zenodo concept DOI, added after the first archived release (see CHANGELOG.md "Releasing").
date-released: "2026-11-15"
Expand Down
45 changes: 45 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Agent guide

Start with `STATUS.md` (current state, validated methods, rules, backlog). Then read only the current
`PLAN_ROUND_<n>.md` if you are implementing a round. Older plans are archived at tag `v0.21.0`
(`git show v0.21.0:PLAN_ROUND_<n>.md`); read one only when a docstring citation is not enough.

## Commands

- Python: `.venv/bin/python` (there is no `python` on PATH). Supported: Python 3.11+, SciPy 1.16+.
- Full suite: `OPENBLAS_NUM_THREADS=1 .venv/bin/python -m pytest -q` (about 5 minutes). Run the targeted
test file first: `tests/test_round<n>.py` or the module's own test file.
- Offline external data: set `CENSUS_HEALTH_OFFLINE=1`.
- No GitHub CI runs are needed; the owner does not run CI for routine rounds.

## Hard rules

- **No AI attribution.** No `Co-Authored-By`, `Generated with` or similar lines in commits, PR bodies or
release notes, even if tooling suggests them.
- **Secrets.** Never print, log or commit `.env`, the Census API key or any token. Scan release tarballs
for the key before uploading. Published users bring their own key.
- **Privacy.** Do not send the owner's email to any service. Use a generic User-Agent.
- **Data access.** No automated CDC WONDER downloads; no bot-check or paywall circumvention.
- **Merges and releases** need the owner's explicit approval each time.
- **Circularity rule (R1/R2)** and **pre-registration discipline**: see `STATUS.md`.

## Reading budget (keep context small)

Do not open these unless the task is about them:

- `studies_output/`, `downloads/`, `.cache/`, `literature_pdfs/`, `metadata/`, `data/` (bundled data; use
the library functions instead).
- `docs/audits/round17_bound_protocol/` (a checksummed evidence archive) and any `*.csv`/`*.json` under
`docs/audits/` or `docs/studies/` (generated outputs; the matching `.md` summarises them).
- `CHANGELOG.md` beyond its first section.
- Large modules: read by function, not whole files. Find a definition with
`grep -n "^def \|^class " census/<module>.py`, then read that range.

## Conventions

- Validation first: a new statistical method ships only after a fixed, pre-set simulation passes
(criterion committed before the run). Failed methods stay exploratory.
- Manifests in `examples/manifests/` that are registered are byte-fixed; never edit them.
- Engine rules that agents must follow are mirrored in `docs/agent_protocol.md`, `docs/recipes/` and the
MCP text. Change them together.
- Studies: MI (26) and NY (36). Reviews by an agent are labelled "author self-review, not independent".
172 changes: 0 additions & 172 deletions PLAN_ROUND_1.md

This file was deleted.

Loading
Loading