tsdat.config.dataset
¶
Classes¶
Class defining the structure and metadata of the dataset produced by a tsdat |
-
class
tsdat.config.dataset.
DatasetConfig
[source]¶ Bases:
tsdat.config.utils.YamlModel
Class defining 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.
Class Methods
Method Descriptions
-
__getitem__
(self, name: str) → Union[tsdat.config.variables.Variable, tsdat.config.variables.Coordinate][source]¶
-
classmethod
set_variable_name_property
(cls, vars: Dict[str, Dict[str, Any]]) → Dict[str, Dict[str, Any]][source]¶
-
classmethod
time_in_coords
(cls, coords: Dict[VarName, tsdat.config.variables.Coordinate]) → Dict[VarName, tsdat.config.variables.Coordinate][source]¶
-
variable_names_are_legal
(cls, vars: Dict[str, tsdat.config.variables.Variable], field: pydantic.fields.ModelField) → Dict[str, tsdat.config.variables.Variable][source]¶