cstar.simulation.Simulation.from_dict

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_dict#

abstractmethod classmethod Simulation.from_dict(simulation_dict: dict, directory: str | Path)#

Abstract method to create a Simulation instance from a dictionary.

This method must be implemented by subclasses to construct a simulation object using a dictionary representation, typically generated by to_dict().

Parameters:

  • simulation_dict (dict) – A dictionary containing the attributes required to initialize a Simulation instance.

  • directory (str or Path) – The directory where the simulation will be set up.

Returns:

Simulation – An initialized simulation instance.

See also

to_dict

Converts an existing Simulation instance into a dictionary representation.

from_blueprint

Reads an equivalent representation from a yaml file.