dataset
Classes#
ACDDDatasetConfig #
Bases: DatasetConfig
DatasetConfig #
Bases: 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:
Name | Type | Description | Default |
---|---|---|---|
attrs |
GlobalAttributes
|
Attributes that pertain to the dataset as a whole. |
required |
coords |
Dict[str, Coordinate]
|
The dataset's coordinate variables. |
required |
data_vars |
Dict[str, Variable]
|
The dataset's data variables. |
required |
Attributes#
attrs
class-attribute
instance-attribute
#
attrs: GlobalAttributes = Field(
description="Attributes that pertain to the dataset as a whole (as opposed to attributes that are specific to individual variables."
)
coords
class-attribute
instance-attribute
#
coords: Dict[str, Coordinate] = Field(
description="This section defines the coordinate variables that the rest of the data are dimensioned by. Coordinate variable data can either be retrieved from an input data source or defined statically via the 'data' property. Note that tsdat requires the dataset at least be dimensioned by a 'time' variable. Most datasets will only need the 'time' coordinate variable, but multidimensional datasets (e.g., ADCP or Lidar data (time, height)) are well-supported. Note that the 'dims' attribute is still required for coordinate variables, and that this value should be [<name>], where <name> is the name of the coord (e.g., 'time')."
)
data_vars
class-attribute
instance-attribute
#
data_vars: Dict[str, Variable] = Field(
description="This section defines the data variables that the output dataset will contain. Variable data can either be retrieved from an input data source, defined statically via the 'data' property, or initalized to missing and set dynamically via user code in a tsdat pipeline."
)
Functions#
set_variable_name_property
classmethod
#
time_in_coords
classmethod
#
validate_variable_name_uniqueness
classmethod
#
Source code in tsdat/config/dataset.py
variable_names_are_legal #
Source code in tsdat/config/dataset.py
IOOSDatasetConfig #
Bases: DatasetConfig