Skip to content

Commit

Permalink
Fix OME-Zarr spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
dstansby committed Jan 7, 2025
1 parent 7b8f717 commit d5941cb
Show file tree
Hide file tree
Showing 14 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Below are some different ways you can contribute.

## Suggesting new features

We're super open to helper functionality for working with OME-zarr metadata using our package!
We're super open to helper functionality for working with OME-Zarr metadata using our package!
To suggest a new feature, please open a ticket on [our issue tracker](https://github.com/ome-zarr-models/ome-zarr-models-py).

## Reporting issues
Expand Down
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ome-zarr-models

A Python package that provides validation and a Pythonic interface for OME-zarr datasets.
A Python package that provides validation and a Pythonic interface for OME-Zarr datasets.

## Installing

Expand All @@ -19,9 +19,9 @@ Useful places to get started are:

This package has been designed with the following guiding principles:

- Strict adherence to the [OME-zarr specification](https://ngff.openmicroscopy.org/), with the goal of being a reference implementation.
- A usable set of Python classes for reading, writing, and interacting with OME-zarr metadata.
- The ability to work with multiple versions of the OME-zarr spec at the same time.
- Strict adherence to the [OME-Zarr specification](https://ngff.openmicroscopy.org/), with the goal of being a reference implementation.
- A usable set of Python classes for reading, writing, and interacting with OME-Zarr metadata.
- The ability to work with multiple versions of the OME-Zarr spec at the same time.
- Array reading and writing operations are out of scope.

## Getting help
Expand Down
6 changes: 3 additions & 3 deletions docs/tutorial.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@

# ## Loading datasets
#
# OME-zarr datasets are just zarr groups with special metadata.
# To open an OME-zarr dataset, we first open the zarr group.
# OME-Zarr datasets are just zarr groups with special metadata.
# To open an OME-Zarr dataset, we first open the zarr group.

zarr_group = zarr.open(
"https://uk1s3.embassy.ebi.ac.uk/idr/zarr/v0.4/idr0062A/6001240.zarr", mode="r"
Expand All @@ -33,7 +33,7 @@
# No errors, which means the metadata is valid 🎉
#
# ## Accessing metadata
# To access the OME-zarr metadata, use the `.attributes` property:
# To access the OME-Zarr metadata, use the `.attributes` property:

metadata = ome_zarr_image.attributes
pprint(metadata)
Expand Down
2 changes: 1 addition & 1 deletion src/ome_zarr_models/v04/coordinate_transformations.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
For reference, see the [coordinate transformations section of the OME-zarr specification](https://ngff.openmicroscopy.org/0.4/#trafo-md).
For reference, see the [coordinate transformations section of the OME-Zarr specification](https://ngff.openmicroscopy.org/0.4/#trafo-md).
"""

from __future__ import annotations
Expand Down
2 changes: 1 addition & 1 deletion src/ome_zarr_models/v04/hcs.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ class HCSAttrs(BaseAttrs):

class HCS(GroupSpec[HCSAttrs, ArraySpec | GroupSpec], BaseGroupv04): # type: ignore[misc]
"""
An OME-zarr high-content screening (HCS) dataset representing a single plate.
An OME-Zarr high-content screening (HCS) dataset representing a single plate.
"""

@model_validator(mode="after")
Expand Down
6 changes: 3 additions & 3 deletions src/ome_zarr_models/v04/image.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def _check_arrays_compatible(data: Image) -> Image:

class ImageAttrs(BaseAttrs):
"""
Model for the metadata of OME-zarr data.
Model for the metadata of OME-Zarr data.
See https://ngff.openmicroscopy.org/0.4/#image-layout.
"""
Expand All @@ -76,15 +76,15 @@ class ImageAttrs(BaseAttrs):

class Image(GroupSpec[ImageAttrs, ArraySpec | GroupSpec], BaseGroupv04): # type: ignore[misc]
"""
An OME-zarr multiscale dataset.
An OME-Zarr multiscale dataset.
"""

_check_arrays_compatible = model_validator(mode="after")(_check_arrays_compatible)

@classmethod
def from_zarr(cls, group: zarr.Group) -> Self:
"""
Create an instance of an OME-zarr image from a `zarr.Group`.
Create an instance of an OME-Zarr image from a `zarr.Group`.
Parameters
----------
Expand Down
4 changes: 2 additions & 2 deletions src/ome_zarr_models/v04/image_label.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
For reference, see the [image label section of the OME-zarr specification](https://ngff.openmicroscopy.org/0.4/index.html#label-md).
For reference, see the [image label section of the OME-Zarr specification](https://ngff.openmicroscopy.org/0.4/index.html#label-md).
"""

from __future__ import annotations
Expand Down Expand Up @@ -47,7 +47,7 @@ class ImageLabel(GroupSpec[ImageLabelAttrs, ArraySpec | GroupSpec], BaseGroupv04
@classmethod
def from_zarr(cls, group: zarr.Group) -> Self:
"""
Create an instance of an OME-zarr image from a `zarr.Group`.
Create an instance of an OME-Zarr image from a `zarr.Group`.
Parameters
----------
Expand Down
2 changes: 1 addition & 1 deletion src/ome_zarr_models/v04/image_label_types.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
For reference, see the [image label section of the OME-zarr specification](https://ngff.openmicroscopy.org/0.4/index.html#label-md).
For reference, see the [image label section of the OME-Zarr specification](https://ngff.openmicroscopy.org/0.4/index.html#label-md).
"""

from __future__ import annotations
Expand Down
2 changes: 1 addition & 1 deletion src/ome_zarr_models/v04/labels.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ class LabelsAttrs(BaseAttrs):

class Labels(GroupSpec[LabelsAttrs, ArraySpec | GroupSpec], BaseGroupv04): # type: ignore[misc]
"""
An OME-zarr labels dataset.
An OME-Zarr labels dataset.
"""
2 changes: 1 addition & 1 deletion src/ome_zarr_models/v04/multiscales.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
For reference, see the [multiscales section of the OME-zarr specification](https://ngff.openmicroscopy.org/0.4/#multiscale-md).
For reference, see the [multiscales section of the OME-Zarr specification](https://ngff.openmicroscopy.org/0.4/#multiscale-md).
"""

from __future__ import annotations
Expand Down
2 changes: 1 addition & 1 deletion src/ome_zarr_models/v04/omero.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
For reference, see the [omero section of the OME-zarr specification](https://ngff.openmicroscopy.org/0.4/#omero-md).
For reference, see the [omero section of the OME-Zarr specification](https://ngff.openmicroscopy.org/0.4/#omero-md).
"""

from typing import Annotated
Expand Down
2 changes: 1 addition & 1 deletion src/ome_zarr_models/v04/plate.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
For reference, see the [plate section of the OME-zarr specification](https://ngff.openmicroscopy.org/0.4/index.html#plate-md).
For reference, see the [plate section of the OME-Zarr specification](https://ngff.openmicroscopy.org/0.4/index.html#plate-md).
"""

from collections import Counter
Expand Down
2 changes: 1 addition & 1 deletion src/ome_zarr_models/v04/well.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
For reference, see the [well section of the OME-zarr specification](https://ngff.openmicroscopy.org/0.4/#well-md).
For reference, see the [well section of the OME-Zarr specification](https://ngff.openmicroscopy.org/0.4/#well-md).
"""

from collections.abc import Generator
Expand Down
2 changes: 1 addition & 1 deletion src/ome_zarr_models/v04/well_types.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
For reference, see the [well section of the OME-zarr specification](https://ngff.openmicroscopy.org/0.4/#well-md).
For reference, see the [well section of the OME-Zarr specification](https://ngff.openmicroscopy.org/0.4/#well-md).
"""

from collections import defaultdict
Expand Down

0 comments on commit d5941cb

Please sign in to comment.