From 3628a29b5756f5930de5376ce20fb3309a33cc21 Mon Sep 17 00:00:00 2001 From: Matt McCormick Date: Sun, 1 Dec 2024 14:55:11 -0500 Subject: [PATCH] DOC: Describe writing with tensorstore --- docs/python.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/python.md b/docs/python.md index 23805962..cb7f9090 100644 --- a/docs/python.md +++ b/docs/python.md @@ -201,6 +201,19 @@ also be used. The multiscales will be computed and written out-of-core, limiting memory usage. +### Writing with Tensorstore + +To write with [tensorstore], which may provide better performance, use the +`tensorstore` optional dependency. + +```shell +pip install "ngff-zarr[tensorstore]" +``` + +```python +nz.to_ngff_zarr('cthead1.ome.zarr', multiscales, use_tensorstore=True) +``` + [dataclass]: https://docs.python.org/3/library/dataclasses.html [dataclasses]: https://docs.python.org/3/library/dataclasses.html [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. [`to_ngff_image`]: ./apidocs/ngff_zarr/ngff_zarr.to_ngff_image.md [`to_multiscales`]: ./apidocs/ngff_zarr/ngff_zarr.to_multiscales.md [`from_ngff_zarr`]: ./apidocs/ngff_zarr/ngff_zarr.from_ngff_zarr.md +[tensorstore]: https://google.github.io/tensorstore/