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

Writer name field #139

Open
jakirkham opened this issue Apr 6, 2022 · 3 comments
Open

Writer name field #139

jakirkham opened this issue Apr 6, 2022 · 3 comments

Comments

@jakirkham
Copy link
Member

For tracking down issues, it would be useful to have field in the metadata that tracks what library was used to write the data. This wouldn't be used to handle anything special on the IO side. Instead it is useful to include when debugging issues with a specific writer.

Thanks @martindurant for this suggestion! 🙏

@martindurant
Copy link
Member

Library, language, version, date... and that's just for the creation of the metadata. This is very useful information for diagnostic purposes. Some file types also include HISTORY tags recording updates, but this is somewhat counter to zarr's idea of keeping the data and metadata files separate.

@jakirkham
Copy link
Member Author

cc @joshmoore (in case you have thoughts/experience here 🙂)

@joshmoore
Copy link
Member

joshmoore commented Aug 6, 2022

We certainly added something like that in ome-zarr:

            "metadata": {
                "description": "the fields in metadata depend on the downscaling implementation. Here, the parameters passed to the skimage function are given",
                "method": "skimage.transform.pyramid_gaussian",
                "version": "0.16.1",
                "args": "[true]",
                "kwargs": {"multichannel": true}
            }

from https://ngff.openmicroscopy.org/latest/#multiscale-md

If there were a metadata field (in .zarray, then I assume?) we could migrate to using that natively.

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

No branches or pull requests

4 participants