Skip to content

Commit cd941d1

Browse files
authored
Merge pull request #119 from thewtex/tensorstore-docs
DOC: Describe writing with tensorstore
2 parents 2a9412e + 3628a29 commit cd941d1

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/python.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,19 @@ also be used.
201201

202202
The multiscales will be computed and written out-of-core, limiting memory usage.
203203

204+
### Writing with Tensorstore
205+
206+
To write with [tensorstore], which may provide better performance, use the
207+
`tensorstore` optional dependency.
208+
209+
```shell
210+
pip install "ngff-zarr[tensorstore]"
211+
```
212+
213+
```python
214+
nz.to_ngff_zarr('cthead1.ome.zarr', multiscales, use_tensorstore=True)
215+
```
216+
204217
[dataclass]: https://docs.python.org/3/library/dataclasses.html
205218
[dataclasses]: https://docs.python.org/3/library/dataclasses.html
206219
[Dask arrays]: https://docs.dask.org/en/stable/array.html
@@ -212,3 +225,4 @@ The multiscales will be computed and written out-of-core, limiting memory usage.
212225
[`to_ngff_image`]: ./apidocs/ngff_zarr/ngff_zarr.to_ngff_image.md
213226
[`to_multiscales`]: ./apidocs/ngff_zarr/ngff_zarr.to_multiscales.md
214227
[`from_ngff_zarr`]: ./apidocs/ngff_zarr/ngff_zarr.from_ngff_zarr.md
228+
[tensorstore]: https://google.github.io/tensorstore/

0 commit comments

Comments
 (0)