Add HDF5 Section to read/write docs page #8012
Conversation
|
Thank you for opening this pull request! It may take us a few days to respond here, so thank you for being patient. |
for more information, see https://pre-commit.ci
|
Thanks @rwegener2 This is a great first PR! Welcome.
I think its OK to encourage |
for more information, see https://pre-commit.ci
Sounds good @dcherian! I added a sentence for writing HDF5 data. Let me know if there is anything else that should change, otherwise I think it's done. |
|
I think this is great. Thanks @rwegener2! This is a great first contribution, and it address one of the top 3 questions new users ask about Xarray (in my experience). Welcome to Xarray |
|
Congratulations on completing your first pull request! Welcome to Xarray! We are proud of you, and hope to see you again! |
|
Thanks @dcherian! Happy to be here and so happy my first PR could be a useful one! |
…lazy-array * upstream/main: (153 commits) Add HDF5 Section to read/write docs page (pydata#8012) [pre-commit.ci] pre-commit autoupdate (pydata#8014) Update interpolate_na in dataset.py (pydata#7974) improved docstring of to_netcdf (issue pydata#7127) (pydata#7947) Expose "Coordinates" as part of Xarray's public API (pydata#7368) Core team member guide (pydata#7999) join together duplicate entries in the text `repr` (pydata#7225) Update copyright year in README (pydata#8007) Allow opening datasets with nD dimenson coordinate variables. (pydata#7989) Move whats-new entry [pre-commit.ci] pre-commit autoupdate (pydata#7997) Add documentation on custom indexes (pydata#6975) Use variable name in all exceptions raised in `as_variable` (pydata#7995) Bump pypa/gh-action-pypi-publish from 1.8.7 to 1.8.8 (pydata#7994) New whatsnew section Remove future release notes before this release Update whats-new.rst for new release (pydata#7993) Remove hue_style from plot1d docstring (pydata#7925) Add new what's new section (pydata#7986) Release summary for v2023.07.0 (pydata#7979) ...
Overview
This PR adds an HDF5 section to the "Reading and Writing Files" section of the documentation. It discusses the features and limitations of opening HDF5 data in xarray.
PR spun out of discussion #6299.
Discussion
To keep in line with other sections it would make sense to speak to xarray's ability to write HDF5 data. The
.to_netcdf()function does write files that can be read with HDF5 cli tools, which makes sense given that (as I understand it) a netCDF4 file is a slightly stricter implementation of the HDF5 data model. The netCDF4 docs even say:Still, it seems odd to recommend users write HDF5 files with a function called
.to_netcdf(). What do others think the proper tone is to take for writing files? Encourage.to_netcdf()? Mention it cautiously? Ignore it all together?