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