-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathtimeaxes.html
622 lines (583 loc) · 59.6 KB
/
timeaxes.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
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Time axes objects 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="Dataset overview" href="dataset.html" />
<link rel="prev" title="Vertical axes object reference" href="verticalaxes.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>Time axes objects reference</span></h2>
</div>
<div class="topnav" role="navigation" aria-label="top navigation">
<p>
«  <a href="verticalaxes.html">Vertical axes object reference</a>
  ::  
<a class="uplink" href="reference.html">Reference</a>
  ::  
<a class="uplink" href="tutorial.html">Tutorial</a>
  ::  
<a class="uplink" href="gallery/index.html">Gallery</a>
  ::  
<a href="dataset.html">Dataset overview</a>  »
</p>
</div>
<div class="content">
<div class="section" id="time-axes-objects-reference">
<h1>Time axes objects reference<a class="headerlink" href="#time-axes-objects-reference" title="Permalink to this headline">¶</a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="pygeode.TAxis">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pygeode.</span></span><span class="sig-name descname"><span class="pre">TAxis</span></span><a class="reference internal" href="_modules/pygeode/axis.html#TAxis"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.TAxis" title="Permalink to this definition">¶</a></dt>
<dd><p>Inherits from <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></p>
<p>Generic parent class for axes representing time coordinates, plotted by default on
the horizontal axis in line plots and in contour plots. No new or overridden methods.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pygeode.timeaxis.Time">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pygeode.timeaxis.</span></span><span class="sig-name descname"><span class="pre">Time</span></span><a class="reference internal" href="_modules/pygeode/timeaxis.html#Time"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.timeaxis.Time" title="Permalink to this definition">¶</a></dt>
<dd><p>Inherits from <code class="xref py py-class docutils literal notranslate"><span class="pre">TAxis</span></code></p>
<p>Parent class for axes representing times.</p>
<p class="rubric">New and overridden methods</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="#pygeode.timeaxis.Time.__init__" title="pygeode.timeaxis.Time.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Time.__init__</span></code></a>([values, startdate, units])</p></td>
<td><p>Create a new Axis object with the given values.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pygeode.timeaxis.Time.formatter" title="pygeode.timeaxis.Time.formatter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Time.formatter</span></code></a>()</p></td>
<td><p>Returns a matplotlib axis Formatter object; by default a FuncFormatter which calls formatvalue().</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pygeode.timeaxis.Time.locator" title="pygeode.timeaxis.Time.locator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Time.locator</span></code></a>()</p></td>
<td><p>locator() - Returns an AutoCalendarLocator object</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pygeode.timeaxis.Time.map_to" title="pygeode.timeaxis.Time.map_to"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Time.map_to</span></code></a>(other)</p></td>
<td><p>Define a mapping between this time axis and another one, if one exists.</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pygeode.timeaxis.CalendarTime">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pygeode.timeaxis.</span></span><span class="sig-name descname"><span class="pre">CalendarTime</span></span><a class="reference internal" href="_modules/pygeode/timeaxis.html#CalendarTime"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.timeaxis.CalendarTime" title="Permalink to this definition">¶</a></dt>
<dd><p>Inherits from <a class="reference internal" href="#pygeode.timeaxis.Time" title="pygeode.timeaxis.Time"><code class="xref py py-class docutils literal notranslate"><span class="pre">Time</span></code></a></p>
<p>Parent class for time axes with an associated calendar.</p>
<p class="rubric">Attributes</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalendarTime.parse_patterns</span></code></p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
<p class="rubric">New and overridden methods</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="#pygeode.timeaxis.CalendarTime.__init__" title="pygeode.timeaxis.CalendarTime.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalendarTime.__init__</span></code></a>([values, datefmt, ...])</p></td>
<td><p>Create a new Axis object with the given values.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pygeode.timeaxis.CalendarTime.days_in_month" title="pygeode.timeaxis.CalendarTime.days_in_month"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalendarTime.days_in_month</span></code></a>(yr, mn)</p></td>
<td><p></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pygeode.timeaxis.CalendarTime.formatvalue" title="pygeode.timeaxis.CalendarTime.formatvalue"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalendarTime.formatvalue</span></code></a>(value[, fmt, ...])</p></td>
<td><p>Returns formatted string representation of <code class="docutils literal notranslate"><span class="pre">value</span></code>, using a strftime-like specification.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pygeode.timeaxis.CalendarTime.str_as_val" title="pygeode.timeaxis.CalendarTime.str_as_val"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalendarTime.str_as_val</span></code></a>(key, s)</p></td>
<td><p>Converts a string representation of a date to a value according to the calendar defined by this time axis.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#pygeode.timeaxis.CalendarTime.val_as_date" title="pygeode.timeaxis.CalendarTime.val_as_date"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalendarTime.val_as_date</span></code></a>([vals, startdate, ...])</p></td>
<td><p></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pygeode.timeaxis.CalendarTime.date_as_val" title="pygeode.timeaxis.CalendarTime.date_as_val"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CalendarTime.date_as_val</span></code></a>([dates, startdate, ...])</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pygeode.StandardTime">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pygeode.</span></span><span class="sig-name descname"><span class="pre">StandardTime</span></span><a class="reference internal" href="_modules/pygeode/timeaxis.html#StandardTime"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.StandardTime" title="Permalink to this definition">¶</a></dt>
<dd><p>Inherits from <a class="reference internal" href="#pygeode.timeaxis.CalendarTime" title="pygeode.timeaxis.CalendarTime"><code class="xref py py-class docutils literal notranslate"><span class="pre">CalendarTime</span></code></a></p>
<p>Time axis representing the standard calendar.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pygeode.ModelTime365">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pygeode.</span></span><span class="sig-name descname"><span class="pre">ModelTime365</span></span><a class="reference internal" href="_modules/pygeode/timeaxis.html#ModelTime365"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.ModelTime365" title="Permalink to this definition">¶</a></dt>
<dd><p>Inherits from <a class="reference internal" href="#pygeode.timeaxis.CalendarTime" title="pygeode.timeaxis.CalendarTime"><code class="xref py py-class docutils literal notranslate"><span class="pre">CalendarTime</span></code></a></p>
<p>Time axis representing a calendar with a 365 day year.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pygeode.ModelTime360">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pygeode.</span></span><span class="sig-name descname"><span class="pre">ModelTime360</span></span><a class="reference internal" href="_modules/pygeode/timeaxis.html#ModelTime360"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.ModelTime360" title="Permalink to this definition">¶</a></dt>
<dd><p>Inherits from <a class="reference internal" href="#pygeode.timeaxis.CalendarTime" title="pygeode.timeaxis.CalendarTime"><code class="xref py py-class docutils literal notranslate"><span class="pre">CalendarTime</span></code></a></p>
<p>Time axis representing a calendar with a 360 day year.</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="pygeode.Yearless">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pygeode.</span></span><span class="sig-name descname"><span class="pre">Yearless</span></span><a class="reference internal" href="_modules/pygeode/timeaxis.html#Yearless"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.Yearless" title="Permalink to this definition">¶</a></dt>
<dd><p>Inherits from <a class="reference internal" href="#pygeode.timeaxis.CalendarTime" title="pygeode.timeaxis.CalendarTime"><code class="xref py py-class docutils literal notranslate"><span class="pre">CalendarTime</span></code></a></p>
<p>Time axis representing a calendar that marks days independent of years and months.</p>
<p class="rubric">New and overridden methods</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="#pygeode.Yearless.__init__" title="pygeode.Yearless.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Yearless.__init__</span></code></a>(*args, **kwargs)</p></td>
<td><p>Create a new Axis object with the given values.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#pygeode.Yearless.days_in_month" title="pygeode.Yearless.days_in_month"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Yearless.days_in_month</span></code></a>(yr, mn)</p></td>
<td><p></p></td>
</tr>
</tbody>
</table>
</dd></dl>
<p class="rubric">Utility 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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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="#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>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.timeaxis.Time.__init__">
<span class="sig-prename descclassname"><span class="pre">Time.</span></span><span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">startdate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#Time.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.timeaxis.Time.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new Axis object with the given values.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>values</strong><span class="classifier">numpy.ndarray</span></dt><dd><p>A one-dimensional coordinate defining the axis grid.</p>
</dd>
<dt><strong>name</strong><span class="classifier">string (optional)</span></dt><dd><p>What to call the axis (i.e. for plot titles & when saving to file)</p>
</dd>
<dt><strong>atts</strong><span class="classifier">dict (optional)</span></dt><dd><p>Any additional metadata to associate with the axis. The dictionary
keys should be strings.</p>
</dd>
<dt><strong>plotatts</strong><span class="classifier">dict (optional)</span></dt><dd><p>Parameters that control plotting behaviour; default values are available.
The dictionary keys should be strings.</p>
</dd>
<dt><strong>rtol</strong><span class="classifier">float</span></dt><dd><p>A relative tolerance used for identifying an element of this axis.</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>All subclasses of <code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code> need to call this __init__ method within
their own __init__, to properly initialize all attributes.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.timeaxis.Time.formatter">
<span class="sig-prename descclassname"><span class="pre">Time.</span></span><span class="sig-name descname"><span class="pre">formatter</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#Time.formatter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.timeaxis.Time.formatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a matplotlib axis Formatter object; by default a FuncFormatter which calls formatvalue().</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.timeaxis.Time.locator">
<span class="sig-prename descclassname"><span class="pre">Time.</span></span><span class="sig-name descname"><span class="pre">locator</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#Time.locator"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.timeaxis.Time.locator" title="Permalink to this definition">¶</a></dt>
<dd><p>locator() - Returns an AutoCalendarLocator object</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.timeaxis.Time.map_to">
<span class="sig-prename descclassname"><span class="pre">Time.</span></span><span class="sig-name descname"><span class="pre">map_to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#Time.map_to"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.timeaxis.Time.map_to" title="Permalink to this definition">¶</a></dt>
<dd><p>Define a mapping between this time axis and another one, if one exists.</p>
<dl class="field-list">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl>
<dt><strong>other</strong><span class="classifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code> instance</span></dt><dd><p>Axis instance to find map to.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><strong>indices</strong><span class="classifier">An array of integer indices or None</span></dt><dd><p>If a mapping exists, an array of integer indices which define mapping
from this axis to other (i.e. self[indices] will return the elements in
the appropriate ordering for the mapped axis). Otherwise None.</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>A mapping from this time axis to other can exist only if they are of the
same class (e.g. <code class="xref py py-class docutils literal notranslate"><span class="pre">StandardTime</span></code>), and if the list of auxarrays defined
in this class is a subset of those defined in the other (e.g. a climatology which
defines only ‘month’, and ‘day’ can be mapped to a time axis with ‘year’, ‘month’
‘day’ and ‘hour’, but not one with only ‘year’ and ‘month’.</p>
<p>Matches are sought between the auxiliary arrays shared by the two axes</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="pygeode.timeaxis.CalendarTime.parse_pattern">
<span class="sig-prename descclassname"><span class="pre">CalendarTime.</span></span><span class="sig-name descname"><span class="pre">parse_pattern</span></span><a class="headerlink" href="#pygeode.timeaxis.CalendarTime.parse_pattern" title="Permalink to this definition">¶</a></dt>
<dd><p>A Python regular expression used to parse a string as a date. Date fields
are extracted using the groups ‘year’, ‘month’, ‘day’, ‘hour’, ‘minute’, and ‘second’.
Default pattern recognized strings of the form ‘1 Jan 2000’ or ‘06:00 1 Jan 2000’ or
‘06:00:00 1 Jan 2000’.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.timeaxis.CalendarTime.__init__">
<span class="sig-prename descclassname"><span class="pre">CalendarTime.</span></span><span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">datefmt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">startdate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#CalendarTime.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.timeaxis.CalendarTime.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new Axis object with the given values.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>values</strong><span class="classifier">numpy.ndarray</span></dt><dd><p>A one-dimensional coordinate defining the axis grid.</p>
</dd>
<dt><strong>name</strong><span class="classifier">string (optional)</span></dt><dd><p>What to call the axis (i.e. for plot titles & when saving to file)</p>
</dd>
<dt><strong>atts</strong><span class="classifier">dict (optional)</span></dt><dd><p>Any additional metadata to associate with the axis. The dictionary
keys should be strings.</p>
</dd>
<dt><strong>plotatts</strong><span class="classifier">dict (optional)</span></dt><dd><p>Parameters that control plotting behaviour; default values are available.
The dictionary keys should be strings.</p>
</dd>
<dt><strong>rtol</strong><span class="classifier">float</span></dt><dd><p>A relative tolerance used for identifying an element of this axis.</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>All subclasses of <code class="xref py py-class docutils literal notranslate"><span class="pre">Axis</span></code> need to call this __init__ method within
their own __init__, to properly initialize all attributes.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.timeaxis.CalendarTime.days_in_month">
<span class="sig-prename descclassname"><span class="pre">CalendarTime.</span></span><span class="sig-name descname"><span class="pre">days_in_month</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">yr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mn</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#CalendarTime.days_in_month"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.timeaxis.CalendarTime.days_in_month" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.timeaxis.CalendarTime.formatvalue">
<span class="sig-prename descclassname"><span class="pre">CalendarTime.</span></span><span class="sig-name descname"><span class="pre">formatvalue</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fmt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unitstr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#CalendarTime.formatvalue"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.timeaxis.CalendarTime.formatvalue" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns formatted string representation of <code class="docutils literal notranslate"><span class="pre">value</span></code>, using a strftime-like
specification.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>value</strong><span class="classifier">float or int</span></dt><dd><p>Value to format, in calendar defined by this time axis.</p>
</dd>
<dt><strong>fmt</strong><span class="classifier">string (optional)</span></dt><dd><p>Format specification. If the default <code class="docutils literal notranslate"><span class="pre">None</span></code> is specified,
<code class="docutils literal notranslate"><span class="pre">self.formatstr</span></code> is used.</p>
</dd>
<dt><strong>units</strong><span class="classifier">boolean (optional)</span></dt><dd><p>Not used;, included for consistency with <code class="xref py py-func docutils literal notranslate"><span class="pre">Var.formatvalue()</span></code></p>
</dd>
<dt><strong>unitstr</strong><span class="classifier">string (optional)</span></dt><dd><p>Not used;, included for consistency with <code class="xref py py-func docutils literal notranslate"><span class="pre">Var.formatvalue()</span></code></p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The following codes ($$ will yield the character $):</p>
<ul class="simple">
<li><p>$b - short month name</p></li>
<li><p>$B - full month name</p></li>
<li><p>$d - day of the month</p></li>
<li><p>$D - 2-digit day of the month, zero-padded</p></li>
<li><p>$H - hour (24 hr clock)</p></li>
<li><p>$I - hour (12 hr clock)</p></li>
<li><p>$j - day of the year</p></li>
<li><p>$m - month number (Jan=1, …, Dec=12)</p></li>
<li><p>$M - minute</p></li>
<li><p>$p - am/pm</p></li>
<li><p>$P - AM/PM</p></li>
<li><p>$S - second</p></li>
<li><p>$y - 2 digit year</p></li>
<li><p>$a - 4 digit year</p></li>
<li><p>$Y - full year; if less than 100, preceeded by ‘y’</p></li>
<li><p>$v - value formatted with %d</p></li>
<li><p>$V - value formatted with str()</p></li>
</ul>
<p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">pygeode.tutorial</span> <span class="kn">import</span> <span class="n">t2</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">t2</span><span class="o">.</span><span class="n">time</span><span class="o">.</span><span class="n">formatvalue</span><span class="p">(</span><span class="mf">17.25</span><span class="p">))</span>
<span class="go">Jan 18, 2011 06:00:00</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">t2</span><span class="o">.</span><span class="n">time</span><span class="o">.</span><span class="n">formatvalue</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="s1">'$B $d'</span><span class="p">))</span>
<span class="go">January 1</span>
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">t2</span><span class="o">.</span><span class="n">time</span><span class="o">.</span><span class="n">formatvalue</span><span class="p">(</span><span class="mi">512</span><span class="p">,</span> <span class="s1">'$d/$m/$y'</span><span class="p">))</span>
<span class="go">28/5/12</span>
</pre></div>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.timeaxis.CalendarTime.str_as_val">
<span class="sig-prename descclassname"><span class="pre">CalendarTime.</span></span><span class="sig-name descname"><span class="pre">str_as_val</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">s</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#CalendarTime.str_as_val"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.timeaxis.CalendarTime.str_as_val" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts a string representation of a date to a value according to the
calendar defined by this time axis.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>key</strong><span class="classifier">string</span></dt><dd><p>key used in select()</p>
</dd>
<dt><strong>s</strong><span class="classifier">string</span></dt><dd><p>string to convert</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><strong>val</strong><span class="classifier">value</span></dt><dd><p>value corresponding to specified date.</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>The string is parsed using the regular expression pattern(s) defined in
<code class="xref py py-attr docutils literal notranslate"><span class="pre">parse_patterns</span></code>. By default this assumes
a string in an ISO 8601-like format, or in the form ‘12 Dec 2008’ or ‘06:00:00 1
Jan 1979’. A ValueError is thrown if the regular expression does not
match the string.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.timeaxis.CalendarTime.val_as_date">
<span class="sig-prename descclassname"><span class="pre">CalendarTime.</span></span><span class="sig-name descname"><span class="pre">val_as_date</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">startdate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allfields</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#CalendarTime.val_as_date"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.timeaxis.CalendarTime.val_as_date" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.timeaxis.CalendarTime.date_as_val">
<span class="sig-prename descclassname"><span class="pre">CalendarTime.</span></span><span class="sig-name descname"><span class="pre">date_as_val</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dates</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">startdate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#CalendarTime.date_as_val"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.timeaxis.CalendarTime.date_as_val" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Yearless.__init__">
<span class="sig-prename descclassname"><span class="pre">Yearless.</span></span><span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#Yearless.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.Yearless.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Create a new Axis object with the given values.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>values</strong><span class="classifier">numpy.ndarray</span></dt><dd><p>A one-dimensional coordinate defining the axis grid.</p>
</dd>
<dt><strong>name</strong><span class="classifier">string (optional)</span></dt><dd><p>What to call the axis (i.e. for plot titles & when saving to file)</p>
</dd>
<dt><strong>atts</strong><span class="classifier">dict (optional)</span></dt><dd><p>Any additional metadata to associate with the axis. The dictionary
keys should be strings.</p>
</dd>
<dt><strong>plotatts</strong><span class="classifier">dict (optional)</span></dt><dd><p>Parameters that control plotting behaviour; default values are available.
The dictionary keys should be strings.</p>
</dd>
<dt><strong>rtol</strong><span class="classifier">float</span></dt><dd><p>A relative tolerance used for identifying an element of this axis.</p>
</dd>
</dl>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>All subclasses of <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> need to call this __init__ method within
their own __init__, to properly initialize all attributes.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="pygeode.Yearless.days_in_month">
<span class="sig-prename descclassname"><span class="pre">Yearless.</span></span><span class="sig-name descname"><span class="pre">days_in_month</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">yr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mn</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#Yearless.days_in_month"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.Yearless.days_in_month" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pygeode.standardtimerange">
<span class="sig-prename descclassname"><span class="pre">pygeode.</span></span><span class="sig-name descname"><span class="pre">standardtimerange</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">step</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'days'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#standardtimerange"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.standardtimerange" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a <a class="reference internal" href="#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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>start</strong><span class="classifier">string</span></dt><dd><p>Date to start time axis from (see <a class="reference internal" href="#pygeode.timeaxis.CalendarTime.str_as_val" title="pygeode.timeaxis.CalendarTime.str_as_val"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str_as_val()</span></code></a>)</p>
</dd>
<dt><strong>end</strong><span class="classifier">string</span></dt><dd><p>Date to end time axis at. Note this date will not be included.</p>
</dd>
<dt><strong>step</strong><span class="classifier">float, optional</span></dt><dd><p>Interval between grid points. Default is 1.</p>
</dd>
<dt><strong>units</strong><span class="classifier">one of ‘seconds’, ‘minutes’, ‘hours’, ‘days’, optional</span></dt><dd><p>Unit in which to define time step values. Default is ‘days’.</p>
</dd>
<dt><strong>ref</strong><span class="classifier">string, optional</span></dt><dd><p>Reference date for calendar. If the default None is specified, start is used.</p>
</dd>
<dt><strong>inc</strong><span class="classifier">boolean, optional (default False)</span></dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pygeode.standardtimen">
<span class="sig-prename descclassname"><span class="pre">pygeode.</span></span><span class="sig-name descname"><span class="pre">standardtimen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">step</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'days'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#standardtimen"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.standardtimen" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a <a class="reference internal" href="#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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>start</strong><span class="classifier">string</span></dt><dd><p>Date to start time axis from (see <a class="reference internal" href="#pygeode.timeaxis.CalendarTime.str_as_val" title="pygeode.timeaxis.CalendarTime.str_as_val"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str_as_val()</span></code></a>)</p>
</dd>
<dt><strong>n</strong><span class="classifier">integer</span></dt><dd><p>Length of axis to create</p>
</dd>
<dt><strong>step</strong><span class="classifier">float, optional</span></dt><dd><p>Interval between grid points. Default is 1.</p>
</dd>
<dt><strong>units</strong><span class="classifier">one of ‘seconds’, ‘minutes’, ‘hours’, ‘days’, optional</span></dt><dd><p>Unit in which to define time step values. Default is ‘days’.</p>
</dd>
<dt><strong>ref</strong><span class="classifier">string, optional</span></dt><dd><p>Reference date for calendar. If the default None is specified, start is used.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pygeode.modeltime365range">
<span class="sig-prename descclassname"><span class="pre">pygeode.</span></span><span class="sig-name descname"><span class="pre">modeltime365range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">step</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'days'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#modeltime365range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.modeltime365range" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a <a class="reference internal" href="#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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>start</strong><span class="classifier">string</span></dt><dd><p>Date to start time axis from (see <a class="reference internal" href="#pygeode.timeaxis.CalendarTime.str_as_val" title="pygeode.timeaxis.CalendarTime.str_as_val"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str_as_val()</span></code></a>)</p>
</dd>
<dt><strong>end</strong><span class="classifier">string</span></dt><dd><p>Date to end time axis at. Note this date will not be included.</p>
</dd>
<dt><strong>step</strong><span class="classifier">float, optional</span></dt><dd><p>Interval between grid points. Default is 1.</p>
</dd>
<dt><strong>units</strong><span class="classifier">one of ‘seconds’, ‘minutes’, ‘hours’, ‘days’, optional</span></dt><dd><p>Unit in which to define time step values. Default is ‘days’.</p>
</dd>
<dt><strong>ref</strong><span class="classifier">string, optional</span></dt><dd><p>Reference date for calendar. If the default None is specified, start is used.</p>
</dd>
<dt><strong>inc</strong><span class="classifier">boolean, optional (default False)</span></dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pygeode.modeltime365n">
<span class="sig-prename descclassname"><span class="pre">pygeode.</span></span><span class="sig-name descname"><span class="pre">modeltime365n</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">step</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'days'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#modeltime365n"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.modeltime365n" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a <a class="reference internal" href="#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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>start</strong><span class="classifier">string</span></dt><dd><p>Date to start time axis from (see <a class="reference internal" href="#pygeode.timeaxis.CalendarTime.str_as_val" title="pygeode.timeaxis.CalendarTime.str_as_val"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str_as_val()</span></code></a>)</p>
</dd>
<dt><strong>n</strong><span class="classifier">integer</span></dt><dd><p>Length of axis to create</p>
</dd>
<dt><strong>step</strong><span class="classifier">float, optional</span></dt><dd><p>Interval between grid points. Default is 1.</p>
</dd>
<dt><strong>units</strong><span class="classifier">one of ‘seconds’, ‘minutes’, ‘hours’, ‘days’, optional</span></dt><dd><p>Unit in which to define time step values. Default is ‘days’.</p>
</dd>
<dt><strong>ref</strong><span class="classifier">string, optional</span></dt><dd><p>Reference date for calendar. If the default None is specified, start is used.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pygeode.modeltime360range">
<span class="sig-prename descclassname"><span class="pre">pygeode.</span></span><span class="sig-name descname"><span class="pre">modeltime360range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">step</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'days'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#modeltime360range"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.modeltime360range" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a <a class="reference internal" href="#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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>start</strong><span class="classifier">string</span></dt><dd><p>Date to start time axis from (see <a class="reference internal" href="#pygeode.timeaxis.CalendarTime.str_as_val" title="pygeode.timeaxis.CalendarTime.str_as_val"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str_as_val()</span></code></a>)</p>
</dd>
<dt><strong>end</strong><span class="classifier">string</span></dt><dd><p>Date to end time axis at. Note this date will not be included.</p>
</dd>
<dt><strong>step</strong><span class="classifier">float, optional</span></dt><dd><p>Interval between grid points. Default is 1.</p>
</dd>
<dt><strong>units</strong><span class="classifier">one of ‘seconds’, ‘minutes’, ‘hours’, ‘days’, optional</span></dt><dd><p>Unit in which to define time step values. Default is ‘days’.</p>
</dd>
<dt><strong>ref</strong><span class="classifier">string, optional</span></dt><dd><p>Reference date for calendar. If the default None is specified, start is used.</p>
</dd>
<dt><strong>inc</strong><span class="classifier">boolean, optional (default False)</span></dt><dd></dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pygeode.modeltime360n">
<span class="sig-prename descclassname"><span class="pre">pygeode.</span></span><span class="sig-name descname"><span class="pre">modeltime360n</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">step</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'days'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ref</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#modeltime360n"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.modeltime360n" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a <a class="reference internal" href="#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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>start</strong><span class="classifier">string</span></dt><dd><p>Date to start time axis from (see <a class="reference internal" href="#pygeode.timeaxis.CalendarTime.str_as_val" title="pygeode.timeaxis.CalendarTime.str_as_val"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str_as_val()</span></code></a>)</p>
</dd>
<dt><strong>n</strong><span class="classifier">integer</span></dt><dd><p>Length of axis to create</p>
</dd>
<dt><strong>step</strong><span class="classifier">float, optional</span></dt><dd><p>Interval between grid points. Default is 1.</p>
</dd>
<dt><strong>units</strong><span class="classifier">one of ‘seconds’, ‘minutes’, ‘hours’, ‘days’, optional</span></dt><dd><p>Unit in which to define time step values. Default is ‘days’.</p>
</dd>
<dt><strong>ref</strong><span class="classifier">string, optional</span></dt><dd><p>Reference date for calendar. If the default None is specified, start is used.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="pygeode.yearlessn">
<span class="sig-prename descclassname"><span class="pre">pygeode.</span></span><span class="sig-name descname"><span class="pre">yearlessn</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">n</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">step</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">units</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'days'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pygeode/timeaxis.html#yearlessn"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pygeode.yearlessn" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a <a class="reference internal" href="#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>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>start</strong><span class="classifier">string</span></dt><dd><p>Date to start time axis from (see <a class="reference internal" href="#pygeode.timeaxis.CalendarTime.str_as_val" title="pygeode.timeaxis.CalendarTime.str_as_val"><code class="xref py py-meth docutils literal notranslate"><span class="pre">str_as_val()</span></code></a>)</p>
</dd>
<dt><strong>n</strong><span class="classifier">integer</span></dt><dd><p>Length of axis to create</p>
</dd>
<dt><strong>step</strong><span class="classifier">float, optional</span></dt><dd><p>Interval between grid points. Default is 1.</p>
</dd>
<dt><strong>units</strong><span class="classifier">one of ‘seconds’, ‘minutes’, ‘hours’, ‘days’, optional</span></dt><dd><p>Unit in which to define time step values. Default is ‘days’.</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
</div>
</div>
<div class="bottomnav" role="navigation" aria-label="bottom navigation">
<p>
«  <a href="verticalaxes.html">Vertical axes object reference</a>
  ::  
<a class="uplink" href="reference.html">Reference</a>
  ::  
<a class="uplink" href="tutorial.html">Tutorial</a>
  ::  
<a class="uplink" href="gallery/index.html">Gallery</a>
  ::  
<a href="dataset.html">Dataset 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>