giovp / pydantic-ome-ngff

Pydantic models for OME-NGFF

pydantic-ome-ngff

about

Pydantic models for OME-NGFF metadata. Versions 0.4 and the latest (v0.5-dev) are currently supported.

supported metadata models:

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

omero and bioformats2raw are not currently supported, but contributions adding support for those models would be welcome.

Support for container-level validation (i.e., checking that multiscale or coordinate transformation metadata is compatible with a hierarchical array / group layout) is being added incrementally.

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