zarr.creation

Helpers for creating arrays.

Warning

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

Functions

array(→ zarr.core.array.Array)	Create an array filled with data.
create(→ zarr.core.array.Array)	Create an array.
empty(→ zarr.core.array.Array)	Create an empty array.
empty_like(→ zarr.core.array.Array)	Create an empty array like another array.
full(→ zarr.core.array.Array)	Create an array with a default fill value.
full_like(→ zarr.core.array.Array)	Create a filled array like another array.
ones(→ zarr.core.array.Array)	Create an array with a fill value of one.
ones_like(→ zarr.core.array.Array)	Create an array of ones like another array.
open_array(→ zarr.core.array.Array)	Open an array using file-mode-like semantics.
open_like(→ zarr.core.array.Array)	Open a persistent array like another array.
zeros(→ zarr.core.array.Array)	Create an array with a fill value of zero.
zeros_like(→ zarr.core.array.Array)	Create an array of zeros like another array.

Module Contents

zarr.creation.array(data: numpy.typing.ArrayLike, **kwargs: Any) → zarr.core.array.Array

Create an array filled with data.

Parameters:

dataarray_like

The data to fill the array with.

**kwargs

Passed through to create().

Returns:

arrayArray

The new array.

zarr.creation.create(

shape: zarr.core.common.ChunkCoords | int,

*,

chunks: zarr.core.common.ChunkCoords | int | bool | None = None,

dtype: numpy.typing.DTypeLike | None = None,

compressor: dict[str, zarr.core.common.JSON] | None = None,

fill_value: Any | None = 0,

order: zarr.core.common.MemoryOrder | None = None,

store: str | zarr.storage.StoreLike | None = None,

synchronizer: Any | None = None,

overwrite: bool = False,

path: zarr.api.asynchronous.PathLike | None = None,

chunk_store: zarr.storage.StoreLike | None = None,

filters: list[dict[str, zarr.core.common.JSON]] | None = None,

cache_metadata: bool | None = None,

cache_attrs: bool | None = None,

read_only: bool | None = None,

object_codec: zarr.abc.codec.Codec | None = None,

dimension_separator: Literal['.', '/'] | None = None,

write_empty_chunks: bool | None = None,

zarr_version: zarr.core.common.ZarrFormat | None = None,

zarr_format: zarr.core.common.ZarrFormat | None = None,

meta_array: Any | None = None,

attributes: dict[str, zarr.core.common.JSON] | None = None,

chunk_shape: zarr.core.common.ChunkCoords | int | None = None,

chunk_key_encoding: zarr.core.chunk_key_encodings.ChunkKeyEncoding | tuple[Literal['default'], Literal['.', '/']] | tuple[Literal['v2'], Literal['.', '/']] | None = None,

codecs: collections.abc.Iterable[zarr.abc.codec.Codec | dict[str, zarr.core.common.JSON]] | None = None,

dimension_names: collections.abc.Iterable[str] | None = None,

storage_options: dict[str, Any] | None = None,

config: zarr.core.array_spec.ArrayConfig | zarr.core.array_spec.ArrayConfigLike | None = None,

**kwargs: Any,

) → zarr.core.array.Array

Create an array.

Parameters:

shapeint or tuple of ints

Array shape.

chunksint or tuple of ints, optional

Chunk shape. If True, will be guessed from shape and dtype. If False, will be set to shape, i.e., single chunk for the whole array. If an int, the chunk size in each dimension will be given by the value of chunks. Default is True.

dtypestr or dtype, optional

NumPy dtype.

compressorCodec, optional

Primary compressor.

fill_valueobject

Default value to use for uninitialized portions of the array.

order{‘C’, ‘F’}, optional

Deprecated in favor of the config keyword argument. Pass {'order': <value>} to create instead of using this parameter. Memory layout to be used within each chunk. If not specified, the array.order parameter in the global config will be used.

storeStore or str

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

synchronizerobject, optional

Array synchronizer.

overwritebool, optional

If True, delete all pre-existing data in store at path before creating the array.

pathstr, optional

Path under which array is stored.

chunk_storeMutableMapping, optional

Separate storage for chunks. If not provided, store will be used for storage of both chunks and metadata.

filterssequence of Codecs, optional

Sequence of filters to use to encode chunk data prior to compression.

cache_metadatabool, optional

If True, array configuration metadata will be cached for the lifetime of the object. If False, array metadata will be reloaded prior to all data access and modification operations (may incur overhead depending on storage and data access pattern).

cache_attrsbool, optional

If True (default), user attributes will be cached for attribute read operations. If False, user attributes are reloaded from the store prior to all attribute read operations.

read_onlybool, optional

True if array should be protected against modification.

object_codecCodec, optional

A codec to encode object arrays, only needed if dtype=object.

dimension_separator{‘.’, ‘/’}, optional

Separator placed between the dimensions of a chunk.

write_empty_chunksbool, optional

Deprecated in favor of the config keyword argument. Pass {'write_empty_chunks': <value>} to create instead of using this parameter. If True, all chunks will be stored regardless of their contents. If False, each chunk is compared to the array’s fill value prior to storing. If a chunk is uniformly equal to the fill value, then that chunk is not be stored, and the store entry for that chunk’s key is deleted.

zarr_format{2, 3, None}, optional

The zarr format to use when saving.

meta_arrayarray-like, optional

An array instance to use for determining arrays to create and return to users. Use numpy.empty(()) by default.

storage_optionsdict

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

configArrayConfig or ArrayConfigLike, optional

Runtime configuration of the array. If provided, will override the default values from zarr.config.array.

Returns:

zArray

The array.

zarr.creation.empty(

shape: zarr.core.common.ChunkCoords,

**kwargs: Any,

) → zarr.core.array.Array

Create an empty array.

Parameters:

shapeint or tuple of int

Shape of the empty array.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.

Notes

The contents of an empty Zarr array are not defined. On attempting to retrieve data from an empty Zarr array, any values may be returned, and these are not guaranteed to be stable from one access to the next.

zarr.creation.empty_like(

a: zarr.api.asynchronous.ArrayLike,

**kwargs: Any,

) → zarr.core.array.Array

Create an empty array like another array.

Parameters:

aarray-like

The array to create an empty array like.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.

zarr.creation.full(

shape: zarr.core.common.ChunkCoords,

fill_value: Any,

**kwargs: Any,

) → zarr.core.array.Array

Create an array with a default fill value.

Parameters:

shapeint or tuple of int

Shape of the empty array.

fill_valuescalar

Fill value.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.

zarr.creation.full_like(

a: zarr.api.asynchronous.ArrayLike,

**kwargs: Any,

) → zarr.core.array.Array

Create a filled array like another array.

Parameters:

aarray-like

The array to create an empty array like.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.

zarr.creation.ones(

shape: zarr.core.common.ChunkCoords,

**kwargs: Any,

) → zarr.core.array.Array

Create an array with a fill value of one.

Parameters:

shapeint or tuple of int

Shape of the empty array.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.

zarr.creation.ones_like(

a: zarr.api.asynchronous.ArrayLike,

**kwargs: Any,

) → zarr.core.array.Array

Create an array of ones like another array.

Parameters:

aarray-like

The array to create an empty array like.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.

zarr.creation.open_array(

store: zarr.storage.StoreLike | None = None,

*,

zarr_version: zarr.core.common.ZarrFormat | None = None,

path: zarr.api.asynchronous.PathLike = '',

storage_options: dict[str, Any] | None = None,

**kwargs: Any,

) → zarr.core.array.Array

Open an array using file-mode-like semantics.

Parameters:

storeStore or str

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

zarr_version{2, 3, None}, optional

The zarr format to use when saving.

pathstr, optional

Path in store to array.

storage_optionsdict

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

**kwargs

Any keyword arguments to pass to create.

Returns:

AsyncArray

The opened array.

zarr.creation.open_like(

a: zarr.api.asynchronous.ArrayLike,

path: str,

**kwargs: Any,

) → zarr.core.array.Array

Open a persistent array like another array.

Parameters:

aArray

The shape and data-type of a define these same attributes of the returned array.

pathstr

The path to the new array.

**kwargs

Any keyword arguments to pass to the array constructor.

Returns:

AsyncArray

The opened array.

zarr.creation.zeros(

shape: zarr.core.common.ChunkCoords,

**kwargs: Any,

) → zarr.core.array.Array

Create an array with a fill value of zero.

Parameters:

shapeint or tuple of int

Shape of the empty array.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.

zarr.creation.zeros_like(

a: zarr.api.asynchronous.ArrayLike,

**kwargs: Any,

) → zarr.core.array.Array

Create an array of zeros like another array.

Parameters:

aarray-like

The array to create an empty array like.

**kwargs

Keyword arguments passed to zarr.api.asynchronous.create().

Returns:

Array

The new array.