expose zarr caching from xarray
Open
Nobody has claimed this yet.
topic-documentation
topic-zarr
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
Zarr has its own internal mechanism for caching, described here:
- https://zarr.readthedocs.io/en/stable/tutorial.html#distributed-cloud-storage
- https://zarr.readthedocs.io/en/stable/api/storage.html#zarr.storage.LRUStoreCache
However, this capability is currently inaccessible from xarray.
I propose to add a new keyword cache=True/False to open_zarr which wraps the store in an LRUStoreCache.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the open_zarr entry point and read the linked Zarr documentation for distributed cloud storage and LRUStoreCache. Trace how the store is opened, then determine the appropriate behavior for a cache=True/False keyword. Done means open_zarr exposes that option and wraps the store in an LRUStoreCache when requested.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100