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.

RomsMarblBlueprint

class cstar.applications.roms_marbl.models.RomsMarblBlueprint(*, name: Annotated[str, StringConstraints(strip_whitespace=True, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None, ascii_only=None)], description: Annotated[str, StringConstraints(strip_whitespace=True, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None, ascii_only=None)], application: str = 'roms_marbl', state: BlueprintState = BlueprintState.NotSet, schema_version: str = '2.0.0', working_dir: WithJsonSchema(json_schema={'type': 'string'}, mode=serialization)] = PosixPath('.'), valid_start_date: datetime, valid_end_date: datetime, code: ROMSCompositeCodeRepository, initial_conditions: Annotated[Dataset, MinLen(min_length=1), MaxLen(max_length=1)], grid: Annotated[Dataset, MinLen(min_length=1), MaxLen(max_length=1)], forcing: ForcingConfiguration, partitioning: PartitioningParameterSet, model_params: ModelParameterSet, runtime_params: RuntimeParameterSet, cdr_forcing: Dataset | None = None, nesting_info: Dataset | None = None, **extra_data: Any)

Bases: Blueprint, ConfiguredBaseModel

Blueprint schema for running a ROMS-MARBL simulation.

Methods

RomsMarblBlueprint.serialize_with_schema_ref(...)

Attributes

RomsMarblBlueprint.cpus_needed	Number of CPUs needed for ROMS (derived from the partitioning parameters).
RomsMarblBlueprint.schema_version	The blueprint schema version.
RomsMarblBlueprint.application	The process type to be executed by the blueprint.
RomsMarblBlueprint.valid_start_date	Beginning of the time range for the available data.
RomsMarblBlueprint.valid_end_date	End of the time range for the available data.
RomsMarblBlueprint.code	Code repositories used to build, configure, and execute the ROMS simulation.
RomsMarblBlueprint.initial_conditions	File containing the starting conditions of the simulation.
RomsMarblBlueprint.grid	File defining the grid geometry.
RomsMarblBlueprint.forcing	Forcing configuration.
RomsMarblBlueprint.partitioning	User-defined partitioning parameters.
RomsMarblBlueprint.model_params	User-defined model parameters.
RomsMarblBlueprint.runtime_params	User-defined runtime parameters.
RomsMarblBlueprint.cdr_forcing	Location of CDR input file for this run.
RomsMarblBlueprint.nesting_info	Location of nesting info input file for this run.
RomsMarblBlueprint.name	A unique, user-friendly name for this blueprint.
RomsMarblBlueprint.description	A user-friendly description of the scenario to be executed by the blueprint.
RomsMarblBlueprint.state	The current validation status of the blueprint.
RomsMarblBlueprint.working_dir	Path to a directory where assets are stored when executing the blueprint.