ModelParser

class ModelParser(config_path: str | pathlib.Path)

ModelParser reads a given YAML configuration file (see configuration guide) and parses the contents into a ModelConfig object.

Parameters:

Name	Type	Description
config_path	`str \\| pathlib.Path`	Path to the YAML config file.
parsed	`ParsedConfig`	Parsed model/kalman config pair populated at initialization.

Methods:

Signature	Return Type	Description
`.from_yaml()`	`ParsedConfig`	Reads the file and populates `ModelParser.parsed`. Runs at `__init__`.
`.get()`	`ModelConfig`	Returns the currently parsed model config.
`.get_all()`	`ParsedConfig`	Returns the currently parsed model/kalman config pair.

ParsedConfig

ParsedConfig is an unpack-able dataclass holding ParsedConfig.model: ModelConfig and ParsedConfig.kalman: KalmanConfig

Calibration Completeness

Parsing enforces that every declared parameter has a calibration value, and every parameter referenced in shock/Kalman sections is declared and calibrated.