You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api.rst
+52-41Lines changed: 52 additions & 41 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,30 +25,21 @@ Top Level Functions
25
25
Grid
26
26
----
27
27
28
-
Constructor
29
-
~~~~~~~~~~~
28
+
Constructors
29
+
~~~~~~~~~~~~
30
30
31
31
.. autosummary::
32
32
:toctree: generated/
33
33
34
34
Grid
35
-
36
-
I/O & Conversion
37
-
~~~~~~~~~~~~~~~~
38
-
39
-
.. autosummary::
40
-
:toctree: generated/
41
-
42
35
Grid.from_dataset
43
36
Grid.from_file
44
37
Grid.from_topology
45
38
Grid.from_structured
46
39
Grid.from_points
47
40
Grid.from_healpix
48
-
Grid.to_xarray
49
-
Grid.to_geodataframe
50
-
Grid.to_polycollection
51
-
Grid.to_linecollection
41
+
42
+
52
43
53
44
Indexing
54
45
~~~~~~~~
@@ -175,13 +166,15 @@ and functionality, please refer to Xarray's `documentation <https://docs.xarray.
175
166
UxDataArray
176
167
-----------
177
168
178
-
Constructor
179
-
~~~~~~~~~~~
169
+
Constructors
170
+
~~~~~~~~~~~~
180
171
181
172
.. autosummary::
182
173
:toctree: generated/
183
174
184
175
UxDataArray
176
+
UxDataArray.from_xarray
177
+
UxDataArray.from_healpix
185
178
186
179
Grid Accessor
187
180
~~~~~~~~~~~
@@ -191,29 +184,20 @@ Grid Accessor
191
184
192
185
UxDataArray.uxgrid
193
186
194
-
I/O & Conversion
195
-
~~~~~~~~~~~~~~~~
196
-
197
-
.. autosummary::
198
-
:toctree: generated/
199
-
200
-
UxDataArray.to_geodataframe
201
-
UxDataArray.to_polycollection
202
-
UxDataArray.to_dataset
203
-
UxDataArray.from_xarray
204
-
UxDataArray.from_healpix
205
-
206
187
207
188
UxDataset
208
189
-----------
209
190
210
-
Constructor
211
-
~~~~~~~~~~~
191
+
Constructors
192
+
~~~~~~~~~~~~
212
193
213
194
.. autosummary::
214
195
:toctree: generated/
215
196
216
197
UxDataset
198
+
UxDataset.from_structured
199
+
UxDataset.from_xarray
200
+
UxDataset.from_healpix
217
201
218
202
Grid Accessor
219
203
~~~~~~~~~~~
@@ -223,25 +207,58 @@ Grid Accessor
223
207
224
208
UxDataset.uxgrid
225
209
226
-
I/O & Conversion
227
-
~~~~~~~~~~~~~~~~
210
+
211
+
Conversion Methods
212
+
------------------
213
+
214
+
UXarray provides functionality to convert its unstructured grids representation to other data structures that can be ingested by existing, widely used tools, such as Matplotlib and Cartopy. This allows users to keep using their workflows with such tools.
215
+
216
+
217
+
218
+
Grid
219
+
~~~~
228
220
229
221
.. autosummary::
230
222
:toctree: generated/
231
223
232
-
UxDataset.from_structured
233
-
UxDataset.from_xarray
234
-
UxDataset.from_healpix
224
+
Grid.to_geodataframe
225
+
Grid.to_polycollection
226
+
Grid.to_linecollection
227
+
Grid.to_xarray
228
+
229
+
UxDataArray
230
+
~~~~~~~~~~~
231
+
232
+
.. autosummary::
233
+
:toctree: generated/
234
+
235
+
UxDataArray.to_geodataframe
236
+
UxDataArray.to_polycollection
237
+
UxDataArray.to_raster
238
+
UxDataArray.to_dataset
239
+
UxDataArray.to_xarray
240
+
241
+
UxDataset
242
+
~~~~~~~~~
243
+
244
+
.. autosummary::
245
+
:toctree: generated/
246
+
247
+
UxDataset.to_xarray
248
+
UxDataset.to_array
249
+
235
250
236
251
Plotting
237
252
--------
238
253
239
254
240
-
UXarray's plotting API is written using `hvPlot <https://hvplot.holoviz.org/>`_.
255
+
UXarray's plotting API is written using `hvPlot <https://hvplot.holoviz.org/>`_. We also support standalone functions
256
+
for pure Matplotlib and Cartopy workflows.
241
257
242
258
.. seealso::
243
259
244
260
`Plotting User Guide Section <https://uxarray.readthedocs.io/en/latest/user-guide/plotting.html>`_
261
+
`Plotting with Matplotlib User Guide Section <https://uxarray.readthedocs.io/en/latest/user-guide/mpl.html>`_
0 commit comments