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.

InputDataset

class cstar.base.input_dataset.InputDataset(location: str, file_hash: str | None = None, start_date: str | datetime | None = None, end_date: str | datetime | None = None)

Bases: ABC, LoggingMixin

Describes spatiotemporal data needed to run a unique instance of a model simulation.

Attributes:

source: SourceData

Describes the location of and classifies the source data

working_copy: StagedFile or StagedDataCollection or None

Describes the locally staged version (if any) of the data

exists_locally: bool

True if this InputDataset has been staged for use locally

Methods:

get(local_dir) -> StagedFile | StagedDataCollection

Stage this InputDataset for local use by C-Star

Methods

InputDataset.get(local_dir)	Make this InputDataset locally available in local_dir.
InputDataset.to_dict()	Represent this InputDataset object as a dictionary of kwargs.

Attributes

InputDataset.exists_locally	Check if an unmodified version of this InputDataset exists on the local filesystem.
InputDataset.log	Return the logger instance for this class.
InputDataset.working_copy	Describes the (if any) locally available copy of this InputDataset.