tsdat.config.variables

Classes

Coordinate
Variable
VariableAttributes	Attributes that will be recorded in the output dataset.

class tsdat.config.variables.Coordinate

Bases: Variable

Class Methods

coord_dimensioned_by_self

Method Descriptions

classmethod coord_dimensioned_by_self(values: Any) → Any

class tsdat.config.variables.Variable

Bases: pydantic.BaseModel

attrs: VariableAttributes

data: Any | None

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(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 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: pydantic.StrictStr | None

fail_delta: float | None

fail_range: List[float] | None

fill_value: Any | None

long_name: pydantic.StrictStr | None

standard_name: pydantic.StrictStr | None

units: str | None

valid_delta: float | None

valid_range: List[float] | None

warn_delta: float | None

warn_range: List[float] | None

Class Methods

validate_unit
validate_units_are_commented

Method Descriptions

validate_unit(unit_str: str) → str

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