forked from pygeode/pygeode.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtimeutils.html
194 lines (175 loc) · 8.91 KB
/
timeutils.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
<!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>Timeutils module — 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="up" title="Reference" href="reference.html" />
<link rel="next" title="Climat module" href="climat.html" />
<link rel="prev" title="File Input and Output" href="fileio.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="climat.html" title="Climat module"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="fileio.html" title="File Input and Output"
accesskey="P">previous</a> |</li>
<li><a href="index.html">PyGeode 1.0 alpha documentation</a> »</li>
<li><a href="reference.html" accesskey="U">Reference</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="timeutils-module">
<h1>Timeutils module<a class="headerlink" href="#timeutils-module" title="Permalink to this headline">¶</a></h1>
<dl class="function">
<dt id="pygeode.timeutils.conform_values">
<tt class="descclassname">pygeode.timeutils.</tt><tt class="descname">conform_values</tt><big>(</big><em>taxis1</em>, <em>taxis2</em><big>)</big><a class="headerlink" href="#pygeode.timeutils.conform_values" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pygeode.timeutils.date_diff">
<tt class="descclassname">pygeode.timeutils.</tt><tt class="descname">date_diff</tt><big>(</big><em>taxis</em>, <em>dt1</em>, <em>dt2</em>, <em>units=None</em><big>)</big><a class="headerlink" href="#pygeode.timeutils.date_diff" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pygeode.timeutils.delta">
<tt class="descclassname">pygeode.timeutils.</tt><tt class="descname">delta</tt><big>(</big><em>taxis</em>, <em>units=None</em><big>)</big><a class="headerlink" href="#pygeode.timeutils.delta" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pygeode.timeutils.jointimeaxes">
<tt class="descclassname">pygeode.timeutils.</tt><tt class="descname">jointimeaxes</tt><big>(</big><em>var</em>, <em>yaxis='year'</em>, <em>daxis='day'</em><big>)</big><a class="headerlink" href="#pygeode.timeutils.jointimeaxes" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pygeode.timeutils.modify">
<tt class="descclassname">pygeode.timeutils.</tt><tt class="descname">modify</tt><big>(</big><em>taxis</em>, <em>resolution=None</em>, <em>exclude=</em>, <span class="optional">[</span><span class="optional">]</span><em>include=</em>, <span class="optional">[</span><span class="optional">]</span><em>uniquify=False</em><big>)</big><a class="headerlink" href="#pygeode.timeutils.modify" title="Permalink to this definition">¶</a></dt>
<dd><p>Modifies the auxiliary arrays associated with a time axis.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>taxis</strong> : time axis instance</p>
<blockquote>
<div><p>Time axis to modify</p>
</div></blockquote>
<p><strong>resolution</strong> : {None, ‘year’, ‘month’, ‘day’, ‘hour’, ‘minute’, ‘second’}, optional</p>
<blockquote>
<div><p>Finest division to retain.</p>
</div></blockquote>
<p><strong>exclude</strong> : list of strings, optional</p>
<blockquote>
<div><p>List of arrays to remove</p>
</div></blockquote>
<p><strong>include</strong> : list of strings, optional</p>
<blockquote>
<div><p>Explicit list of arrays to include</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>taxis</strong> : time axis instance</p>
<blockquote class="last">
<div><p>Modified time axis</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="pygeode.timeutils.reltime">
<tt class="descclassname">pygeode.timeutils.</tt><tt class="descname">reltime</tt><big>(</big><em>taxis</em>, <em>startdate=None</em>, <em>units=None</em><big>)</big><a class="headerlink" href="#pygeode.timeutils.reltime" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pygeode.timeutils.removeleapyears">
<tt class="descclassname">pygeode.timeutils.</tt><tt class="descname">removeleapyears</tt><big>(</big><em>data, omitdoy_leap=[60], omitdoy_noleap=[], new_axis_type=<class 'pygeode.timeaxis.ModelTime365'></em><big>)</big><a class="headerlink" href="#pygeode.timeutils.removeleapyears" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pygeode.timeutils.splittimeaxis">
<tt class="descclassname">pygeode.timeutils.</tt><tt class="descname">splittimeaxis</tt><big>(</big><em>var</em>, <em>iaxis='time'</em><big>)</big><a class="headerlink" href="#pygeode.timeutils.splittimeaxis" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="function">
<dt id="pygeode.timeutils.wrapdate">
<tt class="descclassname">pygeode.timeutils.</tt><tt class="descname">wrapdate</tt><big>(</big><em>taxis</em>, <em>dt</em>, <em>allfields=False</em><big>)</big><a class="headerlink" href="#pygeode.timeutils.wrapdate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="fileio.html"
title="previous chapter">File Input and Output</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="climat.html"
title="next chapter">Climat module</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/timeutils.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="climat.html" title="Climat module"
>next</a> |</li>
<li class="right" >
<a href="fileio.html" title="File Input and Output"
>previous</a> |</li>
<li><a href="index.html">PyGeode 1.0 alpha documentation</a> »</li>
<li><a href="reference.html" >Reference</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>