You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/changelog.md
+35-15Lines changed: 35 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,12 @@
7
7
ome-zarr-models now has support for fixing common issues with OME-Zarr metadata when loading.
8
8
See [the metadata fixes page](fixes.md) for more information.
9
9
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
+
10
16
## 1.3
11
17
12
18
### Bug fixes
@@ -17,12 +23,15 @@ See [the metadata fixes page](fixes.md) for more information.
17
23
18
24
### New Features
19
25
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][].
21
28
22
29
### Improvements
23
30
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.
26
35
27
36
## Bug fixes
28
37
@@ -34,13 +43,17 @@ See [the metadata fixes page](fixes.md) for more information.
34
43
35
44
- Added a command line interface (CLI) for validating and viewing metadata of OME-Zarr groups.
36
45
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.
40
52
41
53
### Fixes
42
54
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.
44
57
Image groups are now always identified as image groups, unless they contain the "image-label" metadata field.
45
58
46
59
## 1.0
@@ -60,10 +73,12 @@ To support OME-Zarr 0.5, minimum dependencies have been updated to:
60
73
### Breaking changes
61
74
62
75
-`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`.
65
80
66
-
##0.1.10
81
+
##0.1.10
67
82
68
83
### Bug fixes
69
84
@@ -72,7 +87,8 @@ To support OME-Zarr 0.5, minimum dependencies have been updated to:
72
87
73
88
### Breaking changes
74
89
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.
76
92
77
93
## 0.1.9
78
94
@@ -104,7 +120,8 @@ To support OME-Zarr 0.5, minimum dependencies have been updated to:
104
120
105
121
### Minor improvements
106
122
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.
108
125
109
126
## 0.1.5
110
127
@@ -114,7 +131,8 @@ To support OME-Zarr 0.5, minimum dependencies have been updated to:
114
131
115
132
### Minor improvements
116
133
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.
118
136
- Simplified the class inheritance structure across the package.
119
137
120
138
### Documentation improvements
@@ -137,7 +155,8 @@ To support OME-Zarr 0.5, minimum dependencies have been updated to:
137
155
138
156
### New features
139
157
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`).
141
160
142
161
## 0.1.2
143
162
@@ -147,7 +166,8 @@ To support OME-Zarr 0.5, minimum dependencies have been updated to:
147
166
148
167
### New features
149
168
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.
0 commit comments