DORAEMON Documentation

Reference material for physics, rules, metrics, software, validation, and contribution.

Docs are the reference layer for the site. Challenge catalogs and dataset pages are separate surfaces: use OpenDC for challenge pages and Data Hub for dataset pages.

What Belongs Here

Surface Purpose
Canonical Records Where challenge and dataset record pages are edited
Physics Detector and reconstruction background
Challenge Rules Shared structure, scoring, validation, and submissions
Metrics Definitions such as Adjusted Rand Index and panoptic quality
Software Stack Containers, streamers, notebooks, validators, repositories
Contribution How to suggest a challenge or candidate solution
Dataset Schema Notes Field conventions and submission shapes shared by datasets

Records And Shared Notes

Challenge protocol source: challenges/<challenge-id>/challenge.qmd. Rendered pages: OpenDC.

Dataset record source: datasets/<dataset-id>/dataset.qmd. Rendered pages: Data Hub.

Do not duplicate challenge status, dataset access, baseline links, or protocol text in documentation/. Keep only shared reference material here.

Local Commands

make validate
make build
make serve