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

classmethod Simulation.state_file_from(directory: Path) → Path

The path where a state file containing a pickled Simulation will be created upon successful completion of a simulation, when that simulation uses the supplied directory as it’s working directory.

Parameters:

directory (Path) – The target working directory for an inaccessible simulation instance, such as during a restart.

Returns:

Path – The path where the state file will be created.