source: flex_extract.git/documentation/Sphinx/build/html/code.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: 12.5 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9    <title>Auto Generated Documentation &#8212; flex_extract 7.1 alpha documentation</title>
10    <link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
11    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
12    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
13    <script type="text/javascript" src="_static/jquery.js"></script>
14    <script type="text/javascript" src="_static/underscore.js"></script>
15    <script type="text/javascript" src="_static/doctools.js"></script>
16    <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
17    <link rel="index" title="Index" href="genindex.html" />
18    <link rel="search" title="Search" href="search.html" />
19    <link rel="next" title="Requirements" href="requirements.html" />
20    <link rel="prev" title="Welcome to flex_extract’s documentation!" href="index.html" /> 
21  </head><body>
22    <div class="related" role="navigation" aria-label="related navigation">
23      <h3>Navigation</h3>
24      <ul>
25        <li class="right" style="margin-right: 10px">
26          <a href="genindex.html" title="General Index"
27             accesskey="I">index</a></li>
28        <li class="right" >
29          <a href="py-modindex.html" title="Python Module Index"
30             >modules</a> |</li>
31        <li class="right" >
32          <a href="requirements.html" title="Requirements"
33             accesskey="N">next</a> |</li>
34        <li class="right" >
35          <a href="index.html" title="Welcome to flex_extract’s documentation!"
36             accesskey="P">previous</a> |</li>
37        <li class="nav-item nav-item-0"><a href="index.html">flex_extract 7.1 alpha documentation</a> &#187;</li> 
38      </ul>
39    </div>
40      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
41        <div class="sphinxsidebarwrapper">
42  <h4>Previous topic</h4>
43  <p class="topless"><a href="index.html"
44                        title="previous chapter">Welcome to flex_extract’s documentation!</a></p>
45  <h4>Next topic</h4>
46  <p class="topless"><a href="requirements.html"
47                        title="next chapter">Requirements</a></p>
48  <div role="note" aria-label="source link">
49    <h3>This Page</h3>
50    <ul class="this-page-menu">
51      <li><a href="_sources/code.rst.txt"
52            rel="nofollow">Show Source</a></li>
53    </ul>
54   </div>
55<div id="searchbox" style="display: none" role="search">
56  <h3>Quick search</h3>
57    <div class="searchformwrapper">
58    <form class="search" action="search.html" method="get">
59      <input type="text" name="q" />
60      <input type="submit" value="Go" />
61      <input type="hidden" name="check_keywords" value="yes" />
62      <input type="hidden" name="area" value="default" />
63    </form>
64    </div>
65</div>
66<script type="text/javascript">$('#searchbox').show(0);</script>
67        </div>
68      </div>
69
70    <div class="document">
71      <div class="documentwrapper">
72        <div class="bodywrapper">
73          <div class="body" role="main">
74           
75  <div class="section" id="module-disaggregation">
76<span id="auto-generated-documentation"></span><h1>Auto Generated Documentation<a class="headerlink" href="#module-disaggregation" title="Permalink to this headline"></a></h1>
77<dl class="function">
78<dt id="disaggregation.IA3">
79<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>
80<dd><p>Interpolation with a non-negative geometric mean based algorithm.</p>
81<p>The original grid is reconstructed by adding two sampling points in each
82data series interval. This subgrid is used to keep all information during
83the interpolation within the associated interval. Additionally, an advanced
84monotonicity filter is applied to improve the monotonicity properties of
85the series.</p>
86<div class="admonition note">
87<p class="first admonition-title">Note</p>
88<p>Copyright 2017
89Sabine Hittmeir, Anne Philipp, Petra Seibert</p>
90<p class="last">This work is licensed under the Creative Commons Attribution 4.0
91International License. To view a copy of this license, visit
92<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
93Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</p>
94</div>
95<table class="docutils field-list" frame="void" rules="none">
96<col class="field-name" />
97<col class="field-body" />
98<tbody valign="top">
99<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
100the dimension of the original raw series.</td>
101</tr>
102<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.
103Its dimension is equal to the length of the input data series
104times three.</td>
105</tr>
106<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>
107</tr>
108</tbody>
109</table>
110<p class="rubric">References</p>
111<p>For more information see article:
112Hittmeir, S.; Philipp, A.; Seibert, P. (2017): A conservative
113interpolation scheme for extensive quantities with application to the
114Lagrangian particle dispersion model FLEXPART.,
115Geoscientific Model Development</p>
116</dd></dl>
117
118<dl class="function">
119<dt id="disaggregation.dapoly">
120<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>
121<dd><p>Cubic polynomial interpolation of deaccumulated fluxes.</p>
122<p>Interpolation of deaccumulated fluxes of an ECMWF model FG field
123using a cubic polynomial solution which conserves the integrals
124of the fluxes within each timespan.
125Disaggregation is done for 4 accumluated timespans which
126generates a new, disaggregated value which is output at the
127central point of the 4 accumulation timespans.
128This new point is used for linear interpolation of the complete
129timeseries afterwards.</p>
130<table class="docutils field-list" frame="void" rules="none">
131<col class="field-name" />
132<col class="field-body" />
133<tbody valign="top">
134<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.
135E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</td>
136</tr>
137<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>
138</tr>
139<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>
140</tr>
141</tbody>
142</table>
143<div class="admonition note">
144<p class="first admonition-title">Note</p>
145<dl class="last docutils">
146<dt>March 2000 <span class="classifier-delimiter">:</span> <span class="classifier">P. JAMES</span></dt>
147<dd>Original author</dd>
148<dt>June 2003 <span class="classifier-delimiter">:</span> <span class="classifier">A. BECK</span></dt>
149<dd>Adaptations</dd>
150<dt>November 2015 <span class="classifier-delimiter">:</span> <span class="classifier">Leopold Haimberger (University of Vienna)</span></dt>
151<dd>Migration from Fortran to Python</dd>
152</dl>
153</div>
154</dd></dl>
155
156<dl class="function">
157<dt id="disaggregation.darain">
158<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>
159<dd><p>Linear interpolation of deaccumulated fluxes.</p>
160<p>Interpolation of deaccumulated fluxes of an ECMWF model FG rainfall
161field using a modified linear solution which conserves the integrals
162of the fluxes within each timespan.
163Disaggregation is done for 4 accumluated timespans which generates
164a new, disaggregated value which is output at the central point
165of the 4 accumulation timespans. This new point is used for linear
166interpolation of the complete timeseries afterwards.</p>
167<table class="docutils field-list" frame="void" rules="none">
168<col class="field-name" />
169<col class="field-body" />
170<tbody valign="top">
171<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.
172E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</td>
173</tr>
174<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>
175</tr>
176<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>
177</tr>
178</tbody>
179</table>
180<div class="admonition note">
181<p class="first admonition-title">Note</p>
182<dl class="last docutils">
183<dt>March 2000 <span class="classifier-delimiter">:</span> <span class="classifier">P. JAMES</span></dt>
184<dd>Original author</dd>
185<dt>June 2003 <span class="classifier-delimiter">:</span> <span class="classifier">A. BECK</span></dt>
186<dd>Adaptations</dd>
187<dt>November 2015 <span class="classifier-delimiter">:</span> <span class="classifier">Leopold Haimberger (University of Vienna)</span></dt>
188<dd>Migration from Fortran to Python</dd>
189</dl>
190</div>
191</dd></dl>
192
193</div>
194
195
196          </div>
197        </div>
198      </div>
199      <div class="clearer"></div>
200    </div>
201    <div class="related" role="navigation" aria-label="related navigation">
202      <h3>Navigation</h3>
203      <ul>
204        <li class="right" style="margin-right: 10px">
205          <a href="genindex.html" title="General Index"
206             >index</a></li>
207        <li class="right" >
208          <a href="py-modindex.html" title="Python Module Index"
209             >modules</a> |</li>
210        <li class="right" >
211          <a href="requirements.html" title="Requirements"
212             >next</a> |</li>
213        <li class="right" >
214          <a href="index.html" title="Welcome to flex_extract’s documentation!"
215             >previous</a> |</li>
216        <li class="nav-item nav-item-0"><a href="index.html">flex_extract 7.1 alpha documentation</a> &#187;</li> 
217      </ul>
218    </div>
219    <div class="footer" role="contentinfo">
220        &#169; Copyright 2018, Anne Philipp and Leopold Haimberger.
221      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.9.
222    </div>
223  </body>
224</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG