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.

Blueprint API

The Blueprint API is used to create and manage blueprints.

See also

Orchestration API

Blueprint Components

cstar.orchestration.models.ConfiguredBaseModel(...)	Base-model configuring common instantiation and validation behavior for subclasses.
cstar.orchestration.models.Resource(*, location)
cstar.orchestration.models.VersionedResource(*, ...)	A physical asset that is used as an input or configuration and has an associated hash used to identify a specific version.
cstar.orchestration.models.Dataset(*[, ...])	A dataset contains a data block alongside documentation and locking fields.
cstar.orchestration.models.PathFilter(*, ...)	A filter used to specify a subset of files.
cstar.orchestration.models.Blueprint(*, ...)	Common elements of all blueprints.

Simulation Components

cstar.applications.roms_marbl.models.ForcingConfiguration(*, ...)	Configuration of the forcing parameters of the model.
cstar.applications.roms_marbl.models.RuntimeParameterSet(*)	Parameters for the execution of the model.
cstar.applications.roms_marbl.models.PartitioningParameterSet(*)	Parameters for the partitioning of the model.
cstar.applications.roms_marbl.models.ModelParameterSet(*)	Parameters that can override ROMS.in values.

ROMS-MARBL

cstar.applications.roms_marbl.models.ROMSCompositeCodeRepository(*, ...)	Collection of repositories used to build, configure, and execute ROMS.
cstar.applications.roms_marbl.models.RomsMarblBlueprint(*, ...)	Blueprint schema for running a ROMS-MARBL simulation.