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.

Sign up for GitHub

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

DOC: Add note to docs on DataTree root-group naming conventions #9298

Merged
merged 7 commits into from
Aug 2, 2024
Merged

DOC: Add note to docs on DataTree root-group naming conventions #9298

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
64b1d84
DOC: Add note to docs on DataTree root-group naming conventions (root…
kmuehlbauer Jul 31, 2024
d1b29cb
Update xarray/core/datatree.py
kmuehlbauer Jul 31, 2024
31199e6
Update xarray/core/datatree.py
kmuehlbauer Aug 1, 2024
a297c9e
Update xarray/core/datatree.py
kmuehlbauer Aug 1, 2024
e68e470
Update xarray/datatree_/docs/source/io.rst
kmuehlbauer Aug 1, 2024
fa32e0a
Update xarray/datatree_/docs/source/io.rst
kmuehlbauer Aug 1, 2024
9fc8cf4
Merge branch 'main' into datatree-root-node-name
kmuehlbauer Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion xarray/core/datatree.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1546,7 +1546,11 @@ def to_netcdf(
``dask.delayed.Delayed`` object that can be computed later.
Currently, ``compute=False`` is not supported.
kwargs :
Addional keyword arguments to be passed to ``xarray.Dataset.to_netcdf``
Additional keyword arguments to be passed to ``xarray.Dataset.to_netcdf``

.. note::
Due to file format specifications the on-disk root group name
is always `/` overriding any given ``DataTree`` root node name.
"""
from xarray.core.datatree_io import _datatree_to_netcdf

Expand Down Expand Up @@ -1602,6 +1606,10 @@ def to_zarr(
supported.
kwargs :
Additional keyword arguments to be passed to ``xarray.Dataset.to_zarr``

.. note::
Due to file format specifications the on-disk root group name
is always `/` overriding any given ``DataTree`` root node name.
"""
from xarray.core.datatree_io import _datatree_to_zarr

Expand Down
11 changes: 11 additions & 0 deletions xarray/datatree_/docs/source/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ To open a whole netCDF file as a tree of groups use the :py:func:`open_datatree`
To save a DataTree object as a netCDF file containing many groups, use the :py:meth:`DataTree.to_netcdf` method.


.. _netcdf.root_group.note:

.. note::
Due to file format specifications the on-disk root group name is always `/`,
overriding any given ``DataTree`` root node name.

.. _netcdf.group.warning:

.. warning::
Expand Down Expand Up @@ -52,3 +58,8 @@ To save a DataTree object as a zarr store containing many groups, use the :py:me
.. note::
Note that perfect round-tripping should always be possible with a zarr store (:ref:`unlike for netCDF files <netcdf.group.warning>`),
as zarr does not support "unused" dimensions.

For the root group the same restrictions (:ref:`as for netCDF files <netcdf.root_group.note>`) apply.
Due to file format specifications the on-disk root group name is always `/`
overriding any given ``DataTree`` root node name.

Loading