tsdat.config.dataset

Classes

DatasetConfig

Defines the structure and metadata of the dataset produced by a tsdat pipeline.
class tsdat.config.dataset.DatasetConfig[source]

Bases: tsdat.config.utils.YamlModel

Defines the structure and metadata of the dataset produced by a tsdat pipeline.

Also provides methods to support yaml parsing and validation, including generation of json schema.

Parameters:

  • attrs (GlobalAttributes) – Attributes that pertain to the dataset as a whole.

  • coords (Dict[str, Coordinate]) – The dataset’s coordinate variables.

  • data_vars (Dict[str, Variable]) – The dataset’s data variables.

attrs: tsdat.config.attributes.GlobalAttributes[source]
coords: Dict[str, tsdat.config.variables.Coordinate][source]
data_vars: Dict[str, tsdat.config.variables.Variable][source]

Class Methods

__contains__

__getitem__

set_variable_name_property

time_in_coords

validate_variable_name_uniqueness

variable_names_are_legal

Method Descriptions

__contains__(__o: object) → bool[source]
__getitem__(name: str) → tsdat.config.variables.Variable | tsdat.config.variables.Coordinate[source]
classmethod set_variable_name_property(vars: Dict[str, Dict[str, Any]]) → Dict[str, Dict[str, Any]][source]
classmethod time_in_coords(coords: Dict[str, tsdat.config.variables.Coordinate]) → Dict[str, tsdat.config.variables.Coordinate][source]
classmethod validate_variable_name_uniqueness(values: Any) → Any[source]