Datatree alignment docs #9501
Open
Datatree alignment docs #9501
+164
−1
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
TomNicholas
added
topic-documentation
topic-DataTree
TomNicholas
commented
Sep 15, 2024
| @@ -800,6 +800,7 @@ included by default unless you exclude them with the ``inherited`` flag: | |||
|
|
|||
| dt2["/weather/temperature"].to_dataset(inherited=False) | |||
|
|
|||
| For more examples and further discussion see LINK | |||
There was a problem hiding this comment.
I want to use this link but I can't seem to get it to work properly
:ref:`Alignment and Coordinate Inheritance <userguide.hierarchical-data.alignment-and-coordinate-inheritance>
TomNicholas
commented
Sep 15, 2024
| Data Alignment | ||
| ~~~~~~~~~~~~~~ | ||
|
|
||
| The data in different datatree nodes are not totally independent. In particular dimensions (and indexes) in child nodes must be aligned (LINK HERE) with those in their parent nodes. |
There was a problem hiding this comment.
This is where I would like to link to some generic documentation on what alignment is, but it doesn't really exist, see #9500.
TomNicholas
commented
Sep 15, 2024
| ds_weekly.sizes | ||
| ds_monthly.sizes | ||
|
|
||
| We cannot store these non-alignable variables on a single :py:class:`~xarray.Dataset` object, because they do not exactly align: |
There was a problem hiding this comment.
I guess it would be more correct to say that we cannot store them unchanged.
max-sixty
reviewed
Sep 15, 2024
TomNicholas
commented
Sep 16, 2024
eni-awowale
reviewed
Sep 18, 2024
…las/xarray into datatree_alignment_docs
Co-authored-by: Maximilian Roos <5635139+max-sixty@users.noreply.github.com>
shoyer
reviewed
Sep 28, 2024
…las/xarray into datatree_alignment_docs
Co-authored-by: Stephan Hoyer <shoyer@google.com>
27 tasks
TomNicholas
commented
Oct 8, 2024
Comment on lines
+657
to
+658
| Data Alignment | ||
| ~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
TODO: add comment about open_groups being useful if your data doesn't align
There was a problem hiding this comment.
this is the only note I have on open_groups, it probably deserves more. https://github.com/pydata/xarray/blob/main/doc/getting-started-guide/quick-overview.rst?plain=1#L284
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.
Adds a dedicated section on datatree alignment and coordinate inheritance to the Hierarchical Data page. Intended to complement what's already been added to the Data Structures page by @flamingbear, in a more narrative form. I've also tried to separate out the concept of alignment from coordinate inheritance.
This shouldn't really be merged until a few other things are fixed, particularly #9499.
Tests addedUser visible changes (including notable bug fixes) are documented inwhats-new.rstNew functions/methods are listed inapi.rstcc @shoyer @eni-awowale @owenlittlejohns