DOC: zarr note on encoding #5427
Merged
Conversation
This file contains 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
|
There's some confusion over this, so the docs are welcome, as ever, @raybellwaves . There are also some plans to make the functionality less confusing. I'll let someone take a glance who's an expert, though. |
dcherian
reviewed
Jun 17, 2021
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
|
FYI larger issue is open at #5082 |
|
Thanks @raybellwaves |
dcherian
added a commit
to dcherian/xarray
that referenced
this pull request
Jun 23, 2021
* main: Improve error message for guess engine (pydata#5455) Refactor dataset groupby tests (pydata#5506) DOC: zarr note on encoding (pydata#5427) Allow plotting categorical data (pydata#5464)
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.
It took me a while to realize this so I wanted to make a note in the docs for myself in the future and others uses.
I was playing with pint-xarray and I couldn't work out why I couldn't round trip a file (xarray-contrib/pint-xarray#109). It turns out the DataArray had an enconding attribute which was being used (and overriding my unit conversion). In addition, I was also scratching my head for a while as to where my zarr store was getting chunks from which didn't correspomd to my numpy array (#5407).
This PR just makes a note of the importance of encoding attribute of DataArray(s) when writing to a zarr store.
docs page change is here: https://xray--5427.org.readthedocs.build/en/5427/generated/xarray.Dataset.to_zarr.html?highlight=zarr#xarray.Dataset.to_zarr