Up-to-date instructions for reading & writing to Zarr with Xarray #10410
Conversation
I summarize the conclusions from the discussion in zarr-developers/zarr-python#2706 (comment), taking leave from Tom and Ryan's books. I found that these docs didn't reflect the default state of Zarr and Xarray, and I hope this makes for less painful debugging for the next person.
|
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
doc/user-guide/io.rst
Outdated
| For writing, you must explicitly set up a ``MutableMapping`` | ||
| instance and pass this, as follows: | ||
| For writing, you may either specify a bucket URL or explicitly set up a | ||
| ``zarr.abc.store.Store`` instance, as follows: | ||
|
|
||
| .. code:: python | ||
|
|
||
| import gcsfs |
There was a problem hiding this comment.
This seems like a great place to use inline tabs. I'm thinking 3 tabs: "URL", "bbstore", and "fsspec". Are you up for making that change? We already depend on this plugin: https://sphinx-inline-tabs.readthedocs.io/en/latest/usage.html
There was a problem hiding this comment.
Great idea, and TIL the syntax. No problem at all.
|
Here's what it looks like in the readthedocs preview: |
|
that looks great @alxmrs ! |
|
Congratulations on completing your first pull request! Welcome to Xarray! We are proud of you, and hope to see you again! |
I summarize the conclusions from the discussion in zarr-developers/zarr-python#2706 (comment), taking leaves from Tom and Ryan's books. I found that these docs didn't reflect the default state of Zarr and Xarray, and I hope this makes for less painful debugging for the next person.