import_data

ProjectDataRegistry.import_data(dataset: str | Path | Dataset | DataArray, dataset_name: str | None = None, allow_overwrite: bool = False, ignore_existing: bool = False)[source]

Import a dataset.

Parameters:
  • dataset (str | Path | xr.Dataset | xr.DataArray) – Dataset instance or path to a dataset.

  • dataset_name (str | None) – The name of the dataset (needs to be provided when dataset is an xarray instance). Defaults to None.

  • allow_overwrite (bool) – Whether to overwrite an existing dataset.

  • ignore_existing (bool) – Whether to ignore import if the dataset already exists.

Raises:

ValueError – When importing from xarray object and not providing a name.