sgkit.load_dataset

sgkit.load_dataset(store, storage_options=None, **kwargs)

Load a dataset from Zarr storage.

This function is a thin wrapper around xarray.open_zarr() that uses sensible defaults and makes it easier to use in a pipeline.

Parameters

store : str | Path | MutableMapping[str, bytes]Union[str, Path, MutableMapping[str, bytes]]

Zarr store or path to directory in file system to load from.

storage_options : {str: str} | NoneOptional[Dict[str, str]] (default: None)

Any additional parameters for the storage backend (see fsspec.open).

kwargs : Any

Additional arguments to pass to xarray.open_zarr().

Return type

Dataset

Returns

Dataset The dataset loaded from the Zarr store or file system.