source: flex_extract.git/documentation/Sphinx/build/html/api.html @ 708c667

ctbtodev
Last change on this file since 708c667 was 708c667, checked in by Anne Philipp <anne.philipp@…>, 5 years ago

generated first sphinx instance and adapted code doctsrings for automated api generation for disaggregation module as a first test

  • Property mode set to 100644
File size: 13.4 KB
Line 
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7  <meta charset="utf-8">
8 
9  <meta name="viewport" content="width=device-width, initial-scale=1.0">
10 
11  <title>Auto Generated Documentation &mdash; flex_extract 7.1 alpha documentation</title>
12 
13
14 
15 
16 
17 
18
19 
20
21 
22 
23   
24
25 
26
27  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
28  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
29    <link rel="index" title="Index" href="genindex.html" />
30    <link rel="search" title="Search" href="search.html" />
31    <link rel="next" title="Support" href="support.html" />
32    <link rel="prev" title="User Guide" href="user_guide.html" /> 
33
34 
35  <script src="_static/js/modernizr.min.js"></script>
36
37</head>
38
39<body class="wy-body-for-nav">
40
41   
42  <div class="wy-grid-for-nav">
43
44   
45    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
46      <div class="wy-side-scroll">
47        <div class="wy-side-nav-search">
48         
49
50         
51            <a href="index.html" class="icon icon-home"> flex_extract
52         
53
54         
55          </a>
56
57         
58           
59           
60              <div class="version">
61                7.1
62              </div>
63           
64         
65
66         
67<div role="search">
68  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
69    <input type="text" name="q" placeholder="Search docs" />
70    <input type="hidden" name="check_keywords" value="yes" />
71    <input type="hidden" name="area" value="default" />
72  </form>
73</div>
74
75         
76        </div>
77
78        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
79         
80           
81           
82             
83           
84           
85              <p class="caption"><span class="caption-text">Table of Contents:</span></p>
86<ul class="current">
87<li class="toctree-l1"><a class="reference internal" href="downloads.html">Downloads</a></li>
88<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
89<li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li>
90<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
91<li class="toctree-l1 current"><a class="current reference internal" href="#">Auto Generated Documentation</a></li>
92<li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li>
93</ul>
94
95           
96         
97        </div>
98      </div>
99    </nav>
100
101    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
102
103     
104      <nav class="wy-nav-top" aria-label="top navigation">
105       
106          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
107          <a href="index.html">flex_extract</a>
108       
109      </nav>
110
111
112      <div class="wy-nav-content">
113       
114        <div class="rst-content">
115       
116         
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132<div role="navigation" aria-label="breadcrumbs navigation">
133
134  <ul class="wy-breadcrumbs">
135   
136      <li><a href="index.html">Docs</a> &raquo;</li>
137       
138      <li>Auto Generated Documentation</li>
139   
140   
141      <li class="wy-breadcrumbs-aside">
142       
143           
144            <a href="_sources/api.rst.txt" rel="nofollow"> View page source</a>
145         
146       
147      </li>
148   
149  </ul>
150
151 
152  <hr/>
153</div>
154          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
155           <div itemprop="articleBody">
156           
157  <div class="section" id="module-disaggregation">
158<span id="auto-generated-documentation"></span><h1>Auto Generated Documentation<a class="headerlink" href="#module-disaggregation" title="Permalink to this headline"></a></h1>
159<dl class="function">
160<dt id="disaggregation.IA3">
161<code class="descclassname">disaggregation.</code><code class="descname">IA3</code><span class="sig-paren">(</span><em>g</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/disaggregation.html#IA3"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#disaggregation.IA3" title="Permalink to this definition"></a></dt>
162<dd><p>Interpolation with a non-negative geometric mean based algorithm.</p>
163<p>The original grid is reconstructed by adding two sampling points in each
164data series interval. This subgrid is used to keep all information during
165the interpolation within the associated interval. Additionally, an advanced
166monotonicity filter is applied to improve the monotonicity properties of
167the series.</p>
168<div class="admonition note">
169<p class="first admonition-title">Note</p>
170<p>Copyright 2017
171Sabine Hittmeir, Anne Philipp, Petra Seibert</p>
172<p class="last">This work is licensed under the Creative Commons Attribution 4.0
173International License. To view a copy of this license, visit
174<a class="reference external" href="http://creativecommons.org/licenses/by/4.0/">http://creativecommons.org/licenses/by/4.0/</a> or send a letter to
175Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</p>
176</div>
177<table class="docutils field-list" frame="void" rules="none">
178<col class="field-name" />
179<col class="field-body" />
180<tbody valign="top">
181<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>g</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code>) – Complete data series that will be interpolated having
182the dimension of the original raw series.</td>
183</tr>
184<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>f</strong> – The interpolated data series with additional subgrid points.
185Its dimension is equal to the length of the input data series
186times three.</td>
187</tr>
188<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code></td>
189</tr>
190</tbody>
191</table>
192<p class="rubric">References</p>
193<p>For more information see article:
194Hittmeir, S.; Philipp, A.; Seibert, P. (2017): A conservative
195interpolation scheme for extensive quantities with application to the
196Lagrangian particle dispersion model FLEXPART.,
197Geoscientific Model Development</p>
198</dd></dl>
199
200<dl class="function">
201<dt id="disaggregation.dapoly">
202<code class="descclassname">disaggregation.</code><code class="descname">dapoly</code><span class="sig-paren">(</span><em>alist</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/disaggregation.html#dapoly"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#disaggregation.dapoly" title="Permalink to this definition"></a></dt>
203<dd><p>Cubic polynomial interpolation of deaccumulated fluxes.</p>
204<p>Interpolation of deaccumulated fluxes of an ECMWF model FG field
205using a cubic polynomial solution which conserves the integrals
206of the fluxes within each timespan.
207Disaggregation is done for 4 accumluated timespans which
208generates a new, disaggregated value which is output at the
209central point of the 4 accumulation timespans.
210This new point is used for linear interpolation of the complete
211timeseries afterwards.</p>
212<table class="docutils field-list" frame="void" rules="none">
213<col class="field-name" />
214<col class="field-body" />
215<tbody valign="top">
216<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>alist</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code>) – List of 4 timespans as 2-dimensional, horizontal fields.
217E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</td>
218</tr>
219<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>nfield</strong> – Interpolated flux at central point of accumulation timespan.</td>
220</tr>
221<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code></td>
222</tr>
223</tbody>
224</table>
225<div class="admonition note">
226<p class="first admonition-title">Note</p>
227<dl class="last docutils">
228<dt>March 2000 <span class="classifier-delimiter">:</span> <span class="classifier">P. JAMES</span></dt>
229<dd>Original author</dd>
230<dt>June 2003 <span class="classifier-delimiter">:</span> <span class="classifier">A. BECK</span></dt>
231<dd>Adaptations</dd>
232<dt>November 2015 <span class="classifier-delimiter">:</span> <span class="classifier">Leopold Haimberger (University of Vienna)</span></dt>
233<dd>Migration from Fortran to Python</dd>
234</dl>
235</div>
236</dd></dl>
237
238<dl class="function">
239<dt id="disaggregation.darain">
240<code class="descclassname">disaggregation.</code><code class="descname">darain</code><span class="sig-paren">(</span><em>alist</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/disaggregation.html#darain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#disaggregation.darain" title="Permalink to this definition"></a></dt>
241<dd><p>Linear interpolation of deaccumulated fluxes.</p>
242<p>Interpolation of deaccumulated fluxes of an ECMWF model FG rainfall
243field using a modified linear solution which conserves the integrals
244of the fluxes within each timespan.
245Disaggregation is done for 4 accumluated timespans which generates
246a new, disaggregated value which is output at the central point
247of the 4 accumulation timespans. This new point is used for linear
248interpolation of the complete timeseries afterwards.</p>
249<table class="docutils field-list" frame="void" rules="none">
250<col class="field-name" />
251<col class="field-body" />
252<tbody valign="top">
253<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>alist</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code>) – List of 4 timespans as 2-dimensional, horizontal fields.
254E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</td>
255</tr>
256<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>nfield</strong> – Interpolated flux at central point of accumulation timespan.</td>
257</tr>
258<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">array</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">float</span></code></td>
259</tr>
260</tbody>
261</table>
262<div class="admonition note">
263<p class="first admonition-title">Note</p>
264<dl class="last docutils">
265<dt>March 2000 <span class="classifier-delimiter">:</span> <span class="classifier">P. JAMES</span></dt>
266<dd>Original author</dd>
267<dt>June 2003 <span class="classifier-delimiter">:</span> <span class="classifier">A. BECK</span></dt>
268<dd>Adaptations</dd>
269<dt>November 2015 <span class="classifier-delimiter">:</span> <span class="classifier">Leopold Haimberger (University of Vienna)</span></dt>
270<dd>Migration from Fortran to Python</dd>
271</dl>
272</div>
273</dd></dl>
274
275</div>
276
277
278           </div>
279           
280          </div>
281          <footer>
282 
283    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
284     
285        <a href="support.html" class="btn btn-neutral float-right" title="Support" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
286     
287     
288        <a href="user_guide.html" class="btn btn-neutral" title="User Guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
289     
290    </div>
291 
292
293  <hr/>
294
295  <div role="contentinfo">
296    <p>
297        &copy; Copyright 2018, Anne Philipp and Leopold Haimberger.
298
299    </p>
300  </div>
301  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
302
303</footer>
304
305        </div>
306      </div>
307
308    </section>
309
310  </div>
311 
312
313
314 
315
316    <script type="text/javascript">
317        var DOCUMENTATION_OPTIONS = {
318            URL_ROOT:'./',
319            VERSION:'7.1 alpha',
320            LANGUAGE:'None',
321            COLLAPSE_INDEX:false,
322            FILE_SUFFIX:'.html',
323            HAS_SOURCE:  true,
324            SOURCELINK_SUFFIX: '.txt'
325        };
326    </script>
327      <script type="text/javascript" src="_static/jquery.js"></script>
328      <script type="text/javascript" src="_static/underscore.js"></script>
329      <script type="text/javascript" src="_static/doctools.js"></script>
330      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
331
332 
333
334  <script type="text/javascript" src="_static/js/theme.js"></script>
335
336  <script type="text/javascript">
337      jQuery(function () {
338          SphinxRtdTheme.Navigation.enable(true);
339      });
340  </script> 
341
342</body>
343</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG