Add a recommendation (SHOULD) for the use of the `.ome.zarr` suffix

Open Beginner friendly
#665 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python

Research direction

Read the specification section that describes how OME-Zarr stores are identified, along with the transferred discussion in issue #228. Decide where the suffix recommendation belongs and how it should be phrased as a SHOULD. Done means the spec recommends .ome.zarr while retaining the stated identification by the ome attribute.

Written by the indexing model from the issue text.

Description

feature request

This is transferred from

  • #228

While the answer for the the original question is that an OME-Zarr is identifiable by the presence of an "ome" attribute, there is an outstanding request/suggestion by @thewtex:

We may want to encourage, i.e. SHOULD, the use of .ome.zarr in the spec to improve awareness of OME-Zarr and be able to identify an OME-Zarr directly from a path / URL.

Dominant language
Python
Stars
180
Forks
81
Avg merge
5d 7h
Merged PRs (30d)
9

Getting set up

  • No Dockerfile or Docker Compose file
  • No pull request template
  • Read the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ome/ngff

All issues in ome/ngff

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.