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.to_dict

Simulation.to_dict() → dict

Convert the Simulation instance into a dictionary representation.

This method serializes the attributes of the Simulation instance into a dictionary format, including metadata, codebase details, discretization settings, runtime and compile-time code information.

Returns:

dict – A dictionary containing all the attributes of the Simulation instance.

See also

from_dict

Constructs a Simulation instance from a dictionary.

to_blueprint

Writes an equivalent representation to a yaml file.