Configuration field index
Read Configuration structure first to see how the root sections fit together. The linked chapters describe each field's type, required conditions, default, supported choices, and consequences. The generated schema is an additional validation reference.
Reading a field path
dataset.domain.start means the start field under domain, under dataset: three levels in the configuration. Do not write it as a key containing dots.
signals[] means each item in the signal list. signals[0] identifies the first item, using a zero-based list position. In YAML, list items start with -, and child fields use indentation. Use two spaces per level and no tabs.
See Dotted paths and YAML and Analyze only 2–5 seconds. Edit an existing parent block rather than adding a duplicate root key.
Find a field by root section
| Root field | Detailed reference | What to look for |
|---|---|---|
config_version |
Configuration syntax | Required analysis version. |
dataset |
Dataset and analysis range | Ordinary name; optional entity, session, domain, and metadata. |
sources |
Inputs, Text inputs | Source type, paths, DBC, reader settings, and source time. |
signals |
Signals | Binding, type, unit, period, validity, choices, and conversion. |
derived |
Expressions | Named expressions and units. |
| lookups | One-dimensional lookup and interpolation | |
transforms |
Time-series transforms | Version 4 rolling statistics and rates. |
| aggregations | Result aggregation: fields, operations, grouping and completeness | |
rules |
Event rules | Conditions and event generation. |
windows |
Windows | Ranges around events. |
sequences |
Sequences | Pairing and latency. |
calculations |
Calculations | Operations, expressions, conditions, and scopes. |
message_calculations |
Message calculations | Per-message accumulation. |
intervals |
Calculation intervals | Actual, fixed, or DBC periods. |
presets |
Presets | Ready-made combinations and their parameters. |
execution |
Execution | Backend, batching, and resource limits. |
outputs |
Outputs, Signal exports, Raw CAN exports | Output formats and explicitly requested exports. |
imports, overrides |
Shared definitions | Reuse and override local definitions. |
diagnostics, metadata |
Execution | Optional diagnostics and run notes. |
For the complete machine-readable structure, see Configuration schema. Schema words such as properties, required, and oneOf describe validation; they are not business configuration fields.
Python function arguments are a separate reference. Only functions that explicitly accept a public configuration dictionary accept these root fields. See Public API.