cf_xarray.decode_compress_to_multi_index#

cf_xarray.decode_compress_to_multi_index(encoded, idxnames=None)[source]#

Decode a compressed variable to a pandas MultiIndex.

Parameters:
encodedxarray.Dataset

Encoded Dataset with variables that use “compression by gathering”.capitalize.

idxnameshashable or iterable of hashable, optional

Variable names that represents a compressed dimension. These variables must have the attribute "compress". If None, will detect all indexes with a "compress" attribute and decode those.

Returns:
xarray.Dataset

Decoded Dataset with name as a MultiIndexed dimension.

References

CF conventions on compression by gathering