1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
|
.. currentmodule:: xarray
DataTree
========
Creating a DataTree
-------------------
Methods of creating a ``DataTree``.
.. autosummary::
:toctree: ../generated/
DataTree
DataTree.from_dict
Tree Attributes
---------------
Attributes relating to the recursive tree-like structure of a ``DataTree``.
.. autosummary::
:toctree: ../generated/
DataTree.parent
DataTree.children
DataTree.name
DataTree.path
DataTree.root
DataTree.is_root
DataTree.is_leaf
DataTree.leaves
DataTree.level
DataTree.depth
DataTree.width
DataTree.subtree
DataTree.subtree_with_keys
DataTree.descendants
DataTree.siblings
DataTree.lineage
DataTree.parents
DataTree.ancestors
DataTree.groups
DataTree.xindexes
Data Contents
-------------
Interface to the data objects (optionally) stored inside a single ``DataTree`` node.
This interface echoes that of ``xarray.Dataset``.
.. autosummary::
:toctree: ../generated/
DataTree.dims
DataTree.sizes
DataTree.data_vars
DataTree.ds
DataTree.coords
DataTree.attrs
DataTree.encoding
DataTree.indexes
DataTree.nbytes
DataTree.dataset
DataTree.to_dataset
DataTree.has_data
DataTree.has_attrs
DataTree.is_empty
DataTree.is_hollow
DataTree.chunksizes
Dictionary Interface
--------------------
``DataTree`` objects also have a dict-like interface mapping keys to either ``xarray.DataArray``\s or to child ``DataTree`` nodes.
.. autosummary::
:toctree: ../generated/
DataTree.__getitem__
DataTree.__setitem__
DataTree.__delitem__
DataTree.update
DataTree.get
DataTree.items
DataTree.keys
DataTree.values
Tree Manipulation
-----------------
For manipulating, traversing, navigating, or mapping over the tree structure.
.. autosummary::
:toctree: ../generated/
DataTree.orphan
DataTree.same_tree
DataTree.relative_to
DataTree.iter_lineage
DataTree.find_common_ancestor
DataTree.map_over_datasets
DataTree.pipe
DataTree.match
DataTree.filter
DataTree.filter_like
Pathlib-like Interface
----------------------
``DataTree`` objects deliberately echo some of the API of :py:class:`pathlib.PurePath`.
.. autosummary::
:toctree: ../generated/
DataTree.name
DataTree.parent
DataTree.parents
DataTree.relative_to
.. Missing:
.. ..
.. ``DataTree.glob``
.. ``DataTree.joinpath``
.. ``DataTree.with_name``
.. ``DataTree.walk``
.. ``DataTree.rename``
.. ``DataTree.replace``
DataTree Contents
-----------------
Manipulate the contents of all nodes in a ``DataTree`` simultaneously.
.. autosummary::
:toctree: ../generated/
DataTree.copy
.. DataTree.assign_coords
.. DataTree.merge
.. DataTree.rename
.. DataTree.rename_vars
.. DataTree.rename_dims
.. DataTree.swap_dims
.. DataTree.expand_dims
.. DataTree.drop_vars
.. DataTree.drop_dims
.. DataTree.set_coords
.. DataTree.reset_coords
DataTree Node Contents
----------------------
Manipulate the contents of a single ``DataTree`` node.
.. autosummary::
:toctree: ../generated/
DataTree.assign
DataTree.drop_nodes
DataTree Operations
-------------------
Apply operations over multiple ``DataTree`` objects.
.. autosummary::
:toctree: ../generated/
map_over_datasets
group_subtrees
Comparisons
-----------
Compare one ``DataTree`` object to another.
.. autosummary::
:toctree: ../generated/
DataTree.isomorphic
DataTree.equals
DataTree.identical
Indexing
--------
Index into all nodes in the subtree simultaneously.
.. autosummary::
:toctree: ../generated/
DataTree.isel
DataTree.sel
.. DataTree.drop_sel
.. DataTree.drop_isel
.. DataTree.head
.. DataTree.tail
.. DataTree.thin
.. DataTree.squeeze
.. DataTree.interp
.. DataTree.interp_like
.. DataTree.reindex
.. DataTree.reindex_like
.. DataTree.set_index
.. DataTree.reset_index
.. DataTree.reorder_levels
.. DataTree.query
.. ..
.. Missing:
.. ``DataTree.loc``
.. Missing Value Handling
.. ----------------------
.. .. autosummary::
.. :toctree: ../generated/
.. DataTree.isnull
.. DataTree.notnull
.. DataTree.combine_first
.. DataTree.dropna
.. DataTree.fillna
.. DataTree.ffill
.. DataTree.bfill
.. DataTree.interpolate_na
.. DataTree.where
.. DataTree.isin
.. Computation
.. -----------
.. Apply a computation to the data in all nodes in the subtree simultaneously.
.. .. autosummary::
.. :toctree: ../generated/
.. DataTree.map
.. DataTree.reduce
.. DataTree.diff
.. DataTree.quantile
.. DataTree.differentiate
.. DataTree.integrate
.. DataTree.map_blocks
.. DataTree.polyfit
.. DataTree.curvefit
Aggregation
-----------
Aggregate data in all nodes in the subtree simultaneously.
.. autosummary::
:toctree: ../generated/
DataTree.all
DataTree.any
DataTree.max
DataTree.min
DataTree.mean
DataTree.median
DataTree.prod
DataTree.sum
DataTree.std
DataTree.var
DataTree.cumsum
DataTree.cumprod
ndarray methods
---------------
Methods copied from :py:class:`numpy.ndarray` objects, here applying to the data in all nodes in the subtree.
.. autosummary::
:toctree: ../generated/
DataTree.argsort
DataTree.conj
DataTree.conjugate
DataTree.round
.. DataTree.astype
.. DataTree.clip
.. DataTree.rank
.. Reshaping and reorganising
.. --------------------------
.. Reshape or reorganise the data in all nodes in the subtree.
.. .. autosummary::
.. :toctree: ../generated/
.. DataTree.transpose
.. DataTree.stack
.. DataTree.unstack
.. DataTree.shift
.. DataTree.roll
.. DataTree.pad
.. DataTree.sortby
.. DataTree.broadcast_like
|
