load_dataset

glotaran.plugin_system.data_io_registration.load_dataset(file_name: StrOrPath, format_name: str | None = None, **kwargs: Any) → xr.Dataset[source]

Read data from a file to xarray.Dataset or xarray.DataArray.

Parameters:

  • file_name (StrOrPath) – File containing the data.

  • format_name (str) – Format the file is in, if not provided it will be inferred from the file extension.

  • **kwargs (Any) – Additional keyword arguments passes to the read_dataset implementation of the data io plugin. If you aren’t sure about those use get_dataloader to get the implementation with the proper help and autocomplete.

Returns:

Data loaded from the file.

Return type:

xr.Dataset