tsdat.config.attributes

Classes

AttributeModel

GlobalAttributes

Global attributes that will be recorded in the output dataset. These metadata are
class tsdat.config.attributes.AttributeModel[source]

Bases: pydantic.BaseModel

Class Methods

validate_all_ascii

Method Descriptions

classmethod validate_all_ascii(cls, values: Dict[Any, Any]) → Dict[str, str][source]
class tsdat.config.attributes.GlobalAttributes[source]

Bases: AttributeModel

Global attributes that will be recorded in the output dataset. These metadata are used to record data provenance information (e.g., location, institution, etc), construct datastream and file names (i.e., location_id, dataset_name, qualifier, temporal, and data_level attributes), as well as provide metadata that is useful for data users (e.g., title, description, … ).

code_url :Optional[pydantic.HttpUrl][source]
code_version :pydantic.StrictStr[source]
conventions :Optional[pydantic.StrictStr][source]
data_level :str[source]
dataset_name :str[source]
datastream :pydantic.StrictStr[source]
description :str[source]
doi :Optional[pydantic.StrictStr][source]
history :pydantic.StrictStr[source]
institution :Optional[pydantic.StrictStr][source]
location_id :str[source]
qualifier :Optional[str][source]
references :Optional[pydantic.StrictStr][source]
temporal :Optional[str][source]
title :str[source]

Class Methods

add_datastream_field

warn_if_dynamic_properties_are_set

Method Descriptions

classmethod add_datastream_field(cls, values: Dict[str, pydantic.StrictStr]) → Dict[str, pydantic.StrictStr][source]
classmethod warn_if_dynamic_properties_are_set(cls, v: str, field: pydantic.fields.ModelField) → str[source]