Skip to content

Conversation

@mkitti
Copy link
Member

@mkitti mkitti commented Apr 30, 2025

There is a tendency to replicate the examples exactly. Having multiscale paths only being a number can be easily confused with chunk paths. Overall, the examples are being interpreted as recommended conventions so we may want to consider the implications of the names used in the examples.

This is a minor change since it just modifies the example without modification to the actual schemas. Having a path that is just a number remains valid. This would also match the existing n5 convention:

https://github.com/saalfeldlab/n5-viewer?tab=readme-ov-file#n5-viewer-metadata

There is a tendency to replicate the examples exactly. Having multiscale paths only being a number can be easily confused with chunk paths.
@d-v-b
Copy link
Contributor

d-v-b commented Apr 30, 2025

related: #277

@will-moore
Copy link
Member

Agreed that s prefix is nicer than plain integers.
We should think about adopting this behaviour in ome-zarr-py too.

What about updating the index.html spec page itself? It contains a bunch of places that use plain integer for multiscale paths.

Build failure is Config file not found at default path The required .readthedocs.yaml configuration file was not found at repository's root

@mkitti
Copy link
Member Author

mkitti commented May 28, 2025

Cc: @StephanPreibisch @tpietzsch

@mkitti
Copy link
Member Author

mkitti commented May 28, 2025

What about updating the index.html spec page itself? It contains a bunch of places that use plain integer for multiscale paths.

Which index.html is that?

@will-moore
Copy link
Member

Ah, it's actually index.bs: e.g.

ngff/index.bs

Line 82 in 8cbba21

├── 0 # Each multiscale level is stored as a separate Zarr array,
"...is often a sequence starting at 0"
I got there by clicking on the "0.5" submodules link from https://github.com/ome/ngff

@mkitti
Copy link
Member Author

mkitti commented Oct 23, 2025

@will-moore anything else to do here?

@will-moore
Copy link
Member

No blockers to the changes here.
But if this is to be propagated to future copies of the spec, it'll need to be copied over to the new repo at https://github.com/ome/ngff-spec/ where all the 0.6dev changes are happening now (probably after 0.6dev2 is done)

cc @jo-mueller

@jo-mueller
Copy link
Contributor

jo-mueller commented Oct 24, 2025

Thanks for the heads-up @will-moore . Yes, changing it here will mean it'll have to be changed over at ngff-spec, too. Since the change is minor, I think it could be added there already. Otherwise, the order of PRs that would have to go until then would be

#350 --> ome/ngff-spec#17 --> this (and everything else)

will-moore added a commit to will-moore/ome-zarr-py that referenced this pull request Oct 30, 2025
@will-moore will-moore moved this to In progress in OME-Zarr 0.6.dev3 Jan 12, 2026
@will-moore
Copy link
Member

@jo-mueller I'll work on moving this to ngff-spec...

@will-moore
Copy link
Member

PR opened: ome/ngff-spec#56

@will-moore will-moore closed this Jan 12, 2026
@github-project-automation github-project-automation bot moved this from In progress to Done in OME-Zarr 0.6.dev3 Jan 12, 2026
@mkitti
Copy link
Member Author

mkitti commented Jan 12, 2026

See also ome/ngff-spec#24

@jo-mueller
Copy link
Contributor

Ugh sorry @will-moore, I had this ported already a while ago and forgot to raise the hand here clearer 😬 My bad!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

4 participants