zarr.convenience#

Convenience helpers.

Warning

This sub-module is deprecated. All functions here are defined in the top level zarr namespace instead.

Functions#

consolidate_metadata(→ zarr.core.group.Group)

Consolidate the metadata of all nodes in a hierarchy.

copy(→ tuple[int, int, int])

copy_all(→ tuple[int, int, int])

copy_store(→ tuple[int, int, int])

load(→ zarr.core.buffer.NDArrayLike | dict[str, ...)

Load data from an array or group into memory.

open(→ zarr.core.array.Array | zarr.core.group.Group)

Open a group or array using file-mode-like semantics.

open_consolidated(→ zarr.core.group.Group)

Alias for open_group() with use_consolidated=True.

save(→ None)

Save an array or group of arrays to the local file system.

save_array(→ None)

Save a NumPy array to the local file system.

save_group(→ None)

Save several NumPy arrays to the local file system.

tree(→ Any)

Provide a rich display of the hierarchy.

Module Contents#

zarr.convenience.consolidate_metadata(
store: zarr.storage.StoreLike,
path: str | None = None,
zarr_format: zarr.core.common.ZarrFormat | None = None,
) → zarr.core.group.Group[source]#

Consolidate the metadata of all nodes in a hierarchy.

Upon completion, the metadata of the root node in the Zarr hierarchy will be updated to include all the metadata of child nodes.

Parameters:
storeStoreLike

The store-like object whose metadata you wish to consolidate.

pathstr, optional

A path to a group in the store to consolidate at. Only children below that group will be consolidated.

By default, the root node is used so all the metadata in the store is consolidated.

zarr_format{2, 3, None}, optional

The zarr format of the hierarchy. By default the zarr format is inferred.

Returns:
group: Group

The group, with the consolidated_metadata field set to include the metadata of each child node.

zarr.convenience.copy(*args: Any, **kwargs: Any) → tuple[int, int, int][source]#
zarr.convenience.copy_all(*args: Any, **kwargs: Any) → tuple[int, int, int][source]#
zarr.convenience.copy_store(*args: Any, **kwargs: Any) → tuple[int, int, int][source]#
zarr.convenience.load(
store: zarr.storage.StoreLike,
path: str | None = None,
zarr_format: zarr.core.common.ZarrFormat | None = None,
zarr_version: zarr.core.common.ZarrFormat | None = None,
) → zarr.core.buffer.NDArrayLike | dict[str, zarr.core.buffer.NDArrayLike][source]#

Load data from an array or group into memory.

Parameters:
storeStore or str

Store or path to directory in file system or name of zip file.

pathstr or None, optional

The path within the store from which to load.

Returns:
out

If the path contains an array, out will be a numpy array. If the path contains a group, out will be a dict-like object where keys are array names and values are numpy arrays.

See also

save, savez

Notes

If loading data from a group of arrays, data will not be immediately loaded into memory. Rather, arrays will be loaded into memory as they are requested.

zarr.convenience.open(
store: zarr.storage.StoreLike | None = None,
*,
mode: zarr.core.common.AccessModeLiteral = 'a',
zarr_version: zarr.core.common.ZarrFormat | None = None,
zarr_format: zarr.core.common.ZarrFormat | None = None,
path: str | None = None,
storage_options: dict[str, Any] | None = None,
**kwargs: Any,
) → zarr.core.array.Array | zarr.core.group.Group[source]#

Open a group or array using file-mode-like semantics.

Parameters:
storeStore or str, optional

Store or path to directory in file system or name of zip file.

mode{‘r’, ‘r+’, ‘a’, ‘w’, ‘w-‘}, optional

Persistence mode: ‘r’ means read only (must exist); ‘r+’ means read/write (must exist); ‘a’ means read/write (create if doesn’t exist); ‘w’ means create (overwrite if exists); ‘w-’ means create (fail if exists).

zarr_format{2, 3, None}, optional

The zarr format to use when saving.

pathstr or None, optional

The path within the store to open.

storage_optionsdict

If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise.

**kwargs

Additional parameters are passed through to zarr.api.asynchronous.open_array() or zarr.api.asynchronous.open_group().

Returns:
zarray or group

Return type depends on what exists in the given store.

zarr.convenience.open_consolidated(
*args: Any,
use_consolidated: Literal[True] = True,
**kwargs: Any,
) → zarr.core.group.Group[source]#

Alias for open_group() with use_consolidated=True.

zarr.convenience.save(
store: zarr.storage.StoreLike,
*args: zarr.core.buffer.NDArrayLike,
zarr_version: zarr.core.common.ZarrFormat | None = None,
zarr_format: zarr.core.common.ZarrFormat | None = None,
path: str | None = None,
**kwargs: Any,
) → None[source]#

Save an array or group of arrays to the local file system.

Parameters:
storeStore or str

Store or path to directory in file system or name of zip file.

*argsndarray

NumPy arrays with data to save.

zarr_format{2, 3, None}, optional

The zarr format to use when saving.

pathstr or None, optional

The path within the group where the arrays will be saved.

**kwargs

NumPy arrays with data to save.

zarr.convenience.save_array(
store: zarr.storage.StoreLike,
arr: zarr.core.buffer.NDArrayLike,
*,
zarr_version: zarr.core.common.ZarrFormat | None = None,
zarr_format: zarr.core.common.ZarrFormat | None = None,
path: str | None = None,
storage_options: dict[str, Any] | None = None,
**kwargs: Any,
) → None[source]#

Save a NumPy array to the local file system.

Follows a similar API to the NumPy save() function.

Parameters:
storeStore or str

Store or path to directory in file system or name of zip file.

arrndarray

NumPy array with data to save.

zarr_format{2, 3, None}, optional

The zarr format to use when saving.

pathstr or None, optional

The path within the store where the array will be saved.

storage_optionsdict

If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise.

**kwargs

Passed through to create(), e.g., compressor.

zarr.convenience.save_group(
store: zarr.storage.StoreLike,
*args: zarr.core.buffer.NDArrayLike,
zarr_version: zarr.core.common.ZarrFormat | None = None,
zarr_format: zarr.core.common.ZarrFormat | None = None,
path: str | None = None,
storage_options: dict[str, Any] | None = None,
**kwargs: zarr.core.buffer.NDArrayLike,
) → None[source]#

Save several NumPy arrays to the local file system.

Follows a similar API to the NumPy savez()/savez_compressed() functions.

Parameters:
storeStore or str

Store or path to directory in file system or name of zip file.

*argsndarray

NumPy arrays with data to save.

zarr_format{2, 3, None}, optional

The zarr format to use when saving.

pathstr or None, optional

Path within the store where the group will be saved.

storage_optionsdict

If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise.

**kwargs

NumPy arrays with data to save.

zarr.convenience.tree(
grp: zarr.core.group.Group,
expand: bool | None = None,
level: int | None = None,
) → Any[source]#

Provide a rich display of the hierarchy.

Deprecated since version 3.0.0: zarr.tree() is deprecated and will be removed in a future release. Use group.tree() instead.

Parameters:
grpGroup

Zarr or h5py group.

expandbool, optional

Only relevant for HTML representation. If True, tree will be fully expanded.

levelint, optional

Maximum depth to descend into hierarchy.

Returns:
TreeRepr

A pretty-printable object displaying the hierarchy.