Skip to content
Snippets Groups Projects
Commit 41c9dbc9 authored by Anne Philipp's avatar Anne Philipp
Browse files

Large update of Sphinx doc; moved Sphinx source to dev dir; Cleaned control files

parent fd6b3ada
No related branches found
No related tags found
No related merge requests found
Expand all Show whitespace changes
Inline Side-by-side
Showing
with 0 additions and 5101 deletions
documentation/Sphinx/build/doctrees/support.doctree deleted 100644 → 0
+ 0
− 0
View file @ fd6b3ada
File deleted
documentation/Sphinx/build/doctrees/support/faq.doctree deleted 100644 → 0
+ 0
− 0
View file @ fd6b3ada
File deleted
documentation/Sphinx/build/doctrees/support/known_bugs_issues.doctree deleted 100644 → 0
+ 0
− 0
View file @ fd6b3ada
File deleted
documentation/Sphinx/build/doctrees/support/mailing_list.doctree deleted 100644 → 0
+ 0
− 0
View file @ fd6b3ada
File deleted
documentation/Sphinx/build/doctrees/support/ticket_system.doctree deleted 100644 → 0
+ 0
− 0
View file @ fd6b3ada
File deleted
documentation/Sphinx/build/doctrees/test_install.doctree deleted 100644 → 0
+ 0
− 0
View file @ fd6b3ada
File deleted
documentation/Sphinx/build/doctrees/usage.doctree deleted 100644 → 0
+ 0
− 0
View file @ fd6b3ada
File deleted
documentation/Sphinx/build/doctrees/user_guide.doctree deleted 100644 → 0
+ 0
− 0
View file @ fd6b3ada
File deleted
documentation/Sphinx/build/doctrees/user_guide/control_templates.doctree deleted 100644 → 0
+ 0
− 0
View file @ fd6b3ada
File deleted
documentation/Sphinx/build/doctrees/user_guide/how_to.doctree deleted 100644 → 0
+ 0
− 0
View file @ fd6b3ada
File deleted
documentation/Sphinx/build/html/.buildinfo deleted 100644 → 0
+ 0
− 4
View file @ fd6b3ada
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 02e87e48403e699e19326e64e41ebe7d
tags: 645f666f9bcd5a90fca523b33c5a78b7
documentation/Sphinx/build/html/.nojekyll deleted 100644 → 0
+ 0
− 0
View file @ fd6b3ada
documentation/Sphinx/build/html/API.html deleted 100644 → 0
+ 0
− 338
View file @ fd6b3ada
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Auto Generated Documentation &mdash; flex_extract 7.1 alpha documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Usage" href="usage.html" />
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> flex_extract
</a>
<div class="version">
7.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="requirements.html">Requirements</a></li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Auto Generated Documentation</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">flex_extract</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li>Auto Generated Documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/API.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-disaggregation">
<span id="auto-generated-documentation"></span><h1>Auto Generated Documentation<a class="headerlink" href="#module-disaggregation" title="Permalink to this headline"></a></h1>
<dl class="function">
<dt id="disaggregation.IA3">
<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>
<dd><p>Interpolation with a non-negative geometric mean based algorithm.</p>
<p>The original grid is reconstructed by adding two sampling points in each
data series interval. This subgrid is used to keep all information during
the interpolation within the associated interval. Additionally, an advanced
monotonicity filter is applied to improve the monotonicity properties of
the series.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Copyright 2017
Sabine Hittmeir, Anne Philipp, Petra Seibert</p>
<p class="last">This work is licensed under the Creative Commons Attribution 4.0
International License. To view a copy of this license, visit
<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
Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</p>
</div>
<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"><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
the dimension of the original raw series.</td>
</tr>
<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.
Its dimension is equal to the length of the input data series
times three.</td>
</tr>
<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>
</tr>
</tbody>
</table>
<p class="rubric">References</p>
<p>For more information see article:
Hittmeir, S.; Philipp, A.; Seibert, P. (2017): A conservative
interpolation scheme for extensive quantities with application to the
Lagrangian particle dispersion model FLEXPART.,
Geoscientific Model Development</p>
</dd></dl>
<dl class="function">
<dt id="disaggregation.dapoly">
<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>
<dd><p>Cubic polynomial interpolation of deaccumulated fluxes.</p>
<p>Interpolation of deaccumulated fluxes of an ECMWF model FG field
using a cubic polynomial solution which conserves the integrals
of the fluxes within each timespan.
Disaggregation is done for 4 accumluated timespans which
generates a new, disaggregated value which is output at the
central point of the 4 accumulation timespans.
This new point is used for linear interpolation of the complete
timeseries afterwards.</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"><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.
E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</td>
</tr>
<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>
</tr>
<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>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<dl class="last docutils">
<dt>March 2000 <span class="classifier-delimiter">:</span> <span class="classifier">P. JAMES</span></dt>
<dd>Original author</dd>
<dt>June 2003 <span class="classifier-delimiter">:</span> <span class="classifier">A. BECK</span></dt>
<dd>Adaptations</dd>
<dt>November 2015 <span class="classifier-delimiter">:</span> <span class="classifier">Leopold Haimberger (University of Vienna)</span></dt>
<dd>Migration from Fortran to Python</dd>
</dl>
</div>
</dd></dl>
<dl class="function">
<dt id="disaggregation.darain">
<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>
<dd><p>Linear interpolation of deaccumulated fluxes.</p>
<p>Interpolation of deaccumulated fluxes of an ECMWF model FG rainfall
field using a modified linear solution which conserves the integrals
of the fluxes within each timespan.
Disaggregation is done for 4 accumluated timespans which generates
a new, disaggregated value which is output at the central point
of the 4 accumulation timespans. This new point is used for linear
interpolation of the complete timeseries afterwards.</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"><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.
E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</td>
</tr>
<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>
</tr>
<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>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<dl class="last docutils">
<dt>March 2000 <span class="classifier-delimiter">:</span> <span class="classifier">P. JAMES</span></dt>
<dd>Original author</dd>
<dt>June 2003 <span class="classifier-delimiter">:</span> <span class="classifier">A. BECK</span></dt>
<dd>Adaptations</dd>
<dt>November 2015 <span class="classifier-delimiter">:</span> <span class="classifier">Leopold Haimberger (University of Vienna)</span></dt>
<dd>Migration from Fortran to Python</dd>
</dl>
</div>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="usage.html" class="btn btn-neutral" title="Usage" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2018, Anne Philipp and Leopold Haimberger.
</p>
</div>
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>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'7.1 alpha',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
\ No newline at end of file
documentation/Sphinx/build/html/_images/inheritance-e240fdbef8779575a57ef8d838f383167120d053.png.map deleted 100644 → 0
+ 0
− 3
View file @ fd6b3ada
<map id="inheritance733d130bee" name="inheritance733d130bee">
<area shape="rect" id="node1" title="Class to retrieve FLEXPART specific ECMWF data." alt="" coords="7,5,177,33"/>
</map>
documentation/Sphinx/build/html/_modules/ControlFile.html deleted 100644 → 0
+ 0
− 910
View file @ fd6b3ada
This diff is collapsed.
documentation/Sphinx/build/html/_modules/EcFlexpart.html deleted 100644 → 0
+ 0
− 2031
View file @ fd6b3ada
Source diff could not be displayed: it is too large. Options to address this: view the blob.
documentation/Sphinx/build/html/_modules/GribTools.html deleted 100644 → 0
+ 0
− 535
View file @ fd6b3ada
This diff is collapsed.
documentation/Sphinx/build/html/_modules/GribUtil.html deleted 100644 → 0
+ 0
− 537
View file @ fd6b3ada
This diff is collapsed.
documentation/Sphinx/build/html/_modules/MarsRetrieval.html deleted 100644 → 0
+ 0
− 743
View file @ fd6b3ada
This diff is collapsed.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment