Skip to content

Commit 35319ef

Browse files
committed
Add 1.4 changelog
1 parent f5e38eb commit 35319ef

File tree

1 file changed

+35
-15
lines changed

1 file changed

+35
-15
lines changed

docs/changelog.md

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77
ome-zarr-models now has support for fixing common issues with OME-Zarr metadata when loading.
88
See [the metadata fixes page](fixes.md) for more information.
99

10+
### Improvements
11+
12+
- Added a better error message when the `'ome'` key is completely absent from Zarr group metadata.
13+
- Fixed an import in the documentation examples
14+
- Added search to the documentation
15+
1016
## 1.3
1117

1218
### Bug fixes
@@ -17,12 +23,15 @@ See [the metadata fixes page](fixes.md) for more information.
1723

1824
### New Features
1925

20-
- [ome_zarr_models.open_ome_zarr][] now accepts any store containing a group that can be opened with [zarr.open_group][].
26+
- [ome_zarr_models.open_ome_zarr][] now accepts any store containing a group that can be opened
27+
with [zarr.open_group][].
2128

2229
### Improvements
2330

24-
- Various optimisations have been made to reduce the number of file requests when creating a model class from an existing [zarr.Group][].
25-
- [ome_zarr_models.open_ome_zarr][] now includes the name of the group it was trying to validate alongside the validation error message.
31+
- Various optimisations have been made to reduce the number of file requests when creating a model class from an
32+
existing [zarr.Group][].
33+
- [ome_zarr_models.open_ome_zarr][] now includes the name of the group it was trying to validate alongside the
34+
validation error message.
2635

2736
## Bug fixes
2837

@@ -34,13 +43,17 @@ See [the metadata fixes page](fixes.md) for more information.
3443

3544
- Added a command line interface (CLI) for validating and viewing metadata of OME-Zarr groups.
3645
See [the CLI docs page](cli.md) for more info.
37-
- All models now support being created from Zarr groups in remote HTTP stores, and more generally from any groups stored in any unlistable store.
38-
- [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.
39-
- 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.
46+
- All models now support being created from Zarr groups in remote HTTP stores, and more generally from any groups stored
47+
in any unlistable store.
48+
- [ome_zarr_models.open_ome_zarr][] now has an optional `version` argument that can be used to specify the OME-Zarr
49+
version of the group you are trying to open.
50+
- If [ome_zarr_models.open_ome_zarr][] fails to load the Zarr group, validation error messages will now be printed to
51+
help with debugging why the Zarr group might not be valid OME-Zarr data.
4052

4153
### Fixes
4254

43-
- 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.
55+
- Opening an OME-Zarr 0.5 Image group that had an integer data type with [ome_zarr_models.open_ome_zarr][] previously
56+
identified the group as an ImageLabel group.
4457
Image groups are now always identified as image groups, unless they contain the "image-label" metadata field.
4558

4659
## 1.0
@@ -60,10 +73,12 @@ To support OME-Zarr 0.5, minimum dependencies have been updated to:
6073
### Breaking changes
6174

6275
- `ome_zarr_models.common.image_label_types.Label` has moved to [ome_zarr_models.v04.image_label_types.Label][].
63-
- [ome_zarr_models.common.validation.check_array_path][] now takes a mandatory `expected_zarr_version` keyword-only argument.
64-
- [ome_zarr_models.common.validation.check_group_spec][] and [ome_zarr_models.common.validation.check_array_spec][] raise a `ValueError` instead of a `RuntimeError`.
76+
- [ome_zarr_models.common.validation.check_array_path][] now takes a mandatory `expected_zarr_version` keyword-only
77+
argument.
78+
- [ome_zarr_models.common.validation.check_group_spec][] and [ome_zarr_models.common.validation.check_array_spec][]
79+
raise a `ValueError` instead of a `RuntimeError`.
6580

66-
## 0.1.10
81+
## 0.1.10
6782

6883
### Bug fixes
6984

@@ -72,7 +87,8 @@ To support OME-Zarr 0.5, minimum dependencies have been updated to:
7287

7388
### Breaking changes
7489

75-
- `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.
90+
- `HCS.well_groups` will now only return well groups that exist, instead of erroring out if a well group is defined in
91+
the HCS metadata but does not exist as a Zarr group.
7692

7793
## 0.1.9
7894

@@ -104,7 +120,8 @@ To support OME-Zarr 0.5, minimum dependencies have been updated to:
104120

105121
### Minor improvements
106122

107-
- [ome_zarr_models.v04.Image.new][] now checks that `scales` and `translations` are both the same length as `paths`, and raises an error if they are not.
123+
- [ome_zarr_models.v04.Image.new][] now checks that `scales` and `translations` are both the same length as `paths`, and
124+
raises an error if they are not.
108125

109126
## 0.1.5
110127

@@ -114,7 +131,8 @@ To support OME-Zarr 0.5, minimum dependencies have been updated to:
114131

115132
### Minor improvements
116133

117-
- Improved the error message in [ome_zarr_models.open_ome_zarr][] when a Zarr group can't be validated with any OME-Zarr groups.
134+
- Improved the error message in [ome_zarr_models.open_ome_zarr][] when a Zarr group can't be validated with any OME-Zarr
135+
groups.
118136
- Simplified the class inheritance structure across the package.
119137

120138
### Documentation improvements
@@ -137,7 +155,8 @@ To support OME-Zarr 0.5, minimum dependencies have been updated to:
137155

138156
### New features
139157

140-
- 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`).
158+
- The main OME-Zarr classes are now imported into the `ome_zarr_models.v04` namespace, making them easier to import (
159+
e.g., what was `ome_zarr_models.v04.hcs.HCS` can now just be `ome_zarr_models.v04.HCS`).
141160

142161
## 0.1.2
143162

@@ -147,7 +166,8 @@ To support OME-Zarr 0.5, minimum dependencies have been updated to:
147166

148167
### New features
149168

150-
- 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.
169+
- Updated the return type on [ome_zarr_models.base.BaseGroup.ome_zarr_version] to allow "0.5" to be returned, in
170+
anticipation of upcoming support for OME-Zarr version 0.5.
151171

152172
### Bug fixes
153173

0 commit comments

Comments
 (0)