DataIoInterface

class glotaran.io.interface.DataIoInterface(format_name: str)

Bases: object

Baseclass for Data IO plugins.

Initialize a Data IO plugin with the name of the format.

Parameters

format_name (str) – Name of the supported format an instance uses.

Methods Summary

load_dataset	Read data from a file to xarray.Dataset or xarray.DataArray (NOT IMPLEMENTED).
save_dataset	Save data from xarray.Dataset to a file (NOT IMPLEMENTED).

Methods Documentation

load_dataset(file_name: str) → xr.Dataset | xr.DataArray

Read data from a file to xarray.Dataset or xarray.DataArray (NOT IMPLEMENTED).

Parameters

file_name (str) – File containing the data.

Returns

Data loaded from the file.

Return type

xr.Dataset|xr.DataArray

save_dataset(dataset: xr.Dataset | xr.DataArray, file_name: str)

Save data from xarray.Dataset to a file (NOT IMPLEMENTED).

Parameters

• dataset (xr.Dataset) – Dataset to be saved to file.

• file_name (str) – File to write the data to.