zarr.api.synchronous#
Functions#
|
Create an array filled with data. |
|
Consolidate the metadata of all nodes in a hierarchy. |
|
|
|
|
|
|
|
Create an array. |
|
Create an array. |
|
Create an empty array with the specified shape. The contents will be filled with the |
|
Create an empty array like another array. The contents will be filled with the |
|
Create an array with a default fill value. |
|
Create a filled array like another array. |
|
Create a group. |
|
Load data from an array or group into memory. |
|
Create an array with a fill value of one. |
|
Create an array of ones like another array. |
|
Open a group or array using file-mode-like semantics. |
|
Open an array using file-mode-like semantics. |
|
Alias for |
|
Open a group using file-mode-like semantics. |
|
Open a persistent array like another array. |
|
Save an array or group of arrays to the local file system. |
|
Save a NumPy array to the local file system. |
|
Save several NumPy arrays to the local file system. |
|
Provide a rich display of the hierarchy. |
|
Create an array with a fill value of zero. |
|
Create an array of zeros like another array. |
Module Contents#
- zarr.api.synchronous.array(data: numpy.typing.ArrayLike, **kwargs: Any) zarr.core.array.Array [source]#
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.api.synchronous.consolidate_metadata(
- store: zarr.storage.StoreLike,
- path: str | None = None,
- zarr_format: zarr.core.common.ZarrFormat | None = None,
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.api.synchronous.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.ArrayConfigLike | None = None,
- **kwargs: Any,
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>}
tocreate
instead of using this parameter. Memory layout to be used within each chunk. If not specified, thearray.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>}
tocreate
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.
- configArrayConfigLike, optional
Runtime configuration of the array. If provided, will override the default values from zarr.config.array.
- Returns:
- zArray
The array.
- zarr.api.synchronous.create_array(
- store: str | zarr.storage.StoreLike,
- *,
- name: str | None = None,
- shape: zarr.core.common.ShapeLike | None = None,
- dtype: numpy.typing.DTypeLike | None = None,
- data: numpy.ndarray[Any, numpy.dtype[Any]] | None = None,
- chunks: zarr.core.common.ChunkCoords | Literal['auto'] = 'auto',
- shards: zarr.core.array.ShardsLike | None = None,
- filters: zarr.core.array.FiltersLike = 'auto',
- compressors: zarr.core.array.CompressorsLike = 'auto',
- serializer: zarr.core.array.SerializerLike = 'auto',
- fill_value: Any | None = None,
- order: zarr.core.common.MemoryOrder | None = None,
- zarr_format: zarr.core.common.ZarrFormat | None = 3,
- attributes: dict[str, zarr.core.common.JSON] | None = None,
- chunk_key_encoding: zarr.core.chunk_key_encodings.ChunkKeyEncoding | zarr.core.chunk_key_encodings.ChunkKeyEncodingLike | None = None,
- dimension_names: collections.abc.Iterable[str] | None = None,
- storage_options: dict[str, Any] | None = None,
- overwrite: bool = False,
- config: zarr.core.array_spec.ArrayConfigLike | None = None,
Create an array.
This function wraps
zarr.core.array.create_array()
.- Parameters:
- storestr or Store
Store or path to directory in file system or name of zip file.
- namestr or None, optional
The name of the array within the store. If
name
isNone
, the array will be located at the root of the store.- shapeChunkCoords, optional
Shape of the array. Can be
None
ifdata
is provided.- dtypenpt.DTypeLike, optional
Data type of the array. Can be
None
ifdata
is provided.- datanp.ndarray, optional
Array-like data to use for initializing the array. If this parameter is provided, the
shape
anddtype
parameters must be identical todata.shape
anddata.dtype
, orNone
.- chunksChunkCoords, optional
Chunk shape of the array. If not specified, default are guessed based on the shape and dtype.
- shardsChunkCoords, optional
Shard shape of the array. The default value of
None
results in no sharding at all.- filtersIterable[Codec], optional
Iterable of filters to apply to each chunk of the array, in order, before serializing that chunk to bytes.
For Zarr format 3, a “filter” is a codec that takes an array and returns an array, and these values must be instances of
ArrayArrayCodec
, or dict representations ofArrayArrayCodec
. If nofilters
are provided, a default set of filters will be used. These defaults can be changed by modifying the value ofarray.v3_default_filters
inzarr.core.config
. UseNone
to omit default filters.For Zarr format 2, a “filter” can be any numcodecs codec; you should ensure that the the order if your filters is consistent with the behavior of each filter. If no
filters
are provided, a default set of filters will be used. These defaults can be changed by modifying the value ofarray.v2_default_filters
inzarr.core.config
. UseNone
to omit default filters.- compressorsIterable[Codec], optional
List of compressors to apply to the array. Compressors are applied in order, and after any filters are applied (if any are specified) and the data is serialized into bytes.
For Zarr format 3, a “compressor” is a codec that takes a bytestream, and returns another bytestream. Multiple compressors my be provided for Zarr format 3. If no
compressors
are provided, a default set of compressors will be used. These defaults can be changed by modifying the value ofarray.v3_default_compressors
inzarr.core.config
. UseNone
to omit default compressors.For Zarr format 2, a “compressor” can be any numcodecs codec. Only a single compressor may be provided for Zarr format 2. If no
compressor
is provided, a default compressor will be used. inzarr.core.config
. UseNone
to omit the default compressor.- serializerdict[str, JSON] | ArrayBytesCodec, optional
Array-to-bytes codec to use for encoding the array data. Zarr format 3 only. Zarr format 2 arrays use implicit array-to-bytes conversion. If no
serializer
is provided, a default serializer will be used. These defaults can be changed by modifying the value ofarray.v3_default_serializer
inzarr.core.config
.- fill_valueAny, optional
Fill value for the array.
- order{“C”, “F”}, optional
The memory of the array (default is “C”). For Zarr format 2, this parameter sets the memory order of the array. For Zarr format 3, this parameter is deprecated, because memory order is a runtime parameter for Zarr format 3 arrays. The recommended way to specify the memory order for Zarr format 3 arrays is via the
config
parameter, e.g.{'config': 'C'}
. If noorder
is provided, a default order will be used. This default can be changed by modifying the value ofarray.order
inzarr.core.config
.- zarr_format{2, 3}, optional
The zarr format to use when saving.
- attributesdict, optional
Attributes for the array.
- chunk_key_encodingChunkKeyEncoding, optional
A specification of how the chunk keys are represented in storage. For Zarr format 3, the default is
{"name": "default", "separator": "/"}}
. For Zarr format 2, the default is{"name": "v2", "separator": "."}}
.- dimension_namesIterable[str], optional
The names of the dimensions (default is None). Zarr format 3 only. Zarr format 2 arrays should not use this parameter.
- storage_optionsdict, optional
If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise.
- overwritebool, default False
Whether to overwrite an array with the same name in the store, if one exists.
- configArrayConfigLike, optional
Runtime configuration for the array.
- Returns:
- Array
The array.
Examples
>>> import zarr >>> store = zarr.storage.MemoryStore(mode='w') >>> arr = await zarr.create_array( >>> store=store, >>> shape=(100,100), >>> chunks=(10,10), >>> dtype='i4', >>> fill_value=0) <Array memory://140349042942400 shape=(100, 100) dtype=int32>
- zarr.api.synchronous.empty(
- shape: zarr.core.common.ChunkCoords,
- **kwargs: Any,
Create an empty array with the specified shape. The contents will be filled with the array’s fill value or zeros if no fill value is provided.
- 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.api.synchronous.empty_like(
- a: zarr.api.asynchronous.ArrayLike,
- **kwargs: Any,
Create an empty array like another array. The contents will be filled with the array’s fill value or zeros if no fill value is provided.
- 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.
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.api.synchronous.full(
- shape: zarr.core.common.ChunkCoords,
- fill_value: Any,
- **kwargs: Any,
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.api.synchronous.full_like(
- a: zarr.api.asynchronous.ArrayLike,
- **kwargs: Any,
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.api.synchronous.group(
- store: zarr.storage.StoreLike | None = None,
- *,
- overwrite: bool = False,
- chunk_store: zarr.storage.StoreLike | None = None,
- cache_attrs: bool | None = None,
- synchronizer: Any | None = None,
- path: str | 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,
- storage_options: dict[str, Any] | None = None,
Create a group.
- Parameters:
- storeStore or str, optional
Store or path to directory in file system.
- overwritebool, optional
If True, delete any pre-existing data in store at path before creating the group.
- chunk_storeStore, optional
Separate storage for chunks. If not provided, store will be used for storage of both chunks and metadata.
- 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.
- synchronizerobject, optional
Array synchronizer.
- pathstr, optional
Group path within store.
- meta_arrayarray-like, optional
An array instance to use for determining arrays to create and return to users. Use numpy.empty(()) by default.
- zarr_format{2, 3, None}, optional
The zarr format to use when saving.
- storage_optionsdict
If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise.
- Returns:
- gGroup
The new group.
- zarr.api.synchronous.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,
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.api.synchronous.ones(
- shape: zarr.core.common.ChunkCoords,
- **kwargs: Any,
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.api.synchronous.ones_like(
- a: zarr.api.asynchronous.ArrayLike,
- **kwargs: Any,
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.api.synchronous.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,
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()
orzarr.api.asynchronous.open_group()
.
- Returns:
- zarray or group
Return type depends on what exists in the given store.
- zarr.api.synchronous.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,
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.api.synchronous.open_consolidated(
- *args: Any,
- use_consolidated: Literal[True] = True,
- **kwargs: Any,
Alias for
open_group()
withuse_consolidated=True
.
- zarr.api.synchronous.open_group(
- store: zarr.storage.StoreLike | None = None,
- *,
- mode: zarr.core.common.AccessModeLiteral = 'a',
- cache_attrs: bool | None = None,
- synchronizer: Any = None,
- path: str | None = None,
- chunk_store: zarr.storage.StoreLike | None = None,
- storage_options: dict[str, Any] | 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,
- use_consolidated: bool | str | None = None,
Open a group using file-mode-like semantics.
- Parameters:
- storeStore, str, or mapping, optional
Store or path to directory in file system or name of zip file.
Strings are interpreted as paths on the local file system and used as the
root
argument tozarr.storage.LocalStore
.Dictionaries are used as the
store_dict
argument inzarr.storage.MemoryStore`
.By default (
store=None
) a newzarr.storage.MemoryStore
is created.- 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).
- 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.
- synchronizerobject, optional
Array synchronizer.
- pathstr, optional
Group path within store.
- chunk_storeStore or str, optional
Store or path to directory in file system or name of zip file.
- storage_optionsdict
If using an fsspec URL to create the store, these will be passed to the backend implementation. Ignored otherwise.
- meta_arrayarray-like, optional
An array instance to use for determining arrays to create and return to users. Use numpy.empty(()) by default.
- attributesdict
A dictionary of JSON-serializable values with user-defined attributes.
- use_consolidatedbool or str, default None
Whether to use consolidated metadata.
By default, consolidated metadata is used if it’s present in the store (in the
zarr.json
for Zarr format 3 and in the.zmetadata
file for Zarr format 2).To explicitly require consolidated metadata, set
use_consolidated=True
, which will raise an exception if consolidated metadata is not found.To explicitly not use consolidated metadata, set
use_consolidated=False
, which will fall back to using the regular, non consolidated metadata.Zarr format 2 allows configuring the key storing the consolidated metadata (
.zmetadata
by default). Specify the custom key asuse_consolidated
to load consolidated metadata from a non-default key.
- Returns:
- gGroup
The new group.
- zarr.api.synchronous.open_like(
- a: zarr.api.asynchronous.ArrayLike,
- path: str,
- **kwargs: Any,
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.api.synchronous.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,
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.api.synchronous.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,
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.api.synchronous.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,
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.api.synchronous.tree(
- grp: zarr.core.group.Group,
- expand: bool | None = None,
- level: int | None = None,
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.
- zarr.api.synchronous.zeros(
- shape: zarr.core.common.ChunkCoords,
- **kwargs: Any,
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.api.synchronous.zeros_like(
- a: zarr.api.asynchronous.ArrayLike,
- **kwargs: Any,
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.