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.

RuntimeParameterSet

class cstar.applications.roms_marbl.models.RuntimeParameterSet(*, documentation: str = '', locked: bool = False, hash: str | None = None, start_date: datetime, end_date: datetime, checkpoint_frequency: Annotated[str, MinLen(min_length=2), _PydanticGeneralMetadata(pattern='([1-9][0-9]*)([hdwmy])')] = '1d', **extra_data: Any)

Bases: ParameterSet

Parameters for the execution of the model.

These parameters can be varied (within bounds defined elsewhere in the blueprint, e.g. valid_start/end_date), without changing the validity of the model solution.

Attributes

RuntimeParameterSet.start_date	Start of data time range to be used in the simulation.
RuntimeParameterSet.end_date	End of data time range to be used in the simulation.
RuntimeParameterSet.checkpoint_frequency	Time period between creation of checkpoint files.
RuntimeParameterSet.hash	Hash used to verify the parameters are unchanged.
RuntimeParameterSet.documentation	Description of input data provenance; used in provenance roll-up.
RuntimeParameterSet.locked	Mutability of the parameter set.