Skip to content

Note where a catalog graduation note's cited evidence now lives #794

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
xmap merged 1 commit into from
Sep 9, 2026
Merged

Note where a catalog graduation note's cited evidence now lives #794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 catalog/catalog.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
# equality (the graduated device-class roster), same as roles.
# - capabilities, methods, models have no global code seed; this file is
# their consolidated source, guarded by the round-trip test.
# - a note's cited beamlines (e.g. "graduated across Diamond i22, i03, i11")
# are not reproduced here; only 2-BM has a descriptor in this repo. Their
# device data is checkable on demand in the private xmap/research (draft)
# and xmap/descriptors (promoted) repos.
#
# An affordance is a Family property: it declares what the device CAN DO at the
# physics layer. A Role declares required_affordances (the contract), and a
Expand Down
2 changes: 2 additions & 0 deletions docs/catalog/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,5 @@ Some apparent new families are settings axes, not family axes. A high-framerate
## Source of truth

Roles and the closed affordance / executor-shape vocabularies are code-defined and validated against the code by drift-guard tests. Families, Capabilities, Methods, and Models are authored in `catalog.yaml`, which supersedes the scenario fixtures as the consolidated source. Until the seeder inversion lands, the code seeds remain authoritative for what CORA actually registers; `catalog.yaml` is the docs projection, kept honest by the round-trip and roles drift-guard tests.

A graduation note (a Family or Role reaching the rule-of-three, "graduated across Diamond i22, i03, i11") cites the real beamlines that justified it, but does not reproduce their device data here: only CORA's one live deployment, 2-BM, has a descriptor in this repo. The beamlines a graduation note names are modeled from public source, checkable on demand, in the private `xmap/research` (draft surveys and candidates) and `xmap/descriptors` (self-validated, promoted) repos.
Loading