PartitioningParameterSet

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.

PartitioningParameterSet#

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

Bases: ParameterSet

Parameters for the partitioning of the model.

Attributes

PartitioningParameterSet.n_procs_x

Number of processes used to subdivide the domain on the x-axis.

PartitioningParameterSet.n_procs_y

Number of processes used to subdivide the domain on the y-axis.

PartitioningParameterSet.hash

Hash used to verify the parameters are unchanged.

PartitioningParameterSet.documentation

Description of input data provenance; used in provenance roll-up.

PartitioningParameterSet.locked

Mutability of the parameter set.