Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Question: given a .zarr what is the best way to say that it is .ome.zarr / ngff? #228

Open
yarikoptic opened this issue Feb 21, 2024 · 10 comments

Comments

@yarikoptic
Copy link
Contributor

is it presence of .omero key within .zattrs?

and then taking the schema of that version

❯ jq '.omero.version' .zattrs
"0.4"

correct?

@d-v-b
Copy link
Contributor

d-v-b commented Feb 21, 2024

Unfortunately, .omero is optional; The multiscales attribute might be better for this kind of thing. You might be interested in this proposal to fix the lack of a proper namespace in the metadata (among other changes).

@will-moore
Copy link
Member

Yes, as @d-v-b says, check for multiscales.

@yarikoptic
Copy link
Contributor Author

You might be interested in this proposal to fix the lack of a proper namespace in the metadata (among other changes).

and there it would become "explicit" through use of a URL pointing to a versioned ngff?

{
  "zarr_format": 3,
  "node_type": "group",
  "attributes": {
    "https://ngff.openmicroscopy.org/0.6": {
      "multiscales": [

or something else?

@joshmoore
Copy link
Member

Yes, the single JSON file (zarr.json) would either have or not have the appropriate key.

@yarikoptic
Copy link
Contributor Author

do you know if some more explicit formalization was discussed in zarr, e.g. to have something like "namespaces" or "extensions" on the top level which would have contained smth like

 [
  {
    "name": "ome",
    "version": "0.6",
    "schema": "https://ngff.openmicroscopy.org/jsonschemas/0.6" # 
  }
 ]

so, while dealing with a .zarr a developer of a tool could know what additional schemas implemented within that .zarr and potentially even load them to validate.
Just making it some "unique versioned URL" requires knowledge of its correspondence to specific effort/project, and since URL doesn't point to schema (it is 404 ATM) - not immediately usable for validation etc.

@joshmoore
Copy link
Member

It's being discussed to some degree in zarr-developers/zarr-specs#262 (ZEP0004)

@yarikoptic
Copy link
Contributor Author

any idea on how would it look for OME/NGFF if that ZEP0004 accepted in current form?

@thewtex
Copy link
Contributor

thewtex commented Apr 3, 2024

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.

@thewtex
Copy link
Contributor

thewtex commented Apr 3, 2024

the use of .ome.zarr in the spec

Discussed by @normanrz at the 2024-04-03 OME Community Meeting: https://hackmd.io/So61knrQR0iLftd2LGAVjA

@yarikoptic
Copy link
Contributor Author

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.

...

the use of .ome.zarr in the spec

Discussed by @normanrz at the 2024-04-03 OME Community Meeting: https://hackmd.io/So61knrQR0iLftd2LGAVjA

@normanrz :

image

and I would wholeheartedly support that -- only for UX!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants