pySimBlocks.project.load_simulator

pySimBlocks.project.load_simulator.load_simulator_from_project(project_yaml: str | Path) → Tuple[Simulator, PlotConfig | None][source]

Build and return a ready-to-run Simulator from a unified project.yaml.

Loads the project configuration, constructs the model, and initializes a Simulator ready to call run().

Parameters:

project_yaml – Path to the unified project.yaml file.

Returns:

A tuple (sim, plot_cfg) where sim is the initialized Simulator and plot_cfg is the PlotConfig or None if no plots are configured.

Raises:

  • FileNotFoundError – If the project file does not exist.

  • ValueError – If the project file is malformed or required fields are missing.