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

Non-kerchunk backend for HDF5/netcdf4 files. #87

Merged
merged 106 commits into from
Nov 19, 2024
Merged

Conversation

sharkinsspatial
Copy link
Collaborator

@sharkinsspatial sharkinsspatial commented Apr 22, 2024

This is a rudimentary initial implementation for #78. The core code is ported directly from kerchunk's hdf backend. I have not ported the bulk of the kerchunk backend's specialized encoding translation logic but I'll try to do so incrementally so that we can build complete test coverage for the many edge cases it currently covers.

@sharkinsspatial sharkinsspatial marked this pull request as draft April 22, 2024 18:37
Copy link
Member

@TomNicholas TomNicholas left a comment

Choose a reason for hiding this comment

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

This is looking great so far @sharkinsspatial !

kerchunk backend's specialized encoding translation logic

This part I would really like to either factor out, or at a least really understand what it's doing. See #68

@@ -0,0 +1,206 @@
from typing import List, Mapping, Optional

import fsspec
Copy link
Member

Choose a reason for hiding this comment

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

Does one need fsspec if reading a local file? Is there any other way to read from S3 without fsspec at all?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Not with a filesystem-like API. You would have to use boto3 or aiobotocore directly.

This is one of the great virtues of fsspec and is not to be under-valued.

Comment on lines 188 to 191
def virtual_vars_from_hdf(
path: str,
drop_variables: Optional[List[str]] = None,
) -> Mapping[str, xr.Variable]:
Copy link
Member

Choose a reason for hiding this comment

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

I like this an a way to interface with the code in open_virtual_dataset

@rabernat
Copy link
Collaborator

This looks cool @sharkinsspatial!

My opinion is that it doesn't make sense to just forklift the kerchunk code into virtualizarr. What I would love to see is an extremely tight, strictly typed, unit-tested total refactor of the parsing logic. I think you're headed down the right path, but I encourage you to push as far as you can in that direction.

@TomNicholas TomNicholas added enhancement New feature or request references generation Reading byte ranges from archival files labels Apr 22, 2024
@sharkinsspatial
Copy link
Collaborator Author

@rabernat Fully agree with your take above 👆 👍 . I'm trying to work through this incrementally whenever I can find some spare time. In the spirit of thorough test coverage 🎊 looking through your issue pydata/xarray#7388 and the corresponding PR I'm not sure what the proper incantation of variable encoding configuration is to use blosc with the netcdf4 engine? Do you have an example of this that you can provide?

@TomNicholas TomNicholas mentioned this pull request May 14, 2024
6 tasks
Copy link

codecov bot commented Nov 18, 2024

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

@sharkinsspatial
Copy link
Collaborator Author

@TomNicholas This should be ready for final review now.

@sharkinsspatial sharkinsspatial changed the title [Draft] Non-kerchunk backend for HDF5/netcdf4 files. Non-kerchunk backend for HDF5/netcdf4 files. Nov 19, 2024
Copy link
Member

@TomNicholas TomNicholas left a comment

Choose a reason for hiding this comment

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

Looks good! Only one question about warnings in the test suite when dependencies aren't installed.

Also let's add a release note saying this is available for experimental use.

import hdf5plugin # type: ignore
except ModuleNotFoundError:
hdf5plugin = None # type: ignore
warnings.warn("hdf5plugin is required for HDF reader")
Copy link
Member

Choose a reason for hiding this comment

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

Why wouldn't this either error or just not be a problem?

Copy link
Member

Choose a reason for hiding this comment

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

I added a release note in #307, but I'm still curious about this @sharkinsspatial

@sharkinsspatial sharkinsspatial merged commit 647d175 into main Nov 19, 2024
11 checks passed
@TomNicholas TomNicholas deleted the hdf5_reader branch November 19, 2024 15:30
TomNicholas added a commit that referenced this pull request Nov 19, 2024
TomNicholas added a commit that referenced this pull request Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
encoding enhancement New feature or request references generation Reading byte ranges from archival files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants