batter.config.load_simulation_config#

batter.config.load_simulation_config(path: Path | str) SimulationConfig[source]#

Load a simulation configuration from YAML.

Parameters:

path (str or pathlib.Path) – Path to the simulation YAML file.

Returns:

Validated simulation configuration.

Return type:

SimulationConfig