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

Simulation.persist() → None

Save the current state of the simulation to a file.

This method serializes the simulation object and writes it to a file named simulation_state.pkl within the simulation directory, allowing the exact state to be restored later.

Raises:

RuntimeError – If the simulation is currently running in a local process, as a running LocalProcess instance cannot be serialized.

See also

restore

Restores a previously saved simulation state.