Dataset

Contents

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.

Dataset#

class cstar.orchestration.models.Dataset(*, documentation: str = '', locked: bool = False, data: list[Resource | VersionedResource], **extra_data: Any)#

Bases: DocLocMixin

A dataset contains a data block alongside documentation and locking fields.

Attributes

Dataset.data

A list of one or more data resources.

Dataset.documentation

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

Dataset.locked

Mutability of the parameter set.