to_zarr#

caput.mpiarray.MPIArray.to_zarr(f: str | zarr.Group, dataset: str, create: bool, chunks: tuple[int, Ellipsis] | None, compression: str | int | None, compression_opts: tuple | None = None) → None[source]#

Parallel write into a contiguous Zarr dataset.

Parameters:
fstr | zarr.Group

File to write dataset into.

datasetstr

Name of dataset to write into. Should not exist.

createbool

True if a new file should be created (if needed)

chunkstuple[int, …] | None, optional

Chunk shape.

compressionstr | int | None, optional

Name or identifier of compression filter.

compression_optstuple | None, optional

See documentation for compression filters. Compression options for the dataset.

Raises:
RuntimeError

If zarr is not installed.

ValueError

If zarr group is already initialized without a synchronizer, or if file name argument type is invalid.