-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Docs: add example of writing and reading groups to netcdf #7338
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -162,11 +162,77 @@ To do so, pass a ``group`` keyword argument to the | |
:py:func:`open_dataset` function. The group can be specified as a path-like | ||
string, e.g., to access subgroup ``'bar'`` within group ``'foo'`` pass | ||
``'/foo/bar'`` as the ``group`` argument. | ||
|
||
In a similar way, the ``group`` keyword argument can be given to the | ||
:py:meth:`Dataset.to_netcdf` method to write to a group | ||
in a netCDF file. | ||
When writing multiple groups in one file, pass ``mode='a'`` to | ||
:py:meth:`Dataset.to_netcdf` to ensure that each call does not delete the file. | ||
For example: | ||
|
||
.. ipython:: | ||
:verbatim: | ||
|
||
In [1]: ds1 = xr.Dataset({"a": 0}) | ||
|
||
In [2]: ds2 = xr.Dataset({"b": 1}) | ||
|
||
In [3]: ds1.to_netcdf("file.nc", group="A") | ||
|
||
In [4]: ds2.to_netcdf("file.nc", group="B", mode="a") | ||
|
||
We can verify that two groups have been saved using the ncdump command-line utility. | ||
|
||
.. code:: bash | ||
|
||
$ ncdump file.nc | ||
netcdf file { | ||
|
||
group: A { | ||
variables: | ||
int64 a ; | ||
data: | ||
|
||
a = 0 ; | ||
} // group A | ||
|
||
group: B { | ||
variables: | ||
int64 b ; | ||
data: | ||
|
||
b = 1 ; | ||
} // group B | ||
} | ||
dcherian marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Either of these groups can be loaded from the file as an independent :py:class:`Dataset` object: | ||
|
||
.. ipython:: | ||
:verbatim: | ||
|
||
In [1]: group1 = xr.open_dataset("file.nc", group="A") | ||
|
||
In [2]: group1 | ||
Out[2]: | ||
<xarray.Dataset> | ||
Dimensions: () | ||
Data variables: | ||
a int64 ... | ||
|
||
In [3]: group2 = xr.open_dataset("file.nc", group="B") | ||
|
||
In [4]: group2 | ||
Out[4]: | ||
<xarray.Dataset> | ||
Dimensions: () | ||
Data variables: | ||
b int64 ... | ||
|
||
.. note:: | ||
|
||
For native handling of multiple groups with xarray, including I/O, you might be interested in the experimental | ||
`xarray-datatree <https://github.com/xarray-contrib/datatree>`_ package. | ||
|
||
Comment on lines
+233
to
+235
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is this fine / appropriate / developed enough to mention here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, I think so! |
||
|
||
.. _io.encoding: | ||
|
||
|
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could actually execute this, but then the docs build will be writing and reading files, which might not be a good idea?