zarr.convenience#

Functions#

consolidate_metadata(→ zarr.core.group.Group)

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

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

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

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

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

open_consolidated(→ zarr.core.group.Group)

save(→ None)

save_array(→ None)

save_group(→ None)

tree(→ None)

Module Contents#

zarr.convenience.consolidate_metadata(*args: Any, **kwargs: Any) → zarr.core.group.Group[source]#
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,
zarr_version: zarr.core.common.ZarrFormat | None = None,
path: str | None = None,
) → zarr.core.buffer.NDArrayLike | dict[str, zarr.core.buffer.NDArrayLike][source]#
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,
**kwargs: Any,
) → zarr.core.array.Array | zarr.core.group.Group[source]#
zarr.convenience.open_consolidated(
*args: Any,
use_consolidated: Literal[True] = True,
**kwargs: Any,
) → zarr.core.group.Group[source]#
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]#
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,
**kwargs: Any,
) → None[source]#
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]#
zarr.convenience.tree(*args: Any, **kwargs: Any) → None[source]#