save_dataset

glotaran.plugin_system.data_io_registration.save_dataset(dataset: xr.Dataset | xr.DataArray, file_name: StrOrPath, format_name: str | None = None, *, data_filters: list[str] | None = None, allow_overwrite: bool = False, update_source_path: bool = True, **kwargs: Any) → None[source]

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

Parameters:

  • dataset (xr.Dataset | xr.DataArray) – Data to be written to file.

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

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

  • data_filters (list[str] | None) – Optional list of items in the dataset to be saved.

  • allow_overwrite (bool) – Whether or not to allow overwriting existing files, by default False

  • update_source_path (bool) – Whether or not to update the source_path attribute to file_name when saving. by default True

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