tsdat.config.variables

Classes

Coordinate
Variable
VariableAttributes	Attributes that will be recorded in the output dataset. These metadata are used to

class tsdat.config.variables.Coordinate

Bases: Variable

Class Methods

coord_dimensioned_by_self

Method Descriptions

classmethod coord_dimensioned_by_self(cls, values: Any) → Any

class tsdat.config.variables.Variable

Bases: pydantic.BaseModel

attrs :VariableAttributes

data :Optional[Any]

dims :List[pydantic.StrictStr]

dtype :pydantic.StrictStr

name :str

Should be left empty. This property will be set automatically by the data_vars or coords pydantic model upon instantiation.

Class Methods

set_default_fill_value

Method Descriptions

classmethod set_default_fill_value(cls, attrs: VariableAttributes, values: Dict[str, Any]) → VariableAttributes

class tsdat.config.variables.VariableAttributes

Bases: tsdat.config.attributes.AttributeModel

Attributes that will be recorded in the output dataset. These metadata are used to record information about the data properties and related fields (e.g., units, ancillary_variables, etc), user-facing metadata (e.g., long_name, comment), as well as attributes related to quality checks and controls (e.g., valid_*, fail_*, and warn_* properties).

comment :Optional[pydantic.StrictStr]

fail_delta :Optional[float]

fail_range :Optional[List[float]]

fill_value :Optional[Any]

long_name :Optional[pydantic.StrictStr]

standard_name :Optional[pydantic.StrictStr]

units :Optional[str]

valid_delta :Optional[float]

valid_range :Optional[List[float]]

warn_delta :Optional[float]

warn_range :Optional[List[float]]

Class Methods

validate_units_are_commented

Method Descriptions

classmethod validate_units_are_commented(cls, values: Dict[str, Any]) → Dict[str, Any]