Merge pull request #118 from thewtex/from-ngff-zarr-docs

from ngff zarr docs

Author: thewtex

docs/python.md

@@ -152,13 +152,42 @@ chunksize=(64, 64), chunktype=numpy.ndarray>,
 )
 ```
 
-The `Multiscales` dataclass stores all the images and their metadata for each
+The [`Multiscales`] dataclass stores all the images and their metadata for each
 scale according the OME-Zarr data model. Note that the correct `scale` and
 `translation` for each scale are automatically computed.
 
-## Write to Zarr
+## Read an OME-Zarr
 
-To write the multiscales to Zarr, use [`to_ngff_zarr`].
+To read an OME-Zarr file, use [`from_ngff_zarr`], which returns the
+[`Multiscales`] dataclass.
+
+```python
+>>> multiscales = nz.from_ngff_zarr('cthead1.ome.zarr')
+```
+
+OME-Zarr version 0.1 to 0.5 is supported.
+
+## Validate OME-Zarr metadata
+
+To validate that an OME-Zarr's metadata following the specification's data
+model, which is used by all the programming languages in the community, use the
+`validate` optional dependency and kwarg to [`from_ngff_zarr`].
+
+```shell
+pip install "ngff-zarr[validate]"
+```
+
+```python
+>>> multiscales = nz.from_ngff_zarr('cthead1.ome.zarr', validate=True)
+```
+
+If the metadata does not follow the data model, an error will be raised.
+
+Metadata validation is supported for OME-Zarr version 0.1 to 0.5.
+
+## Write an OME-Zarr
+
+To write the multiscales to OME-Zarr, use [`to_ngff_zarr`].
 
 ```python
 nz.to_ngff_zarr('cthead1.ome.zarr', multiscales)
@@ -177,7 +206,9 @@ The multiscales will be computed and written out-of-core, limiting memory usage.
 [Dask arrays]: https://docs.dask.org/en/stable/array.html
 [Python Array API Standard]: https://data-apis.org/array-api/latest/
 [UDUNITS-2 identifiers]: https://ngff.openmicroscopy.org/latest/#axes-md
+[`Multiscales`]: ./apidocs/ngff_zarr/ngff_zarr.multiscales.md
 [`NgffImage`]: ./apidocs/ngff_zarr/ngff_zarr.ngff_image.md
 [`to_ngff_zarr`]: ./apidocs/ngff_zarr/ngff_zarr.to_ngff_zarr.md
 [`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