Returns:: A tuple of the io_type_tag under which the deserializer is registered with the Shnitsel Tools framework (or None if no deserialization is desired/supported)/ Then the `xr.Dataset that is the result of the conversion. And lastly a dict of metadata that might help with deserialization later on.
Return type:: tuple[str, xr.Dataset, MetaData]
Raises:: ValueError – If the conversion failed for some reason.

classmethod get_type_marker()#

Return type:: str

classmethod from_xr_dataset(dataset, metadata)#

Class method to support standardized deserialization of arbitrary classes. Implemented as a class method to avoid need to construct instance for deserialization.

Parameters:

cls (type[ResType]) – The class executing the deserialization.
dataset (xr.Dataset) – The dataset to be deserialized into the output type.
metadata (MetaData) – Metdatata from the serialization process.

Returns:

The deserialized instance of the target class.

Return type:

instance of cls

Raises:

TypeError – If deserialization of the object was not possible

shnitsel.data.dataset_containers.inter_state#

Classes#

Module Contents#

This Page