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.

Workplan

class cstar.orchestration.models.Workplan(*, name: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=True, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None, ascii_only=None)], description: ~typing.Annotated[str, ~pydantic.types.StringConstraints(strip_whitespace=True, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=None, ascii_only=None)], steps: ~typing.Annotated[~collections.abc.Sequence[~typing.Annotated[~cstar.orchestration.models.Step, ~pydantic.functional_serializers.SerializeAsAny()]], ~annotated_types.MinLen(min_length=1)], state: ~cstar.orchestration.models.WorkplanState = WorkplanState.NotSet, compute_environment: dict[str, str | float | list[str] | list[float] | dict[str, ~typing.Any]] = <factory>, runtime_vars: list[str] = <factory>)

Bases: BaseModel

A collection of executable steps and the associated configuration to run them.

Attributes

Workplan.name	The user-friendly name of the workplan.
Workplan.description	A user-friendly description of the workplan.
Workplan.steps	The steps to be executed by the workplan.
Workplan.state	The current validation status of the workplan.
Workplan.compute_environment	A collection of key-value pairs specifying attributes for the target compute environment.
Workplan.runtime_vars	A collection of user-defined variables that will be populated at runtime.