Test and document saving movement datasets to Zarr#869
Open
Tushar7012 wants to merge 6 commits intoneuroinformatics-unit:mainfrom
Open
Test and document saving movement datasets to Zarr#869Tushar7012 wants to merge 6 commits intoneuroinformatics-unit:mainfrom
Tushar7012 wants to merge 6 commits intoneuroinformatics-unit:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #869 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 38 38
Lines 2284 2284
=========================================
Hits 2284 2284 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



Description
What is this PR
Why is this PR needed?
Closes #45. Movement datasets can be large and users working with cloud storage or chunked workflows need a way to persist datasets to disk beyond netCDF. Zarr is natively supported by xarray and is well-suited for these use cases. This PR tests and documents that support.
What does this PR do?
tests/test_integration/test_zarr.pywith integration tests that verify movement datasets of various types (poses, bboxes, processed, derived variables, datetime index) can be saved to Zarr stores using xarray's nativeto_zarr()method and loaded back withopen_zarr(), with full state preserved.Saving and loading with Zarrsection to the Input/Output user guide, directing users to xarray's native methods and linking to the xarray Zarr docs.No wrapper functions are introduced. This follows the same approach taken for netCDF in #606. No
pyproject.tomlchanges are needed —zarris already available via thexarray[io]extra, which is part of movement's core dependencies.References
Closes #45
See also: #606 (the netCDF equivalent that this PR mirrors)
How has this PR been tested?
The Zarr round-trip has been tested in
tests/test_integration/test_zarr.py, mirroring the structure oftest_netcdf.py. The test suite covers:test_ds_save_and_load_zarrtest_da_save_and_load_zarrThe full test suite (1036 tests) passes with no regressions.
Is this a breaking change?
No.
Does this PR require an update to the documentation?
Yes — a
Saving and loading with Zarrsection has been added todocs/source/user_guide/input_output.md, immediately after the netCDF section.Checklist: