Skip to content

Rename xarray-zarr source and add docs#723

Merged
sandorkertesz merged 3 commits into
developfrom
feature/rename-xarray-zarr-source
Jun 17, 2025
Merged

Rename xarray-zarr source and add docs#723
sandorkertesz merged 3 commits into
developfrom
feature/rename-xarray-zarr-source

Conversation

@sandorkertesz

Copy link
Copy Markdown
Collaborator

This PR renames the xarray-zarr source to zarr. Also adds documentation.

The reason behind the renaming:

The name "xarray-zarr" reflects the fact that the Zarr store is read by Xarray internally. The suggestion is to use a more generic name "zarr". In the future if another Zarr reader is added e.g. based on the Zarr API we could handle it with an extra kwarg in from_source(). E.g.

from_source("zarr", ..., reader="xarray")
from_source("zarr", ..., reader="zarr")

Also consider that none of the existing source names contains/refers to the reader.

Comment thread src/earthkit/data/readers/directory.py Outdated
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 90.70%. Comparing base (5a3c781) to head (202a273).

Files with missing lines Patch % Lines
tests/sources/test_zarr.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #723   +/-   ##
========================================
  Coverage    90.70%   90.70%           
========================================
  Files          170      170           
  Lines        12936    12936           
  Branches       616      616           
========================================
  Hits         11733    11733           
  Misses        1015     1015           
  Partials       188      188           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sandorkertesz sandorkertesz merged commit 8666f3a into develop Jun 17, 2025
237 of 246 checks passed
@sandorkertesz sandorkertesz deleted the feature/rename-xarray-zarr-source branch June 17, 2025 10:23
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

Successfully merging this pull request may close these issues.

3 participants