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.

ModelParameterSet

class cstar.applications.roms_marbl.models.ModelParameterSet(*, documentation: str = '', locked: bool = False, hash: str | None = None, time_step: Annotated[int, Gt(gt=0)], **extra_data: Any)

Bases: ParameterSet

Parameters that can override ROMS.in values. Unlike RuntimeParameters, these affect the validity of the model solution, and should be locked for validated blueprints.

Attributes

ModelParameterSet.time_step	The time step the model integrates over.
ModelParameterSet.hash	Hash used to verify the parameters are unchanged.
ModelParameterSet.documentation	Description of input data provenance; used in provenance roll-up.
ModelParameterSet.locked	Mutability of the parameter set.