-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathreference.html
545 lines (533 loc) · 47.6 KB
/
reference.html
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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Reference — PyGeode 1.4.1-rc2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/pygtheme.css" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="shortcut icon" href="_static/pygeode_icon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Var class overview" href="var.html" />
<link rel="prev" title="Advanced Variable Operations" href="tut_adv.html" />
<link href="http://fonts.googleapis.com/css?family=Ubuntu:300,300italic,regular,italic,500,500italic,bold,bolditalic" rel="stylesheet" type="text/css">
<link href='http://fonts.googleapis.com/css?family=Ubuntu+Mono:400,700' rel='stylesheet' type='text/css'>
</head><body>
<div class="header" role="banner"><img class="logo" src="_static/pygeode_logo.png" width=79px alt="Logo"/>
<h1 class="heading"><a href="index.html">
<span>PyGeode 1.4.1-rc2 documentation</span></a></h1>
<h2 class="heading"><span>Reference</span></h2>
</div>
<div class="topnav" role="navigation" aria-label="top navigation">
<p>
«  <a href="tut_adv.html">Advanced Variable Operations</a>
  ::  
<a class="uplink" href="#">Reference</a>
  ::  
<a class="uplink" href="tutorial.html">Tutorial</a>
  ::  
<a class="uplink" href="gallery/index.html">Gallery</a>
  ::  
<a href="var.html">Var class overview</a>  »
</p>
</div>
<div class="content">
<div class="section" id="reference">
<h1>Reference<a class="headerlink" href="#reference" title="Permalink to this headline">¶</a></h1>
<p>The vast majority of the functionality provided by PyGeode is available within
the top level namespace of the module <a class="reference internal" href="#module-pygeode" title="pygeode"><code class="xref py py-mod docutils literal notranslate"><span class="pre">pygeode</span></code></a>, along with the
fundamental classes <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a>, <a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code></a>, and <a class="reference internal" href="dataset.html#pygeode.Dataset" title="pygeode.Dataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dataset</span></code></a>. The
contents of this top level namespace is summarized here. Several submodules
with further functionality are also included.</p>
<div class="module docutils container">
<p class="rubric">pygeode</p>
<span class="target" id="module-pygeode"></span><p>The top level pygeode namespace</p>
<p><a class="reference internal" href="fileio.html"><span class="doc">File Input and Output</span></a></p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="fileio.html#pygeode.open" title="pygeode.open"><code class="xref py py-obj docutils literal notranslate"><span class="pre">open</span></code></a>(filename[, format, value_override, ...])</p></td>
<td><p>Returns a <a class="reference internal" href="dataset.html#pygeode.Dataset" title="pygeode.Dataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dataset</span></code></a> containing variables defined in a single file or a dict of <a class="reference internal" href="dataset.html#pygeode.Dataset" title="pygeode.Dataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dataset</span></code></a> for a netcdf4 file containing groups.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="fileio.html#pygeode.openall" title="pygeode.openall"><code class="xref py py-obj docutils literal notranslate"><span class="pre">openall</span></code></a>(files[, format, opener])</p></td>
<td><p>Returns a <a class="reference internal" href="dataset.html#pygeode.Dataset" title="pygeode.Dataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dataset</span></code></a> containing variables merged across multiple files.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="fileio.html#pygeode.open_multi" title="pygeode.open_multi"><code class="xref py py-obj docutils literal notranslate"><span class="pre">open_multi</span></code></a>(files[, format, opener, pattern, ...])</p></td>
<td><p>Returns a <a class="reference internal" href="dataset.html#pygeode.Dataset" title="pygeode.Dataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dataset</span></code></a> containing variables merged across many files.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="fileio.html#pygeode.save" title="pygeode.save"><code class="xref py py-obj docutils literal notranslate"><span class="pre">save</span></code></a>(filename, dataset[, format, cfmeta])</p></td>
<td><p>Saves a <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> or <a class="reference internal" href="dataset.html#pygeode.Dataset" title="pygeode.Dataset"><code class="xref py py-class docutils literal notranslate"><span class="pre">Dataset</span></code></a> to file.</p></td>
</tr>
</tbody>
</table>
<p class="rubric">Fundamental Classes</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Var</span></code></a>(axes[, dtype, name, values, atts, plotatts])</p></td>
<td><p>The base class of all data objects in PyGeode.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Axis</span></code></a>(values[, name, atts, plotatts, rtol])</p></td>
<td><p>An object that describes a single dimension of a <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> object.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="dataset.html#pygeode.Dataset" title="pygeode.Dataset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Dataset</span></code></a>(vars[, atts, print_warnings])</p></td>
<td><p>Container class for <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><code class="xref py py-class docutils literal notranslate"><span class="pre">Var</span></code></a> objects.</p></td>
</tr>
</tbody>
</table>
<p class="rubric">Axis Types</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="namedaxis.html#pygeode.NamedAxis" title="pygeode.NamedAxis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NamedAxis</span></code></a>(values, name, **kwargs)</p></td>
<td><p>Generic axis object identified by its name.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="horizontalaxes.html#pygeode.Lon" title="pygeode.Lon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Lon</span></code></a>(values[, name, atts, plotatts, rtol])</p></td>
<td><p>Longitude axis.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="horizontalaxes.html#pygeode.Lat" title="pygeode.Lat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Lat</span></code></a>(values[, weights])</p></td>
<td><p>Latitude axis.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="verticalaxes.html#pygeode.Height" title="pygeode.Height"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Height</span></code></a>(values[, name, atts, plotatts, rtol])</p></td>
<td><p>Geometric height axis.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="verticalaxes.html#pygeode.Pres" title="pygeode.Pres"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Pres</span></code></a>(values[, name, atts, plotatts, rtol])</p></td>
<td><p>Pressure height axis.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="verticalaxes.html#pygeode.Hybrid" title="pygeode.Hybrid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Hybrid</span></code></a>(values, A, B, **kwargs)</p></td>
<td><p>Hybridized vertical coordinate axis.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="timeaxes.html#pygeode.StandardTime" title="pygeode.StandardTime"><code class="xref py py-obj docutils literal notranslate"><span class="pre">StandardTime</span></code></a>([values, datefmt, units, startdate])</p></td>
<td><p>Time axis describing the standard Gregorian calendar.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="timeaxes.html#pygeode.ModelTime365" title="pygeode.ModelTime365"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ModelTime365</span></code></a>([values, datefmt, units, startdate])</p></td>
<td><p>Time axis describing a model 365-day calendar.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="timeaxes.html#pygeode.ModelTime360" title="pygeode.ModelTime360"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ModelTime360</span></code></a>([values, datefmt, units, startdate])</p></td>
<td><p>Time axis describing a model 360-day calendar.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="timeaxes.html#pygeode.Yearless" title="pygeode.Yearless"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Yearless</span></code></a>(*args, **kwargs)</p></td>
<td><p>Time axis describing a calendar with no months or years.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="namedaxis.html#pygeode.NonCoordinateAxis" title="pygeode.NonCoordinateAxis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NonCoordinateAxis</span></code></a>(*args, **kwargs)</p></td>
<td><p>Non-coordinate axis (disables nearest-neighbour value matching, etc.)</p></td>
</tr>
</tbody>
</table>
<p class="rubric">Axis helper functions</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="horizontalaxes.html#pygeode.regularlon" title="pygeode.regularlon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">regularlon</span></code></a>(n[, origin, order, repeat_origin])</p></td>
<td><p>Constructs a regularly spaced <a class="reference internal" href="horizontalaxes.html#pygeode.Lon" title="pygeode.Lon"><code class="xref py py-class docutils literal notranslate"><span class="pre">Lon</span></code></a> axis with n longitudes.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="horizontalaxes.html#pygeode.rotatelon" title="pygeode.rotatelon"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rotatelon</span></code></a>(v, origin[, duplicate])</p></td>
<td><p>Rotates longitude axis to start at a new origin.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="horizontalaxes.html#pygeode.regularlat" title="pygeode.regularlat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">regularlat</span></code></a>(n[, order, inc_poles])</p></td>
<td><p>Constructs a regularly spaced <a class="reference internal" href="horizontalaxes.html#pygeode.Lat" title="pygeode.Lat"><code class="xref py py-class docutils literal notranslate"><span class="pre">Lat</span></code></a> axis with n latitudes.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="horizontalaxes.html#pygeode.gausslat" title="pygeode.gausslat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">gausslat</span></code></a>(n[, order, axis_dict])</p></td>
<td><p>Constructs a Gaussian <a class="reference internal" href="horizontalaxes.html#pygeode.Lat" title="pygeode.Lat"><code class="xref py py-class docutils literal notranslate"><span class="pre">Lat</span></code></a> axis with n latitudes.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="timeaxes.html#pygeode.standardtimerange" title="pygeode.standardtimerange"><code class="xref py py-obj docutils literal notranslate"><span class="pre">standardtimerange</span></code></a>(start, end[, step, units, ...])</p></td>
<td><p>Creates a <a class="reference internal" href="timeaxes.html#pygeode.StandardTime" title="pygeode.StandardTime"><code class="xref py py-class docutils literal notranslate"><span class="pre">StandardTime</span></code></a> axis for the period from start to end.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="timeaxes.html#pygeode.standardtimen" title="pygeode.standardtimen"><code class="xref py py-obj docutils literal notranslate"><span class="pre">standardtimen</span></code></a>(start, n[, step, units, ref])</p></td>
<td><p>Creates a <a class="reference internal" href="timeaxes.html#pygeode.StandardTime" title="pygeode.StandardTime"><code class="xref py py-class docutils literal notranslate"><span class="pre">StandardTime</span></code></a> axis of length n.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="timeaxes.html#pygeode.modeltime365range" title="pygeode.modeltime365range"><code class="xref py py-obj docutils literal notranslate"><span class="pre">modeltime365range</span></code></a>(start, end[, step, units, ...])</p></td>
<td><p>Creates a <a class="reference internal" href="timeaxes.html#pygeode.ModelTime365" title="pygeode.ModelTime365"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelTime365</span></code></a> axis for the period from start to end.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="timeaxes.html#pygeode.modeltime365n" title="pygeode.modeltime365n"><code class="xref py py-obj docutils literal notranslate"><span class="pre">modeltime365n</span></code></a>(start, n[, step, units, ref])</p></td>
<td><p>Creates a <a class="reference internal" href="timeaxes.html#pygeode.ModelTime365" title="pygeode.ModelTime365"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelTime365</span></code></a> axis of length n.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="timeaxes.html#pygeode.modeltime360range" title="pygeode.modeltime360range"><code class="xref py py-obj docutils literal notranslate"><span class="pre">modeltime360range</span></code></a>(start, end[, step, units, ...])</p></td>
<td><p>Creates a <a class="reference internal" href="timeaxes.html#pygeode.ModelTime360" title="pygeode.ModelTime360"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelTime360</span></code></a> axis for the period from start to end.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="timeaxes.html#pygeode.modeltime360n" title="pygeode.modeltime360n"><code class="xref py py-obj docutils literal notranslate"><span class="pre">modeltime360n</span></code></a>(start, n[, step, units, ref])</p></td>
<td><p>Creates a <a class="reference internal" href="timeaxes.html#pygeode.ModelTime360" title="pygeode.ModelTime360"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelTime360</span></code></a> axis of length n.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="timeaxes.html#pygeode.yearlessn" title="pygeode.yearlessn"><code class="xref py py-obj docutils literal notranslate"><span class="pre">yearlessn</span></code></a>(n[, start, step, units])</p></td>
<td><p>Creates a <a class="reference internal" href="timeaxes.html#pygeode.Yearless" title="pygeode.Yearless"><code class="xref py py-class docutils literal notranslate"><span class="pre">Yearless</span></code></a> axis of length n.</p></td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="genops.html"><span class="doc">General Operations</span></a></p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="genops.html#pygeode.asdataset" title="pygeode.asdataset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">asdataset</span></code></a>(vars[, copy, print_warnings])</p></td>
<td><p>Tries to convert a collection of objects into a single dataset.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="genops.html#pygeode.concatenate" title="pygeode.concatenate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">concatenate</span></code></a>(*items, **kwargs)</p></td>
<td><p>Concatenates multiple Var or Dataset objects together.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="genops.html#pygeode.ensemble" title="pygeode.ensemble"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ensemble</span></code></a>(*varlists)</p></td>
<td><p>Creates an ensemble out of a set of similar variables.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="genops.html#pygeode.vprod" title="pygeode.vprod"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vprod</span></code></a>(*args)</p></td>
<td><p>Multiplies an arbitrary number of variables together</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="genops.html#pygeode.vsum" title="pygeode.vsum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vsum</span></code></a>(*args)</p></td>
<td><p>Adds an arbitrary number of variables together</p></td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="ufunc.html"><span class="doc">Element-wise math</span></a></p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.sign" title="pygeode.sign"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sign</span></code></a>(x)</p></td>
<td><p>Sign (+1 = <em>positive</em>, -1 = <em>negative</em>).</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.exp" title="pygeode.exp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">exp</span></code></a>(x)</p></td>
<td><p>Natural exponent.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.log" title="pygeode.log"><code class="xref py py-obj docutils literal notranslate"><span class="pre">log</span></code></a>(x)</p></td>
<td><p>Natural logarithm.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.log10" title="pygeode.log10"><code class="xref py py-obj docutils literal notranslate"><span class="pre">log10</span></code></a>(x)</p></td>
<td><p>Base-10 logarithm.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.cos" title="pygeode.cos"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cos</span></code></a>(x)</p></td>
<td><p>Cosine of angle (in radians).</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.sin" title="pygeode.sin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sin</span></code></a>(x)</p></td>
<td><p>Sine of angle (in radians).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.tan" title="pygeode.tan"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tan</span></code></a>(x)</p></td>
<td><p>Tangent of angle (in radians).</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.cosd" title="pygeode.cosd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cosd</span></code></a>(x)</p></td>
<td><p>Cosine of angle (in degrees)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.sind" title="pygeode.sind"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sind</span></code></a>(x)</p></td>
<td><p>Sine of angle (in degrees)</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.tand" title="pygeode.tand"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tand</span></code></a>(x)</p></td>
<td><p>Tangent of angle (in degrees)</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.sinh" title="pygeode.sinh"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sinh</span></code></a>(x)</p></td>
<td><p>Hyperbolic sine.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.cosh" title="pygeode.cosh"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cosh</span></code></a>(x)</p></td>
<td><p>Hyperbolic cosine.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.tanh" title="pygeode.tanh"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tanh</span></code></a>(x)</p></td>
<td><p>Hyperbolic tangent.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.arcsin" title="pygeode.arcsin"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arcsin</span></code></a>(x)</p></td>
<td><p>Inverse sine (in radians).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.arccos" title="pygeode.arccos"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arccos</span></code></a>(x)</p></td>
<td><p>Inverse cosine (in radians).</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.arctan" title="pygeode.arctan"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arctan</span></code></a>(x)</p></td>
<td><p>Inverse tangent (in radians).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.arctan2" title="pygeode.arctan2"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arctan2</span></code></a>(x, y)</p></td>
<td><p>Inverse tangent.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.arcsind" title="pygeode.arcsind"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arcsind</span></code></a>(x)</p></td>
<td><p>Inverse sine (in degrees).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.arccosd" title="pygeode.arccosd"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arccosd</span></code></a>(x)</p></td>
<td><p>Inverse cosine (in degrees).</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.arctand" title="pygeode.arctand"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arctand</span></code></a>(x)</p></td>
<td><p>Inverse tangent (in degrees).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.arctand2" title="pygeode.arctand2"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arctand2</span></code></a>(x, y)</p></td>
<td><p>Inverse tangent.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.arcsinh" title="pygeode.arcsinh"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arcsinh</span></code></a>(x)</p></td>
<td><p>Inverse hyperbolic sine.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.arccosh" title="pygeode.arccosh"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arccosh</span></code></a>(x)</p></td>
<td><p>Inverse hyperbolic cosine.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.arctanh" title="pygeode.arctanh"><code class="xref py py-obj docutils literal notranslate"><span class="pre">arctanh</span></code></a>(x)</p></td>
<td><p>Inverse hyperbolic tangent.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.sqrt" title="pygeode.sqrt"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sqrt</span></code></a>(x)</p></td>
<td><p>Square root.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.absolute" title="pygeode.absolute"><code class="xref py py-obj docutils literal notranslate"><span class="pre">absolute</span></code></a>(x)</p></td>
<td><p>Absolute value.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.nan_to_num" title="pygeode.nan_to_num"><code class="xref py py-obj docutils literal notranslate"><span class="pre">nan_to_num</span></code></a>(x)</p></td>
<td><p>Replace nan with zero and inf with finite numbers.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.minimum" title="pygeode.minimum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">minimum</span></code></a>(x, y)</p></td>
<td><p>Element-wise minimum of the two given arguments.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.maximum" title="pygeode.maximum"><code class="xref py py-obj docutils literal notranslate"><span class="pre">maximum</span></code></a>(x, y)</p></td>
<td><p>Element-wise maximum of the two given arguments.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.real" title="pygeode.real"><code class="xref py py-obj docutils literal notranslate"><span class="pre">real</span></code></a>(x)</p></td>
<td><p>Real part of a complex array.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.imag" title="pygeode.imag"><code class="xref py py-obj docutils literal notranslate"><span class="pre">imag</span></code></a>(x)</p></td>
<td><p>Imaginary part of a complex array.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.angle" title="pygeode.angle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">angle</span></code></a>(x)</p></td>
<td><p>Angles (arguments) of a complex array.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="ufunc.html#pygeode.conj" title="pygeode.conj"><code class="xref py py-obj docutils literal notranslate"><span class="pre">conj</span></code></a>(x)</p></td>
<td><p>Complex conjugate of a complex array.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="ufunc.html#pygeode.clip" title="pygeode.clip"><code class="xref py py-obj docutils literal notranslate"><span class="pre">clip</span></code></a>(*args)</p></td>
<td><p>Clips values to given interval.</p></td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="climat.html"><span class="doc">Climat module</span></a></p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="climat.html#pygeode.dailymean" title="pygeode.dailymean"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dailymean</span></code></a>(var)</p></td>
<td><p>Computes an average value for each day.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="climat.html#pygeode.monthlymean" title="pygeode.monthlymean"><code class="xref py py-obj docutils literal notranslate"><span class="pre">monthlymean</span></code></a>(var)</p></td>
<td><p>Averages over each month.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="climat.html#pygeode.seasonalmean" title="pygeode.seasonalmean"><code class="xref py py-obj docutils literal notranslate"><span class="pre">seasonalmean</span></code></a>(var)</p></td>
<td><p>Averages over each season.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="climat.html#pygeode.yearlymean" title="pygeode.yearlymean"><code class="xref py py-obj docutils literal notranslate"><span class="pre">yearlymean</span></code></a>(var)</p></td>
<td><p>Averages over each year.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="climat.html#pygeode.diurnalmean" title="pygeode.diurnalmean"><code class="xref py py-obj docutils literal notranslate"><span class="pre">diurnalmean</span></code></a>(var)</p></td>
<td><p>Computes an average value for each time of day (averages over all years, months, days).</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="climat.html#pygeode.climatology" title="pygeode.climatology"><code class="xref py py-obj docutils literal notranslate"><span class="pre">climatology</span></code></a>(var)</p></td>
<td><p>Computes a climatological mean.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="climat.html#pygeode.dailynanmean" title="pygeode.dailynanmean"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dailynanmean</span></code></a>(var)</p></td>
<td><p>Computes a nan-aware average value for each day.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="climat.html#pygeode.dailystdev" title="pygeode.dailystdev"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dailystdev</span></code></a>(var)</p></td>
<td><p>Computes daily standard deviation.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="climat.html#pygeode.dailynanstdev" title="pygeode.dailynanstdev"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dailynanstdev</span></code></a>(var)</p></td>
<td><p>Computes nan-aware daily standard deviation.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="climat.html#pygeode.dailycount" title="pygeode.dailycount"><code class="xref py py-obj docutils literal notranslate"><span class="pre">dailycount</span></code></a>(var)</p></td>
<td><p>Counts number of non-nan data points contributing to daily mean.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="climat.html#pygeode.climtrend" title="pygeode.climtrend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">climtrend</span></code></a>(var)</p></td>
<td><p>For each month, day, hour, etc., compute a least-squares fit to a linear trend over all years.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="climat.html#pygeode.from_trend" title="pygeode.from_trend"><code class="xref py py-obj docutils literal notranslate"><span class="pre">from_trend</span></code></a>(taxis[, coef, A, B])</p></td>
<td><p>Reconstructs linear timeseries from a given trend.</p></td>
</tr>
</tbody>
</table>
<p>… and other similar routines; see <a class="reference internal" href="climat.html"><span class="doc">Climat module</span></a></p>
<p><a class="reference internal" href="timeutils.html"><span class="doc">Timeutils module</span></a></p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="timeutils.html#pygeode.timeutils.conform_values" title="pygeode.timeutils.conform_values"><code class="xref py py-obj docutils literal notranslate"><span class="pre">timeutils.conform_values</span></code></a>(taxis1, taxis2)</p></td>
<td><p>Given two time axes, return new axes such that their values are comparable.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="timeutils.html#pygeode.timeutils.date_diff" title="pygeode.timeutils.date_diff"><code class="xref py py-obj docutils literal notranslate"><span class="pre">timeutils.date_diff</span></code></a>(taxis, dt1, dt2[, units])</p></td>
<td><p>Returns time interval between two dates.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="timeutils.html#pygeode.timeutils.delta" title="pygeode.timeutils.delta"><code class="xref py py-obj docutils literal notranslate"><span class="pre">timeutils.delta</span></code></a>(taxis[, units, allow_multiple])</p></td>
<td><p>Returns the interval between values of a given time axis.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="timeutils.html#pygeode.timeutils.jointimeaxes" title="pygeode.timeutils.jointimeaxes"><code class="xref py py-obj docutils literal notranslate"><span class="pre">timeutils.jointimeaxes</span></code></a>(var[, yaxis, daxis])</p></td>
<td><p>Convert a variable with a 2D time axis into one with a 1D time axis.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="timeutils.html#pygeode.timeutils.modify" title="pygeode.timeutils.modify"><code class="xref py py-obj docutils literal notranslate"><span class="pre">timeutils.modify</span></code></a>(taxis[, resolution, ...])</p></td>
<td><p>Modifies the auxiliary arrays associated with a time axis.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="timeutils.html#pygeode.timeutils.reltime" title="pygeode.timeutils.reltime"><code class="xref py py-obj docutils literal notranslate"><span class="pre">timeutils.reltime</span></code></a>(taxis[, startdate, units])</p></td>
<td><p>Returns time axis values relative to a given reference date.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="timeutils.html#pygeode.timeutils.removeleapyears" title="pygeode.timeutils.removeleapyears"><code class="xref py py-obj docutils literal notranslate"><span class="pre">timeutils.removeleapyears</span></code></a>(data[, ...])</p></td>
<td><p>Removes leap day(s) from data on a standard calendar.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="timeutils.html#pygeode.timeutils.splittimeaxis" title="pygeode.timeutils.splittimeaxis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">timeutils.splittimeaxis</span></code></a>(var[, iaxis])</p></td>
<td><p>Convert a variable with a 1D time axis into one with a 2D time axis.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="timeutils.html#pygeode.timeutils.wrapdate" title="pygeode.timeutils.wrapdate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">timeutils.wrapdate</span></code></a>(taxis, dt[, allfields])</p></td>
<td><p>Returns a modified date dictionary such that all fields lie within standard values.</p></td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="stats.html"><span class="doc">Stats module</span></a></p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="stats.html#pygeode.correlate" title="pygeode.correlate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">correlate</span></code></a>(X, Y[, axes, output, pbar])</p></td>
<td><p>Computes Pearson correlation coefficient between variables X and Y.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="stats.html#pygeode.regress" title="pygeode.regress"><code class="xref py py-obj docutils literal notranslate"><span class="pre">regress</span></code></a>(X, Y[, axes, N_fac, output, pbar])</p></td>
<td><p>Computes least-squares linear regression of Y against X.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="stats.html#pygeode.multiple_regress" title="pygeode.multiple_regress"><code class="xref py py-obj docutils literal notranslate"><span class="pre">multiple_regress</span></code></a>(Xs, Y[, axes, N_fac, ...])</p></td>
<td><p>Computes least-squares multiple regression of Y against variables Xs.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="stats.html#pygeode.difference" title="pygeode.difference"><code class="xref py py-obj docutils literal notranslate"><span class="pre">difference</span></code></a>(X, Y[, axes, alpha, Nx_fac, ...])</p></td>
<td><p>Computes the mean value and statistics of X - Y.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="stats.html#pygeode.paired_difference" title="pygeode.paired_difference"><code class="xref py py-obj docutils literal notranslate"><span class="pre">paired_difference</span></code></a>(X, Y[, axes, alpha, ...])</p></td>
<td><p>Computes the mean value and statistics of X - Y, assuming that individual elements of X and Y can be directly paired.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="stats.html#pygeode.isnonzero" title="pygeode.isnonzero"><code class="xref py py-obj docutils literal notranslate"><span class="pre">isnonzero</span></code></a>(X[, axes, alpha, N_fac, output, pbar])</p></td>
<td><p>Computes the mean value of X and statistics relevant for a test against the hypothesis that it is 0.</p></td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="eof.html"><span class="doc">EOF Analysis</span></a></p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="eof.html#pygeode.EOF" title="pygeode.EOF"><code class="xref py py-obj docutils literal notranslate"><span class="pre">EOF</span></code></a>(x[, num, iaxis, weight, out])</p></td>
<td><p>Computes the leading Empirical Orthogonal Function(s) for the given variable.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="eof.html#pygeode.SVD" title="pygeode.SVD"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SVD</span></code></a>(var1, var2[, num, subspace, iaxis, ...])</p></td>
<td><p>Finds coupled EOFs of two fields.</p></td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="plot.html"><span class="doc">Plot module</span></a></p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="plot.html#pygeode.showvar" title="pygeode.showvar"><code class="xref py py-obj docutils literal notranslate"><span class="pre">showvar</span></code></a>(var, *args, **kwargs)</p></td>
<td><p>Plot variable, showing a contour plot for 2d variables or a line plot for 1d variables.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="plot.html#pygeode.showgrid" title="pygeode.showgrid"><code class="xref py py-obj docutils literal notranslate"><span class="pre">showgrid</span></code></a>(vf[, vl, ncol, size, lbl])</p></td>
<td><p>Create grid of contour plots of multiple variables.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="plot.html#pygeode.showlines" title="pygeode.showlines"><code class="xref py py-obj docutils literal notranslate"><span class="pre">showlines</span></code></a>(vs[, fmts, labels, size, lblx, lbly])</p></td>
<td><p>Produce line plots of a list of 1D variables on a single figure.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="plot.html#pygeode.vcontour" title="pygeode.vcontour"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vcontour</span></code></a>(var[, clevs, clines, axes, lblx, ...])</p></td>
<td><p>Create a contour plot (lines, filled, or both) from a variable.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="plot.html#pygeode.vplot" title="pygeode.vplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vplot</span></code></a>(var[, fmt, axes, transpose, lblx, lbly])</p></td>
<td><p>Create a line plot of a variable.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="plot.html#pygeode.vscatter" title="pygeode.vscatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vscatter</span></code></a>(varx, vary[, axes, lblx, lbly])</p></td>
<td><p>Create a scatter plot from two variables with the same shape.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="plot.html#pygeode.vquiver" title="pygeode.vquiver"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vquiver</span></code></a>(varu, varv[, varc, axes, lblx, ...])</p></td>
<td><p>Create a quiver plot from two variables.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="plot.html#pygeode.vstreamplot" title="pygeode.vstreamplot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vstreamplot</span></code></a>(varu, varv[, axes, lblx, lbly, ...])</p></td>
<td><p>Create a streamplot from two variables.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="plot.html#pygeode.vsigmask" title="pygeode.vsigmask"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vsigmask</span></code></a>(pval, axes[, mjsig, mnsig, mjsigp, ...])</p></td>
<td><p>Add significance shading to a contour plot from a variable.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="plot.html#pygeode.vhist" title="pygeode.vhist"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vhist</span></code></a>(var[, axes, lblx, lbly])</p></td>
<td><p>Create a histogram of values taken by a variable.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="plot.html#pygeode.clfdict" title="pygeode.clfdict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">clfdict</span></code></a>(cdelt[, min, mid, nf, nl, ndiv, ...])</p></td>
<td><p>Returns kwargs to <a class="reference internal" href="plot.html#pygeode.showvar" title="pygeode.showvar"><code class="xref py py-meth docutils literal notranslate"><span class="pre">showvar()</span></code></a> for a filled contour plot.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="plot.html#pygeode.cldict" title="pygeode.cldict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cldict</span></code></a>(cdelt[, range, min, mid, cidelt, nozero])</p></td>
<td><p>Returns kwargs to <a class="reference internal" href="plot.html#pygeode.showvar" title="pygeode.showvar"><code class="xref py py-meth docutils literal notranslate"><span class="pre">showvar()</span></code></a> for a line contour plot.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="plot.html#pygeode.log1sdict" title="pygeode.log1sdict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">log1sdict</span></code></a>(cmin[, cdelt, nf, nl, ndiv])</p></td>
<td><p>Returns kwargs to <a class="reference internal" href="plot.html#pygeode.showvar" title="pygeode.showvar"><code class="xref py py-meth docutils literal notranslate"><span class="pre">showvar()</span></code></a> for a one-sided logarithmically-spaced contour plot.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="plot.html#pygeode.log2sdict" title="pygeode.log2sdict"><code class="xref py py-obj docutils literal notranslate"><span class="pre">log2sdict</span></code></a>(cmin[, cdelt, nf, nl, ndiv, nozero])</p></td>
<td><p>Returns kwargs to <a class="reference internal" href="plot.html#pygeode.showvar" title="pygeode.showvar"><code class="xref py py-meth docutils literal notranslate"><span class="pre">showvar()</span></code></a> for a two-sided logarithmically-spaced contour plot.</p></td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="external.html"><span class="doc">External Interfaces</span></a></p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="external.html#pygeode.ext_xarray.to_xarray" title="pygeode.ext_xarray.to_xarray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ext_xarray.to_xarray</span></code></a>(dataset)</p></td>
<td><p>Converts a PyGeode Dataset into an xarray Dataset.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="external.html#pygeode.ext_xarray.from_xarray" title="pygeode.ext_xarray.from_xarray"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ext_xarray.from_xarray</span></code></a>(dataset)</p></td>
<td><p>Converts an xarray Dataset into a PyGeode Dataset.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="under-the-hood">
<h2>Under the hood<a class="headerlink" href="#under-the-hood" title="Permalink to this headline">¶</a></h2>
<p><a class="reference internal" href="view.html"><span class="doc">View module</span></a></p>
<blockquote>
<div><p>A helper class for mapping subsets of variables</p>
</div></blockquote>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
<p>
«  <a href="tut_adv.html">Advanced Variable Operations</a>
  ::  
<a class="uplink" href="#">Reference</a>
  ::  
<a class="uplink" href="tutorial.html">Tutorial</a>
  ::  
<a class="uplink" href="gallery/index.html">Gallery</a>
  ::  
<a href="var.html">Var class overview</a>  »
</p>
</div>
<div class="footer" role="contentinfo">
© Copyright 2020, Mike Neish, Peter Hitchcock.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
</div>
</body>
</html>