batter.config.dump_simulation_config#

batter.config.dump_simulation_config(cfg: SimulationConfig, path: Path | str) → None[source]#

Write a simulation configuration to YAML.

Parameters:

  • cfg (SimulationConfig) – Configuration object to serialise.

  • path (str or pathlib.Path) – Output file path for the YAML representation.