Skip to content

Changelog

1.8

Beta support for OME-Zarr 0.6

Version 0.6 of the OME-Zarr specification is currently a nearly-finished work in progress. Version 1.8 of ome-zarr-models introduces beta support for reading, validating, and writing OME-Zarr 0.6 data. Note that this version is still under active development and may change in the future.

The usual classes can be found in the API reference in the sidebar. A guide to converting OME-Zarr 0.5 images to 0.6 is also available.

Other fixes/improvements

  • Drop support for Python 3.11. The new minimum version of Python is 3.12.
  • Add explicit support for Python 3.14. This requires pydantic-zarr >= 0.10.0, which is specified in the dependencies of ome-zarr-models.

1.7

  • Require pydantic < 2.13, due to new issues in model construction that are not yet resolved.
  • Correctly allow colors metadata to be not set or null inside image-label metadata.

1.6

Require Python < 3.14. Due to issues with Python 3.14 and pydantic, ome-zarr-models is not yet compatible with Python 3.14.

New features

Documentation improvements

  • Improved the layout of metadata class API documentation by putting all attributes in a table.
  • Added more descriptions to fields describing image-label metadata.
  • Added documentation for the implementation of the next version of OME-Zarr. See the development groups API reference for more information.

1.5

bioformats2raw

ome-zarr-models now has support for bioformats2raw groups.

Documentation improvements

1.4

Fixing metadata

ome-zarr-models now has support for fixing common issues with OME-Zarr metadata when loading. See the metadata fixes page for more information.

Improvements

  • Added a better error message when the 'ome' key is completely absent from Zarr group metadata.
  • Fixed an import in the documentation examples
  • Added search to the documentation

1.3

Bug fixes

  • Fixed opening a HCS dataset with some well groups missing from the HCS Zarr group.

1.2

New Features

Improvements

  • Various optimisations have been made to reduce the number of file requests when creating a model class from an existing zarr.Group.
  • ome_zarr_models.open_ome_zarr now includes the name of the group it was trying to validate alongside the validation error message.

Bug fixes

  • Axes metadata for version 0.4 and 0.5 has been fixed to require the name field.

1.1

New Features

  • Added a command line interface (CLI) for validating and viewing metadata of OME-Zarr groups. See the CLI docs page for more info.
  • All models now support being created from Zarr groups in remote HTTP stores, and more generally from any groups stored in any unlistable store.
  • ome_zarr_models.open_ome_zarr now has an optional version argument that can be used to specify the OME-Zarr version of the group you are trying to open.
  • If ome_zarr_models.open_ome_zarr fails to load the Zarr group, validation error messages will now be printed to help with debugging why the Zarr group might not be valid OME-Zarr data.

Fixes

  • Opening an OME-Zarr 0.5 Image group that had an integer data type with ome_zarr_models.open_ome_zarr previously identified the group as an ImageLabel group. Image groups are now always identified as image groups, unless they contain the "image-label" metadata field.

1.0

New Features

This is the first release to support OME-Zarr 0.5 🎉

Updated dependencies

To support OME-Zarr 0.5, minimum dependencies have been updated to:

  • zarr 3.1.1
  • pydantic 2.11.5
  • pydantic-zarr 0.8.2

Breaking changes

0.1.10

Bug fixes

  • Creating a HCS group with well paths that do not point to existing well Zarr groups no longer errors.

Breaking changes

  • HCS.well_groups will now only return well groups that exist, instead of erroring out if a well group is defined in the HCS metadata but does not exist as a Zarr group.

0.1.9

Bug fixes

  • Add a maximum pydantic requirement of version 2.11.4. This fixes issues using several classes in ome-zarr-models. We hope to fix and remove this pydantic pin in a new release shortly.

0.1.8

Bug fixes

  • Fixed serialising models with model_dump(exclude_none=True). This (now fixed) bug was introduced in version 0.1.7.

0.1.7

Bug fixes

  • The coordinateTransformations field of multiscales metadata is no longer seralised if it is None. This fix is to stay compliant with the OME-Zarr specification, that does not explicitly allow null for this field.

0.1.6

New features

Minor improvements

0.1.5

New features

Minor improvements

  • Improved the error message in ome_zarr_models.open_ome_zarr when a Zarr group can't be validated with any OME-Zarr groups.
  • Simplified the class inheritance structure across the package.

Documentation improvements

  • Added project governance to home page.

0.1.4

Documentation improvements

  • Added a versioning policy to the documentation home page.
  • Added some missing objects to the API documentation for v04.

0.1.3

Documentation improvements

  • General minor improvements to the layout and look of the API docs.
  • Added some notes on known issues that will be encountered with support for OME-Zarr 0.5 in the future.

New features

  • The main OME-Zarr classes are now imported into the ome_zarr_models.v04 namespace, making them easier to import ( e.g., what was ome_zarr_models.v04.hcs.HCS can now just be ome_zarr_models.v04.HCS).

0.1.2

Documentation improvements

New features

  • Updated the return type on [ome_zarr_models.base.BaseGroup.ome_zarr_version] to allow "0.5" to be returned, in anticipation of upcoming support for OME-Zarr version 0.5.

Bug fixes

0.1.1

Bug fixes

Documentation improvements

  • Fixed the pip install command on the home page.
  • Added a conda install command to the home page.

0.1

First ome-zarr-models release.