Attention

This project is still in an early phase of development.

The python API is not yet stable, and some aspects of the schema for the blueprint and workplan will likely evolve. Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. We expect to reach a more stable version in 2026.

cstar.simulation.Simulation.from_blueprint

abstractmethod classmethod Simulation.from_blueprint(blueprint: str) → Simulation

Abstract method to create a Simulation instance from a blueprint file.

This method should be implemented in subclasses to read a YAML file containing a structured blueprint for a simulation and initialize a Simulation instance accordingly.

Parameters:

blueprint (str) – The path or URL of a YAML file containing the blueprint for the simulation.

Returns:

Simulation – An initialized Simulation instance based on the provided blueprint.

See also

to_blueprint

Saves the Simulation instance to a YAML blueprint file.

from_dict

Creates a Simulation instance from a dictionary.