forked from pygeode/pygeode.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreference.html
525 lines (514 loc) · 34.7 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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Reference — PyGeode 1.0 alpha documentation</title>
<link rel="stylesheet" href="_static/pygtheme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0 alpha',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<link rel="top" title="PyGeode 1.0 alpha documentation" href="index.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="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="var.html" title="Var class overview"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="tut_adv.html" title="Advanced Variable Operations"
accesskey="P">previous</a> |</li>
<li><a href="index.html">PyGeode 1.0 alpha documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<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"><tt class="xref py py-mod docutils literal"><span class="pre">pygeode</span></tt></a>. The contents of this
top level namespace is summarized here. Note that there are also several
submodules with further functionality referenced in the summary as well.</p>
<div class="module container">
<span class="target" id="module-pygeode"></span><p>The top level pygeode namespace</p>
<p><a class="reference internal" href="fileio.html"><em>File Input and Output</em></a></p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="fileio.html#pygeode.open" title="pygeode.open"><tt class="xref py py-obj docutils literal"><span class="pre">open</span></tt></a>(filename[, format, value_override, ...])</td>
<td>Returns a <a class="reference internal" href="dataset.html#pygeode.Dataset" title="pygeode.Dataset"><tt class="xref py py-class docutils literal"><span class="pre">Dataset</span></tt></a> containing variables defined in a single file.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="fileio.html#pygeode.openall" title="pygeode.openall"><tt class="xref py py-obj docutils literal"><span class="pre">openall</span></tt></a>(files[, format, opener])</td>
<td>Returns a <a class="reference internal" href="dataset.html#pygeode.Dataset" title="pygeode.Dataset"><tt class="xref py py-class docutils literal"><span class="pre">Dataset</span></tt></a> containing variables merged across multiple files.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="fileio.html#pygeode.open_multi" title="pygeode.open_multi"><tt class="xref py py-obj docutils literal"><span class="pre">open_multi</span></tt></a>(files[, format, opener, pattern, ...])</td>
<td>Returns a <a class="reference internal" href="dataset.html#pygeode.Dataset" title="pygeode.Dataset"><tt class="xref py py-class docutils literal"><span class="pre">Dataset</span></tt></a> containing variables merged across many files.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="fileio.html#pygeode.save" title="pygeode.save"><tt class="xref py py-obj docutils literal"><span class="pre">save</span></tt></a>(filename, dataset[, format, cfmeta])</td>
<td>Saves a <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><tt class="xref py py-class docutils literal"><span class="pre">Var</span></tt></a> or <a class="reference internal" href="dataset.html#pygeode.Dataset" title="pygeode.Dataset"><tt class="xref py py-class docutils literal"><span class="pre">Dataset</span></tt></a> to file.</td>
</tr>
</tbody>
</table>
<p class="rubric">Fundamental Classes</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><tt class="xref py py-obj docutils literal"><span class="pre">Var</span></tt></a>(axes[, dtype, name, values, atts, plotatts])</td>
<td>The base class of all data objects in PyGeode.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="axes.html#pygeode.Axis" title="pygeode.Axis"><tt class="xref py py-obj docutils literal"><span class="pre">Axis</span></tt></a>(values[, name, atts, plotatts, rtol])</td>
<td>An object that describes a single dimension of a <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><tt class="xref py py-class docutils literal"><span class="pre">Var</span></tt></a> object.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="dataset.html#pygeode.Dataset" title="pygeode.Dataset"><tt class="xref py py-obj docutils literal"><span class="pre">Dataset</span></tt></a>(vars[, atts, print_warnings])</td>
<td>Container class for <a class="reference internal" href="var.html#pygeode.Var" title="pygeode.Var"><tt class="xref py py-class docutils literal"><span class="pre">Var</span></tt></a> objects.</td>
</tr>
</tbody>
</table>
<p class="rubric">Axis Types</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="namedaxis.html#pygeode.NamedAxis" title="pygeode.NamedAxis"><tt class="xref py py-obj docutils literal"><span class="pre">NamedAxis</span></tt></a>(values, name, **kwargs)</td>
<td>Generic axis object identified by its name.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="horizontalaxes.html#pygeode.Lon" title="pygeode.Lon"><tt class="xref py py-obj docutils literal"><span class="pre">Lon</span></tt></a>(values[, name, atts, plotatts, rtol])</td>
<td>Longitude axis.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="horizontalaxes.html#pygeode.Lat" title="pygeode.Lat"><tt class="xref py py-obj docutils literal"><span class="pre">Lat</span></tt></a>(values[, weights])</td>
<td>Latitude axis.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="verticalaxes.html#pygeode.Height" title="pygeode.Height"><tt class="xref py py-obj docutils literal"><span class="pre">Height</span></tt></a>(values[, name, atts, plotatts, rtol])</td>
<td>Geometric height axis.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="verticalaxes.html#pygeode.Pres" title="pygeode.Pres"><tt class="xref py py-obj docutils literal"><span class="pre">Pres</span></tt></a>(values[, name, atts, plotatts, rtol])</td>
<td>Pressure height axis.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="verticalaxes.html#pygeode.Hybrid" title="pygeode.Hybrid"><tt class="xref py py-obj docutils literal"><span class="pre">Hybrid</span></tt></a>(values, A, B, **kwargs)</td>
<td>Hybridized vertical coordinate axis.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="timeaxes.html#pygeode.StandardTime" title="pygeode.StandardTime"><tt class="xref py py-obj docutils literal"><span class="pre">StandardTime</span></tt></a>([values, datefmt, units, startdate])</td>
<td>Time axis describing the standard Gregorian calendar.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="timeaxes.html#pygeode.ModelTime365" title="pygeode.ModelTime365"><tt class="xref py py-obj docutils literal"><span class="pre">ModelTime365</span></tt></a>([values, datefmt, units, startdate])</td>
<td>Time axis describing a model 365-day calendar.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="timeaxes.html#pygeode.ModelTime360" title="pygeode.ModelTime360"><tt class="xref py py-obj docutils literal"><span class="pre">ModelTime360</span></tt></a>([values, datefmt, units, startdate])</td>
<td>Time axis describing a model 360-day calendar.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="timeaxes.html#pygeode.Yearless" title="pygeode.Yearless"><tt class="xref py py-obj docutils literal"><span class="pre">Yearless</span></tt></a>(*args, **kwargs)</td>
<td>Time axis describing a calendar with no months or years.</td>
</tr>
</tbody>
</table>
<p class="rubric">Axis creation helper functions</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="horizontalaxes.html#pygeode.regularlon" title="pygeode.regularlon"><tt class="xref py py-obj docutils literal"><span class="pre">regularlon</span></tt></a>(n[, origin, order, repeat_origin])</td>
<td>Constructs a regularly spaced <a class="reference internal" href="horizontalaxes.html#pygeode.Lon" title="pygeode.Lon"><tt class="xref py py-class docutils literal"><span class="pre">Lon</span></tt></a> axis with n longitudes, from origin to origin + 360.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="horizontalaxes.html#pygeode.regularlat" title="pygeode.regularlat"><tt class="xref py py-obj docutils literal"><span class="pre">regularlat</span></tt></a>(n[, order, inc_poles])</td>
<td>Constructs a regularly spaced <a class="reference internal" href="horizontalaxes.html#pygeode.Lat" title="pygeode.Lat"><tt class="xref py py-class docutils literal"><span class="pre">Lat</span></tt></a> axis with n latitudes.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="horizontalaxes.html#pygeode.gausslat" title="pygeode.gausslat"><tt class="xref py py-obj docutils literal"><span class="pre">gausslat</span></tt></a>(n[, order, axis_dict])</td>
<td>Constructs a Gaussian <a class="reference internal" href="horizontalaxes.html#pygeode.Lat" title="pygeode.Lat"><tt class="xref py py-class docutils literal"><span class="pre">Lat</span></tt></a> axis with n latitudes.</td>
</tr>
</tbody>
</table>
<p class="rubric">General operations</p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><tt class="xref py py-obj docutils literal"><span class="pre">concat</span></tt></td>
<td></td>
</tr>
<tr class="row-even"><td><tt class="xref py py-obj docutils literal"><span class="pre">ensemble</span></tt>(*varlists)</td>
<td>Creates an ensemble out of a set of similar variables.</td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-obj docutils literal"><span class="pre">composite</span></tt></td>
<td></td>
</tr>
<tr class="row-even"><td><tt class="xref py py-obj docutils literal"><span class="pre">lag</span></tt></td>
<td></td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-obj docutils literal"><span class="pre">vprod</span></tt>(*args)</td>
<td>Multiplies an arbitrary number of variables together</td>
</tr>
<tr class="row-even"><td><tt class="xref py py-obj docutils literal"><span class="pre">vsum</span></tt>(*args)</td>
<td>Adds an arbitrary number of variables together</td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="ufunc.html"><em>Element-wise math</em></a></p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.sign" title="pygeode.sign"><tt class="xref py py-obj docutils literal"><span class="pre">sign</span></tt></a>(x)</td>
<td>Sign (+1 = <em>positive</em>, -1 = <em>negative</em>).</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.exp" title="pygeode.exp"><tt class="xref py py-obj docutils literal"><span class="pre">exp</span></tt></a>(x)</td>
<td>Natural exponent.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.log" title="pygeode.log"><tt class="xref py py-obj docutils literal"><span class="pre">log</span></tt></a>(x)</td>
<td>Natural logarithm.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.log10" title="pygeode.log10"><tt class="xref py py-obj docutils literal"><span class="pre">log10</span></tt></a>(x)</td>
<td>Base-10 logarithm.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.cos" title="pygeode.cos"><tt class="xref py py-obj docutils literal"><span class="pre">cos</span></tt></a>(x)</td>
<td>Cosine of angle (in radians).</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.sin" title="pygeode.sin"><tt class="xref py py-obj docutils literal"><span class="pre">sin</span></tt></a>(x)</td>
<td>Sine of angle (in radians).</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.tan" title="pygeode.tan"><tt class="xref py py-obj docutils literal"><span class="pre">tan</span></tt></a>(x)</td>
<td>Tangent of angle (in radians).</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.cosd" title="pygeode.cosd"><tt class="xref py py-obj docutils literal"><span class="pre">cosd</span></tt></a>(x)</td>
<td>Cosine of angle (in degrees)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.sind" title="pygeode.sind"><tt class="xref py py-obj docutils literal"><span class="pre">sind</span></tt></a>(x)</td>
<td>Sine of angle (in degrees)</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.tand" title="pygeode.tand"><tt class="xref py py-obj docutils literal"><span class="pre">tand</span></tt></a>(x)</td>
<td>Tangent of angle (in degrees)</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.sinh" title="pygeode.sinh"><tt class="xref py py-obj docutils literal"><span class="pre">sinh</span></tt></a>(x)</td>
<td>Hyperbolic sine.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.cosh" title="pygeode.cosh"><tt class="xref py py-obj docutils literal"><span class="pre">cosh</span></tt></a>(x)</td>
<td>Hyperbolic cosine.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.tanh" title="pygeode.tanh"><tt class="xref py py-obj docutils literal"><span class="pre">tanh</span></tt></a>(x)</td>
<td>Hyperbolic tangent.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.arcsin" title="pygeode.arcsin"><tt class="xref py py-obj docutils literal"><span class="pre">arcsin</span></tt></a>(x)</td>
<td>Inverse sine (in radians).</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.arccos" title="pygeode.arccos"><tt class="xref py py-obj docutils literal"><span class="pre">arccos</span></tt></a>(x)</td>
<td>Inverse cosine (in radians).</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.arctan" title="pygeode.arctan"><tt class="xref py py-obj docutils literal"><span class="pre">arctan</span></tt></a>(x)</td>
<td>Inverse tangent (in radians).</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.arctan2" title="pygeode.arctan2"><tt class="xref py py-obj docutils literal"><span class="pre">arctan2</span></tt></a>(x, y)</td>
<td>Inverse tangent.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.arcsind" title="pygeode.arcsind"><tt class="xref py py-obj docutils literal"><span class="pre">arcsind</span></tt></a>(x)</td>
<td>Inverse sine (in degrees).</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.arccosd" title="pygeode.arccosd"><tt class="xref py py-obj docutils literal"><span class="pre">arccosd</span></tt></a>(x)</td>
<td>Inverse cosine (in degrees).</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.arctand" title="pygeode.arctand"><tt class="xref py py-obj docutils literal"><span class="pre">arctand</span></tt></a>(x)</td>
<td>Inverse tangent (in degrees).</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.arctand2" title="pygeode.arctand2"><tt class="xref py py-obj docutils literal"><span class="pre">arctand2</span></tt></a>(x, y)</td>
<td>Inverse tangent.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.arcsinh" title="pygeode.arcsinh"><tt class="xref py py-obj docutils literal"><span class="pre">arcsinh</span></tt></a>(x)</td>
<td>Inverse hyperbolic sine.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.arccosh" title="pygeode.arccosh"><tt class="xref py py-obj docutils literal"><span class="pre">arccosh</span></tt></a>(x)</td>
<td>Inverse hyperbolic cosine.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.arctanh" title="pygeode.arctanh"><tt class="xref py py-obj docutils literal"><span class="pre">arctanh</span></tt></a>(x)</td>
<td>Inverse hyperbolic tangent.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.sqrt" title="pygeode.sqrt"><tt class="xref py py-obj docutils literal"><span class="pre">sqrt</span></tt></a>(x)</td>
<td>Square root.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.absolute" title="pygeode.absolute"><tt class="xref py py-obj docutils literal"><span class="pre">absolute</span></tt></a>(x)</td>
<td>Absolute value.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.nan_to_num" title="pygeode.nan_to_num"><tt class="xref py py-obj docutils literal"><span class="pre">nan_to_num</span></tt></a>(x)</td>
<td>Replace nan with zero and inf with finite numbers.</td>
</tr>
<tr class="row-even"><td><tt class="xref py py-obj docutils literal"><span class="pre">minimum</span></tt>(x, y)</td>
<td>Element-wise minimum of the two given arguments.</td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-obj docutils literal"><span class="pre">maximum</span></tt>(x, y)</td>
<td>Element-wise maximum of the two given arguments.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.real" title="pygeode.real"><tt class="xref py py-obj docutils literal"><span class="pre">real</span></tt></a>(x)</td>
<td>Real part of a complex array.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="ufunc.html#pygeode.imag" title="pygeode.imag"><tt class="xref py py-obj docutils literal"><span class="pre">imag</span></tt></a>(x)</td>
<td>Imaginary part of a complex array.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="ufunc.html#pygeode.angle" title="pygeode.angle"><tt class="xref py py-obj docutils literal"><span class="pre">angle</span></tt></a>(x)</td>
<td>Angles (arguments) of a complex array.</td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="climat.html"><em>Climat module</em></a></p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="climat.html#pygeode.dailymean" title="pygeode.dailymean"><tt class="xref py py-obj docutils literal"><span class="pre">dailymean</span></tt></a>(var)</td>
<td>Computes an average value for each day.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="climat.html#pygeode.monthlymean" title="pygeode.monthlymean"><tt class="xref py py-obj docutils literal"><span class="pre">monthlymean</span></tt></a>(var)</td>
<td>Averages over each month.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="climat.html#pygeode.seasonalmean" title="pygeode.seasonalmean"><tt class="xref py py-obj docutils literal"><span class="pre">seasonalmean</span></tt></a>(var)</td>
<td>Averages over each season.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="climat.html#pygeode.yearlymean" title="pygeode.yearlymean"><tt class="xref py py-obj docutils literal"><span class="pre">yearlymean</span></tt></a>(var)</td>
<td>Averages over each year.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="climat.html#pygeode.diurnalmean" title="pygeode.diurnalmean"><tt class="xref py py-obj docutils literal"><span class="pre">diurnalmean</span></tt></a>(var)</td>
<td>Computes an average value for each time of day (averages over all years, months, days).</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="climat.html#pygeode.climatology" title="pygeode.climatology"><tt class="xref py py-obj docutils literal"><span class="pre">climatology</span></tt></a>(var)</td>
<td>Computes a climatological mean.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="climat.html#pygeode.climtrend" title="pygeode.climtrend"><tt class="xref py py-obj docutils literal"><span class="pre">climtrend</span></tt></a>(var)</td>
<td>For each month, day, hour, etc., compute a least-squares fit to a linear trend over all years.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="climat.html#pygeode.from_trend" title="pygeode.from_trend"><tt class="xref py py-obj docutils literal"><span class="pre">from_trend</span></tt></a>(taxis[, coef, A, B])</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="climat.html#module-pygeode.climat" title="pygeode.climat"><tt class="xref py py-obj docutils literal"><span class="pre">climat</span></tt></a></td>
<td></td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="timeutils.html"><em>Timeutils module</em></a></p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><tt class="xref py py-obj docutils literal"><span class="pre">timeutils</span></tt></td>
<td>A set of tools for manipulating time axes.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="timeutils.html#pygeode.timeutils.conform_values" title="pygeode.timeutils.conform_values"><tt class="xref py py-obj docutils literal"><span class="pre">timeutils.conform_values</span></tt></a>(taxis1, taxis2)</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="timeutils.html#pygeode.timeutils.date_diff" title="pygeode.timeutils.date_diff"><tt class="xref py py-obj docutils literal"><span class="pre">timeutils.date_diff</span></tt></a>(taxis, dt1, dt2[, units])</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="timeutils.html#pygeode.timeutils.delta" title="pygeode.timeutils.delta"><tt class="xref py py-obj docutils literal"><span class="pre">timeutils.delta</span></tt></a>(taxis[, units])</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="timeutils.html#pygeode.timeutils.jointimeaxes" title="pygeode.timeutils.jointimeaxes"><tt class="xref py py-obj docutils literal"><span class="pre">timeutils.jointimeaxes</span></tt></a>(var[, yaxis, daxis])</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="timeutils.html#pygeode.timeutils.modify" title="pygeode.timeutils.modify"><tt class="xref py py-obj docutils literal"><span class="pre">timeutils.modify</span></tt></a>(taxis[, resolution, ...])</td>
<td>Modifies the auxiliary arrays associated with a time axis.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="timeutils.html#pygeode.timeutils.reltime" title="pygeode.timeutils.reltime"><tt class="xref py py-obj docutils literal"><span class="pre">timeutils.reltime</span></tt></a>(taxis[, startdate, units])</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="timeutils.html#pygeode.timeutils.removeleapyears" title="pygeode.timeutils.removeleapyears"><tt class="xref py py-obj docutils literal"><span class="pre">timeutils.removeleapyears</span></tt></a>(data[, ...])</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="timeutils.html#pygeode.timeutils.splittimeaxis" title="pygeode.timeutils.splittimeaxis"><tt class="xref py py-obj docutils literal"><span class="pre">timeutils.splittimeaxis</span></tt></a>(var[, iaxis])</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="timeutils.html#pygeode.timeutils.wrapdate" title="pygeode.timeutils.wrapdate"><tt class="xref py py-obj docutils literal"><span class="pre">timeutils.wrapdate</span></tt></a>(taxis, dt[, allfields])</td>
<td></td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="stats.html"><em>Stats module</em></a></p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="stats.html#pygeode.correlate" title="pygeode.correlate"><tt class="xref py py-obj docutils literal"><span class="pre">correlate</span></tt></a>(X, Y[, axes, pbar])</td>
<td>Computes correlation between variables X and Y.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="stats.html#pygeode.regress" title="pygeode.regress"><tt class="xref py py-obj docutils literal"><span class="pre">regress</span></tt></a>(X, Y[, axes, pbar, N_fac, output])</td>
<td>Computes least-squares linear regression of Y against X.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="stats.html#pygeode.multiple_regress" title="pygeode.multiple_regress"><tt class="xref py py-obj docutils literal"><span class="pre">multiple_regress</span></tt></a>(Xs, Y[, axes, pbar, N_fac, ...])</td>
<td>Computes least-squares multiple regression of Y against variables Xs.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="stats.html#pygeode.difference" title="pygeode.difference"><tt class="xref py py-obj docutils literal"><span class="pre">difference</span></tt></a>(X, Y, axes[, alpha, Nx_fac, ...])</td>
<td>Computes the mean value and statistics of X - Y.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="stats.html#pygeode.isnonzero" title="pygeode.isnonzero"><tt class="xref py py-obj docutils literal"><span class="pre">isnonzero</span></tt></a>(X, axes[, alpha, N_fac, pbar])</td>
<td>Computes the mean value and statistics of X, against the hypothesis that it is 0.</td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="eof.html"><em>EOF Analysis</em></a></p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><tt class="xref py py-obj docutils literal"><span class="pre">EOF</span></tt>(x[, num, iaxis, weight, out])</td>
<td>Computes the leading Empirical Orthogonal Function(s) for the given variable.</td>
</tr>
<tr class="row-even"><td><tt class="xref py py-obj docutils literal"><span class="pre">SVD</span></tt>(var1, var2[, num, weight1, weight2])</td>
<td>Finds coupled EOFs of two fields.</td>
</tr>
<tr class="row-odd"><td><tt class="xref py py-obj docutils literal"><span class="pre">eof</span></tt></td>
<td></td>
</tr>
</tbody>
</table>
<p><a class="reference internal" href="plot.html"><em>Plot module</em></a></p>
<table border="1" class="longtable docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><a class="reference internal" href="plot.html#pygeode.showvar" title="pygeode.showvar"><tt class="xref py py-obj docutils literal"><span class="pre">showvar</span></tt></a>(var, *args, **kwargs)</td>
<td>Plot variable, showing a contour plot for 2d variables or a line plot for 1d variables.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="plot.html#pygeode.showcol" title="pygeode.showcol"><tt class="xref py py-obj docutils literal"><span class="pre">showcol</span></tt></a>(vs[, size])</td>
<td>Plot variable, showing a contour plot for 2d variables or a line plot for 1d variables.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="plot.html#pygeode.showgrid" title="pygeode.showgrid"><tt class="xref py py-obj docutils literal"><span class="pre">showgrid</span></tt></a>(vf[, vl, ncol, size, lbl])</td>
<td>Plot contours</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="plot.html#pygeode.showlines" title="pygeode.showlines"><tt class="xref py py-obj docutils literal"><span class="pre">showlines</span></tt></a>(vs[, fmts, labels, size])</td>
<td>Plot line plots of a list of 1D variables on the same plot.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="plot.html#pygeode.vcontour" title="pygeode.vcontour"><tt class="xref py py-obj docutils literal"><span class="pre">vcontour</span></tt></a>(var[, clevs, clines, axes, lblx, ...])</td>
<td>Create a contour plot (lines, filled, or both) from a variable.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="plot.html#pygeode.vplot" title="pygeode.vplot"><tt class="xref py py-obj docutils literal"><span class="pre">vplot</span></tt></a>(var[, fmt, axes, transpose, lblx, lbly])</td>
<td>Plot variable, showing a contour plot for 2d variables or a line plot for 1d variables.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="plot.html#pygeode.vscatter" title="pygeode.vscatter"><tt class="xref py py-obj docutils literal"><span class="pre">vscatter</span></tt></a>(varx, vary[, axes, lblx, lbly])</td>
<td>Do a scatter plot of a variable.</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="plot.html#pygeode.vquiver" title="pygeode.vquiver"><tt class="xref py py-obj docutils literal"><span class="pre">vquiver</span></tt></a>(varu, varv[, varc, axes, lblx, ...])</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="plot.html#pygeode.vstreamplot" title="pygeode.vstreamplot"><tt class="xref py py-obj docutils literal"><span class="pre">vstreamplot</span></tt></a>(varu, varv[, axes, lblx, lbly, ...])</td>
<td></td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="plot.html#pygeode.vsigmask" title="pygeode.vsigmask"><tt class="xref py py-obj docutils literal"><span class="pre">vsigmask</span></tt></a>(var, axes[, mjsig, mjc, mjalpha, ...])</td>
<td></td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="plot.html#module-pygeode.plot" title="pygeode.plot"><tt class="xref py py-obj docutils literal"><span class="pre">plot</span></tt></a></td>
<td></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"><em>View module</em></a></p>
<blockquote>
<div>A helper class for mapping subsets of variables</div></blockquote>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Reference</a><ul>
<li><a class="reference internal" href="#under-the-hood">Under the hood</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="tut_adv.html"
title="previous chapter">Advanced Variable Operations</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="var.html"
title="next chapter">Var class overview</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/reference.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="var.html" title="Var class overview"
>next</a> |</li>
<li class="right" >
<a href="tut_adv.html" title="Advanced Variable Operations"
>previous</a> |</li>
<li><a href="index.html">PyGeode 1.0 alpha documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2013, Mike Neish, Peter Hitchcock.
Last updated on Sep 13, 2015.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>