@@ -71,6 +71,45 @@ def create(shape, chunks=None, dtype=None, compressor='default',
71
71
compressor: Blosc(cname='lz4', clevel=5, shuffle=SHUFFLE, blocksize=0)
72
72
store: dict
73
73
74
+ Create an array with different some different configuration options::
75
+
76
+ >>> from numcodecs import Blosc
77
+ >>> z = zarr.create((10000, 10000), chunks=(1000, 1000), dtype='i1', order='F',
78
+ ... compressor=Blosc(cname='zstd', clevel=1, shuffle=Blosc.BITSHUFFLE))
79
+ >>> z
80
+ Array((10000, 10000), int8, chunks=(1000, 1000), order=F)
81
+ nbytes: 95.4M; nbytes_stored: ...; ratio: ...; initialized: 0/100
82
+ compressor: Blosc(cname='zstd', clevel=1, shuffle=BITSHUFFLE, blocksize=0)
83
+ store: dict
84
+
85
+ To create an array with object dtype requires a filter that can handle Python object encoding,
86
+ e.g., `MsgPack` or `Pickle` from `numcodecs`::
87
+
88
+ >>> from numcodecs import MsgPack
89
+ >>> z = zarr.create((10000, 10000), chunks=(1000, 1000), dtype='object',
90
+ ... filters=[MsgPack()])
91
+ >>> z
92
+ Array((10000, 10000), object, chunks=(1000, 1000), order=C)
93
+ nbytes: 762.9M; nbytes_stored: ...; ratio: ...; initialized: 0/100
94
+ filters: MsgPack(encoding='utf-8')
95
+ compressor: Blosc(cname='lz4', clevel=5, shuffle=SHUFFLE, blocksize=0)
96
+ store: dict
97
+
98
+ Example with some filters, and also storing chunks separately from metadata::
99
+
100
+ >>> from numcodecs import Quantize, Adler32
101
+ >>> store, chunk_store = dict(), dict()
102
+ >>> z = zarr.create((10000, 10000), chunks=(1000, 1000), dtype='f8',
103
+ ... filters=[Quantize(digits=2, dtype='f8'), Adler32()],
104
+ ... store=store, chunk_store=chunk_store)
105
+ >>> z
106
+ Array((10000, 10000), float64, chunks=(1000, 1000), order=C)
107
+ nbytes: 762.9M; nbytes_stored: ...; ratio: ...; initialized: 0/100
108
+ filters: Quantize(digits=2, dtype='<f8')
109
+ Adler32()
110
+ compressor: Blosc(cname='lz4', clevel=5, shuffle=SHUFFLE, blocksize=0)
111
+ store: dict; chunk_store: dict
112
+
74
113
""" # flake8: noqa
75
114
76
115
# handle polymorphic store arg
0 commit comments