Specifications
The normative specifications of the engine: what it must do, rule by rule. They are reference text, not walkthroughs; the how-to guides show many of the features in use. Tests, vectors and goldens hold their rules.
| Specification | What it fixes |
|---|---|
| KERNEL-SPEC.md | The kernel: versions, canonical digests, the seed tree, draws, the clock, the emit stream, keys from the contract, value rendering, the trace and the run digest. |
| KERNEL-SPEC-2.md | Kernel v2 (0.2.0): Philox streams keyed by path and counted by ordinal, draw and attempt; continuous draws in binary64 from basic operations; identifiers and permutations from Philox; what it keeps of KERNEL-SPEC. Implemented beside kernel 0.1.0; fluxsim plan --kernel 0.2.0 plans a run under it. |
| SEAM-FIDELITY-SPEC.md | The generator that writes rows in a contract's shape, the fidelity block, the fidelity check and the gate ship runs. |
| EXPR-SPEC.md | flux-expr/1, the language of a Segment's query. |
| EXPR-SPEC-2.md | flux-expr/2, the language of derived columns and of rules about valid data. The engine implements the language; generating from rules and checking runs against them come next. |
| EXPR-SPEC-3.md | flux-expr/3, flux-expr/2 plus a date part, date arithmetic and string concatenation, for FLUX-side rules. Accepted with ADR 0013; the engine implements the language. |
| PROFILE-SPEC.md | The profile a data owner makes, and how a Simulation pins one. Beside it: the schemas of format 1-1-0 and 1-0-0, and an example. |
| SCORECARD-SPEC.md | The scores of a run against its pinned profile, their thresholds, and the shape flags. Beside it: the schema and an example. |
| SAMPLE-SPEC.md | Checking a run's means against the profile on a sample of blocks, each with an interval. |
| PARAMETER-REGISTER-SPEC.md | The register of what each number a run reads rests on. Beside it: the schemas of format 1-1-0 and 1-0-0, and an example. |