Fix writing of DataTree subgroups to zarr or netCDF #9677
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
Consider a DataTree with a group, e.g.,
`tree = DataTree.from_dict({'/': ... '/child': ...})`
If we write `tree['/child']` to disk, the result should have groups
relative to `'/child'`, so writing and reading from the same path
restores the same object.
In addition, coordinates defined at the root should be written to
disk instead of being omitted.
TomNicholas
added
topic-backends
topic-DataTree
TomNicholas
approved these changes
Oct 24, 2024
As discussed in the last xarray meeting, this defaults to write_inherited_coords=True, which has a little more overhead but means you always get coordinates when opening a sub-group.
dcherian
reviewed
Oct 24, 2024
| @@ -1609,6 +1610,11 @@ def to_netcdf( | |||
| group : str, optional | |||
| Path to the netCDF4 group in the given file to open as the root group | |||
| of the ``DataTree``. Currently, specifying a group is not supported. | |||
| write_inherited_coords : bool, default: True | |||
There was a problem hiding this comment.
what happens at read-time? Do we normalize and remove duplicated coords by default? If so, I think we should change so that does not happen by default.
There was a problem hiding this comment.
what happens at read-time? Do we normalize and remove duplicated coords by default?
Yes, this is what happens.
If so, I think we should change so that does not happen by default.
Can you clarify what you mean here?
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.
Consider a DataTree with a group, e.g.,
tree = DataTree.from_dict({'/': ... '/child': ...})If we write
tree['/child']to disk, the result should have groups relative to'/child', so writing and reading from the same path restores the same object.In addition, coordinates defined at the root should be written to disk instead of being omitted.