Skip to content

Docs on how to write a custom reader using ManifestStore#580

Merged
TomNicholas merged 10 commits intozarr-developers:developfrom
TomNicholas:custom_reader_docs
May 8, 2025
Merged

Docs on how to write a custom reader using ManifestStore#580
TomNicholas merged 10 commits intozarr-developers:developfrom
TomNicholas:custom_reader_docs

Conversation

@TomNicholas
Copy link
Copy Markdown
Member

@TomNicholas TomNicholas commented Apr 29, 2025

A lot of small adjustments, and then a brand new page of docs.

@TomNicholas TomNicholas added the documentation Improvements or additions to documentation label Apr 29, 2025
@TomNicholas TomNicholas added this to the v2.0.0 milestone Apr 29, 2025
@TomNicholas TomNicholas requested a review from maxrjones April 29, 2025 21:38
Comment thread docs/custom_readers.md

As well as being a well-defined representation of the archival data in the Zarr model, you can also read chunk data directly from the `ManifestStore` object.

This works because the `ManifestStore` class is an implementation of the Zarr-Python `zarr.abc.Store` interface, and uses the `obstore` package internally to actually fetch chunk data when requested.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is missing a lot of detail about the store registry and credentials, but maybe you would like to add that in a follow-up PR @maxrjones ?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I over-engineered the store registry and with the proposal in #568 it could be removed.

@TomNicholas
Copy link
Copy Markdown
Member Author

@maxrjones I'm going to just merge this - we can add more material as needed later.

@maxrjones
Copy link
Copy Markdown
Member

@maxrjones I'm going to just merge this - we can add more material as needed later.

That sounds good. I'd rather we use Backend for this and to keep the reader concept separate - see definitions in #568, but I'm not going to spend any effort on that hill.

@TomNicholas
Copy link
Copy Markdown
Member Author

I'd rather we use Backend for this and to keep the reader concept separate

I'm not sure I understand why there needs to be a distinction, but we can discuss on #568 and update the wording in this docs page to match once we all agree.

@TomNicholas TomNicholas merged commit 5646b67 into zarr-developers:develop May 8, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs on how to write a custom reader

2 participants