pydantic-ome-ngff 0.1.1

Pydantic models for the OME-NGFF

pydantic-ome-ngff

about

Pydantic models for OME-NGFF metadata. Only the latest version (v0.5-dev) of OME-NGFF is currently supported.

supported metadata models:

• multiscales (spec)
• axes (spec)
• coordinateTransformations (spec)
• plate (spec)
• well (spec)
• imageLabel (spec)

omero and bioformats2raw are not supported.

Note that these models will validate the contents of the various metadata fields, but cannot ensure that the metadata is structurally valid in the context of an array container -- e.g., these models cannot check that the number of axes in multiscales.axes matches the rank of arrays stored in the group bearing that multiscales metadata. This requires a representation of the group / array hierarchy as pydantic models, which is in progress.

installation

pip install pydantic-ome-ngff

development

1. clone this repo
2. install poetry
3. run poetry install --with dev to get dev dependencies
4. run pre-commit install to install pre-commit hooks