ome / ome/ngff

.ozx technology compatibility kit

Open
#398 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement rfc-9
Dominant language
Python
Stars
171
Forks
75
Avg merge
2d 3h
Merged PRs (30d)
20

Description

Suggested by @joshmoore

A repo with scripts for generating various valid, invalid, and not-recommended .ozx files and potentially a tool for distinguishing between them.

Valid cases

  • Single array
  • Group hierarchy

Warning cases

  • Missing ZIP comment metadata
  • Not using ZIP64
  • zarr.json file entries not sorted breadth-first
  • Ends with .zip
  • Uses zip compression

Failure cases

  • No zarr.json at the root
  • .ozx file contained in archive
  • multi-part zip
  • ZIP comment suggests zarr.json entries are sorted, but they're not

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by reviewing the proposed scripts for generating valid, warning, and failure .ozx archives. Work through the listed cases, including array and group hierarchies, ZIP metadata, compression, multipart archives, and zarr.json ordering. Done means the compatibility kit covers the requested cases and potentially distinguishes them.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing-qa, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.