Skip to content

Commit 659fd7b

Browse files
committed
DOC: Document OME-Zarr metadata validation
1 parent b46561b commit 659fd7b

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/python.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,26 @@ To read an OME-Zarr file, use [`from_ngff_zarr`], which returns the
165165
>>> multiscales = nz.from_ngff_zarr('cthead1.ome.zarr')
166166
```
167167

168+
OME-Zarr version 0.1 to 0.5 is supported.
169+
170+
## Validate OME-Zarr metadata
171+
172+
To validate that an OME-Zarr's metadata following the specification's data
173+
model, which is used by all the programming languages in the community, use the
174+
`validate` optional dependency and kwarg to [`from_ngff_zarr`].
175+
176+
```shell
177+
pip install "ngff-zarr[validate]"
178+
```
179+
180+
```python
181+
>>> multiscales = nz.from_ngff_zarr('cthead1.ome.zarr', validate=True)
182+
```
183+
184+
If the metadata does not follow the data model, an error will be raised.
185+
186+
Metadata validation is supported for OME-Zarr version 0.1 to 0.5.
187+
168188
## Write an OME-Zarr
169189

170190
To write the multiscales to OME-Zarr, use [`to_ngff_zarr`].

0 commit comments

Comments
 (0)