Changeset eca358d in flex_extract.git for Documentation/html/Documentation/Api/api_python.html

Timestamp:

Feb 1, 2020, 9:32:17 PM (4 years ago)

Author:

Anne Philipp <anne.philipp@…>

Branches:

master, ctbto, dev

Children:

072cbea

Parents:

53d3b2a

Message:

updated online documentation with links on index page

File:

• Documentation/html/Documentation/Api/api_python.html (modified) (35 diffs)

Documentation/html/Documentation/Api/api_python.html

@@ -189 +189 @@
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#programs" id="id1">Programs</a><ul>
-<li><a class="reference internal" href="#module-install" id="id2">install</a></li>
-<li><a class="reference internal" href="#module-submit" id="id3">submit</a></li>
+<li><a class="reference internal" href="#programs" id="id3">Programs</a><ul>
+<li><a class="reference internal" href="#module-install" id="id4">install</a></li>
+<li><a class="reference internal" href="#module-submit" id="id5">submit</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#classes" id="id4">Classes</a><ul>
-<li><a class="reference internal" href="#module-ControlFile" id="id5">ControlFile</a></li>
-<li><a class="reference internal" href="#module-EcFlexpart" id="id6">EcFlexpart</a></li>
-<li><a class="reference internal" href="#module-GribUtil" id="id7">GribUtil</a></li>
-<li><a class="reference internal" href="#module-MarsRetrieval" id="id8">MarsRetrieval</a></li>
-<li><a class="reference internal" href="#module-UioFiles" id="id9">UioFiles</a></li>
+<li><a class="reference internal" href="#classes" id="id6">Classes</a><ul>
+<li><a class="reference internal" href="#module-ControlFile" id="id7">ControlFile</a></li>
+<li><a class="reference internal" href="#module-EcFlexpart" id="id8">EcFlexpart</a></li>
+<li><a class="reference internal" href="#module-GribUtil" id="id9">GribUtil</a></li>
+<li><a class="reference internal" href="#module-MarsRetrieval" id="id10">MarsRetrieval</a></li>
+<li><a class="reference internal" href="#module-UioFiles" id="id11">UioFiles</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#modules" id="id10">Modules</a><ul>
-<li><a class="reference internal" href="#module-get_mars_data" id="id11">get_mars_data</a></li>
-<li><a class="reference internal" href="#module-prepare_flexpart" id="id12">prepare_flexpart</a></li>
-<li><a class="reference internal" href="#module-tools" id="id13">tools</a></li>
-<li><a class="reference internal" href="#module-checks" id="id14">checks</a></li>
-<li><a class="reference internal" href="#module-disaggregation" id="id15">disaggregation</a></li>
+<li><a class="reference internal" href="#modules" id="id12">Modules</a><ul>
+<li><a class="reference internal" href="#module-get_mars_data" id="id13">get_mars_data</a></li>
+<li><a class="reference internal" href="#module-prepare_flexpart" id="id14">prepare_flexpart</a></li>
+<li><a class="reference internal" href="#module-tools" id="id15">tools</a></li>
+<li><a class="reference internal" href="#module-checks" id="id16">checks</a></li>
+<li><a class="reference internal" href="#module-disaggregation" id="id17">disaggregation</a></li>
 </ul>
 </li>
@@ -213 +213 @@
 </div>
 <div class="section" id="programs">
-<h2><a class="toc-backref" href="#id1">Programs</a><a class="headerlink" href="#programs" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id3">Programs</a><a class="headerlink" href="#programs" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="module-install">
-<span id="install"></span><h3><a class="toc-backref" href="#id2">install</a><a class="headerlink" href="#module-install" title="Permalink to this headline">¶</a></h3>
+<span id="install"></span><h3><a class="toc-backref" href="#id4">install</a><a class="headerlink" href="#module-install" title="Permalink to this headline">¶</a></h3>
 <p>This script installs the flex_extract program.</p>
 <p>Depending on the selected installation environment (locally or on the
@@ -319 +319 @@
 <dl class="function">
 <dt id="install.mk_compilejob">
-<code class="descclassname">install.</code><code class="descname">mk_compilejob</code><span class="sig-paren">(</span><em>makefile</em>, <em>target</em>, <em>ecuid</em>, <em>ecgid</em>, <em>fp_root</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#mk_compilejob"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_compilejob" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">install.</code><code class="descname">mk_compilejob</code><span class="sig-paren">(</span><em>makefile</em>, <em>ecuid</em>, <em>ecgid</em>, <em>fp_root</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#mk_compilejob"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_compilejob" title="Permalink to this definition">¶</a></dt>
 <dd><p>Modifies the original job template file so that it is specified
 for the user and the environment were it will be applied. Result
@@ -330 +330 @@
 <li><strong>makefile</strong> (<em>str</em>) – Name of the makefile which should be used to compile FORTRAN
 CONVERT2 program.</li>
-<li><strong>target</strong> (<em>str</em>) – The target where the installation should be done, e.g. the queue.</li>
 <li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li>
 <li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li>
@@ -385 +384 @@
 <dl class="function">
 <dt id="install.mk_job_template">
-<code class="descclassname">install.</code><code class="descname">mk_job_template</code><span class="sig-paren">(</span><em>ecuid</em>, <em>ecgid</em>, <em>gateway</em>, <em>destination</em>, <em>fp_root</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#mk_job_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_job_template" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">install.</code><code class="descname">mk_job_template</code><span class="sig-paren">(</span><em>ecuid</em>, <em>ecgid</em>, <em>fp_root</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#mk_job_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_job_template" title="Permalink to this definition">¶</a></dt>
 <dd><p>Modifies the original job template file so that it is specified
 for the user and the environment were it will be applied. Result
@@ -396 +395 @@
 <li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li>
 <li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li>
-<li><strong>gateway</strong> (<em>str</em>) – The gateway server the user is using.</li>
-<li><strong>destination</strong> (<em>str</em>) – The remote destination which is used to transfer files
-from ECMWF server to local gateway server.</li>
 <li><strong>fp_root</strong> (<em>str</em>) – Path to the root directory of FLEXPART environment or flex_extract
 environment.</li>
@@ -449 +445 @@
 </div>
 <div class="section" id="module-submit">
-<span id="submit"></span><h3><a class="toc-backref" href="#id3">submit</a><a class="headerlink" href="#module-submit" title="Permalink to this headline">¶</a></h3>
+<span id="submit"></span><h3><a class="toc-backref" href="#id5">submit</a><a class="headerlink" href="#module-submit" title="Permalink to this headline">¶</a></h3>
 <p>This script allows the user to extract meteorological fields from the ECMWF.</p>
 <p>It prepares the settings for retrieving the data from ECMWF servers and
@@ -530 +526 @@
 </div>
 <div class="section" id="classes">
-<h2><a class="toc-backref" href="#id4">Classes</a><a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id6">Classes</a><a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="module-ControlFile">
-<span id="controlfile"></span><h3><a class="toc-backref" href="#id5">ControlFile</a><a class="headerlink" href="#module-ControlFile" title="Permalink to this headline">¶</a></h3>
+<span id="controlfile"></span><h3><a class="toc-backref" href="#id7">ControlFile</a><a class="headerlink" href="#module-ControlFile" title="Permalink to this headline">¶</a></h3>
 <dl class="class">
 <dt id="ControlFile.ControlFile">
@@ -541 +537 @@
 from the MARS archive for driving FLEXPART are set in a CONTROL file.
 Some specific parameters like the start and end dates can be overwritten
-by the command line parameters, but in generel all parameters needed
+by the command line parameters, but in generall all parameters needed
 for a complete set of fields for FLEXPART can be set in the CONTROL file.</p>
 <dl class="attribute">
@@ -1207 +1203 @@
 
 <dl class="attribute">
-<dt id="ControlFile.ControlFile.grib2flexpart">
-<code class="descname">grib2flexpart</code><a class="headerlink" href="#ControlFile.ControlFile.grib2flexpart" title="Permalink to this definition">¶</a></dt>
-<dd><p>Switch to select generation of preprocessed FLEXPART files “.fp”.
-If it is selected, the program grib2flexpart will try
-to convert the flex_extract output files into “.fp” format.</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">Type:</th><td class="field-body">int 0</td>
-</tr>
-</tbody>
-</table>
-</dd></dl>
-
-<dl class="attribute">
 <dt id="ControlFile.ControlFile.ecstorage">
 <code class="descname">ecstorage</code><a class="headerlink" href="#ControlFile.ControlFile.ecstorage" title="Permalink to this definition">¶</a></dt>
@@ -1557 +1537 @@
 <dd><p>List of the names of logical switches which controls the flow
 of the program. Default list is [‘gauss’, ‘omega’, ‘omegadiff’, ‘eta’,
-‘etadiff’, ‘dpdeta’, ‘cwc’, ‘wrf’, ‘grib2flexpart’, ‘ecstorage’,
+‘etadiff’, ‘dpdeta’, ‘cwc’, ‘wrf’, ‘ecstorage’,
 ‘ectrans’, ‘debug’, ‘request’, ‘public’, ‘purefc’, ‘rrint’, ‘doubleelda’]</p>
 <table class="docutils field-list" frame="void" rules="none">
@@ -1642 +1622 @@
 </div>
 <div class="section" id="module-EcFlexpart">
-<span id="ecflexpart"></span><h3><a class="toc-backref" href="#id6">EcFlexpart</a><a class="headerlink" href="#module-EcFlexpart" title="Permalink to this headline">¶</a></h3>
+<span id="ecflexpart"></span><h3><a class="toc-backref" href="#id8">EcFlexpart</a><a class="headerlink" href="#module-EcFlexpart" title="Permalink to this headline">¶</a></h3>
 <dl class="class">
 <dt id="EcFlexpart.EcFlexpart">
@@ -2211 +2191 @@
 </div>
 <div class="section" id="module-GribUtil">
-<span id="gributil"></span><h3><a class="toc-backref" href="#id7">GribUtil</a><a class="headerlink" href="#module-GribUtil" title="Permalink to this headline">¶</a></h3>
+<span id="gributil"></span><h3><a class="toc-backref" href="#id9">GribUtil</a><a class="headerlink" href="#module-GribUtil" title="Permalink to this headline">¶</a></h3>
 <dl class="class">
 <dt id="GribUtil.GribUtil">
@@ -2226 +2206 @@
 <dl class="method">
 <dt id="GribUtil.GribUtil.copy_dummy_msg">
-<code class="descname">copy_dummy_msg</code><span class="sig-paren">(</span><em>filename_in</em>, <em>selectWhere=True</em>, <em>keynames=[]</em>, <em>keyvalues=[]</em>, <em>filemode='wb'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/GribUtil.html#GribUtil.copy_dummy_msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.copy_dummy_msg" title="Permalink to this definition">¶</a></dt>
+<code class="descname">copy_dummy_msg</code><span class="sig-paren">(</span><em>filename_in</em>, <em>keynames</em>, <em>keyvalues</em>, <em>selectwhere=True</em>, <em>filemode='wb'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/GribUtil.html#GribUtil.copy_dummy_msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.copy_dummy_msg" title="Permalink to this definition">¶</a></dt>
 <dd><p>Add the content of another input grib file to the objects file but
 only messages corresponding to keys/values passed to the function.
@@ -2237 +2217 @@
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 <li><strong>filename_in</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Filename of the input file to read the grib messages from.</li>
-<li><strong>selectWhere</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">boolean</span></code>, optional) – Decides if to copy the keynames and values equal to (True) or
+<li><strong>selectwhere</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">boolean</span></code>, optional) – Decides if to copy the keynames and values equal to (True) or
 different to (False) the keynames/keyvalues list passed to the
 function. Default is True.</li>
-<li><strong>keynames</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">string</span></code>, optional) – List of keynames. Default is an empty list.</li>
-<li><strong>keyvalues</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">string</span></code>, optional) – List of keyvalues. Default is an empty list.</li>
+<li><strong>keynames</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">string</span></code>) – List of keynames.</li>
+<li><strong>keyvalues</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">string</span></code>) – List of keyvalues.</li>
 <li><strong>filemode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Sets the mode for the output file. Default is “wb”.</li>
 </ul>
@@ -2252 +2232 @@
 <dl class="method">
 <dt id="GribUtil.GribUtil.get_keys">
-<code class="descname">get_keys</code><span class="sig-paren">(</span><em>keynames</em>, <em>wherekeynames=[]</em>, <em>wherekeyvalues=[]</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/GribUtil.html#GribUtil.get_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.get_keys" title="Permalink to this definition">¶</a></dt>
+<code class="descname">get_keys</code><span class="sig-paren">(</span><em>keynames</em>, <em>wherekeynames</em>, <em>wherekeyvalues</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/GribUtil.html#GribUtil.get_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.get_keys" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get keyvalues for a given list of keynames a where statement
 can be given (list of key and list of values)</p>
@@ -2261 +2241 @@
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
 <li><strong>keynames</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">string</span></code>) – List of keynames.</li>
-<li><strong>wherekeynames</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">string</span></code>, optional) – Default value is an empty list.</li>
-<li><strong>wherekeyvalues</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">string</span></code>, optional) – Default value is an empty list.</li>
+<li><strong>wherekeynames</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">string</span></code>) – List of key names for indexing grib message parameter.</li>
+<li><strong>wherekeyvalues</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">string</span></code>) – List of key values corresponding the key names.</li>
 </ul>
 </td>
@@ -2278 +2258 @@
 <dl class="method">
 <dt id="GribUtil.GribUtil.index">
-<code class="descname">index</code><span class="sig-paren">(</span><em>index_keys=['mars'], index_file='my.idx'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/GribUtil.html#GribUtil.index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.index" title="Permalink to this definition">¶</a></dt>
+<code class="descname">index</code><span class="sig-paren">(</span><em>index_keys</em>, <em>index_file='my.idx'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/GribUtil.html#GribUtil.index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.index" title="Permalink to this definition">¶</a></dt>
 <dd><p>Create index file from a list of files if it does not exist or
 read an index file.</p>
@@ -2286 +2266 @@
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>index_keys</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">string</span></code>, optional) – Contains the list of key parameter names from
-which the index is to be created.
-Default is a list with a single entry string “mars”.</li>
+<li><strong>index_keys</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">string</span></code>) – Contains the list of key parameter names from
+which the index is to be created.</li>
 <li><strong>index_file</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Filename where the indices are stored.
 Default is “my.idx”.</li>
@@ -2306 +2285 @@
 <dl class="method">
 <dt id="GribUtil.GribUtil.set_keys">
-<code class="descname">set_keys</code><span class="sig-paren">(</span><em>fromfile</em>, <em>keynames</em>, <em>keyvalues</em>, <em>wherekeynames=[]</em>, <em>wherekeyvalues=[]</em>, <em>strict=False</em>, <em>filemode='wb'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/GribUtil.html#GribUtil.set_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.set_keys" title="Permalink to this definition">¶</a></dt>
+<code class="descname">set_keys</code><span class="sig-paren">(</span><em>fromfile</em>, <em>keynames</em>, <em>keyvalues</em>, <em>wherekeynames</em>, <em>wherekeyvalues</em>, <em>filemode='wb'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/GribUtil.html#GribUtil.set_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.set_keys" title="Permalink to this definition">¶</a></dt>
 <dd><p>Opens the file to read the grib messages and then write
 the selected messages (with wherekeys) to a new output file.
@@ -2320 +2299 @@
 <li><strong>keyvalues</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">string</span></code>) – List of keyvalues to set in the selected messages.
 Default is an empty list.</li>
-<li><strong>wherekeynames</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">string</span></code>, optional) – List of keynames to select correct message.
-Default value is an empty list.</li>
-<li><strong>wherekeyvalues</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">string</span></code>, optional) – List of keyvalues for keynames to select correct message.
-Default value is an empty list.</li>
-<li><strong>strict</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">boolean</span></code>, optional) – Decides if everything from keynames and keyvalues
-is written out the grib file (False) or only those
-meeting the where statement (True). Default is False.</li>
+<li><strong>wherekeynames</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">string</span></code>) – List of keynames to select correct message.</li>
+<li><strong>wherekeyvalues</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">string</span></code>) – List of keyvalues for keynames to select correct message.</li>
 <li><strong>filemode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Sets the mode for the output file. Default is “wb”.</li>
 </ul>
@@ -2339 +2313 @@
 </div>
 <div class="section" id="module-MarsRetrieval">
-<span id="marsretrieval"></span><h3><a class="toc-backref" href="#id8">MarsRetrieval</a><a class="headerlink" href="#module-MarsRetrieval" title="Permalink to this headline">¶</a></h3>
+<span id="marsretrieval"></span><h3><a class="toc-backref" href="#id10">MarsRetrieval</a><a class="headerlink" href="#module-MarsRetrieval" title="Permalink to this headline">¶</a></h3>
 <dl class="class">
 <dt id="MarsRetrieval.MarsRetrieval">
@@ -2692 +2666 @@
 </div>
 <div class="section" id="module-UioFiles">
-<span id="uiofiles"></span><h3><a class="toc-backref" href="#id9">UioFiles</a><a class="headerlink" href="#module-UioFiles" title="Permalink to this headline">¶</a></h3>
+<span id="uiofiles"></span><h3><a class="toc-backref" href="#id11">UioFiles</a><a class="headerlink" href="#module-UioFiles" title="Permalink to this headline">¶</a></h3>
 <dl class="class">
 <dt id="UioFiles.UioFiles">
@@ -2717 +2691 @@
 <dt id="UioFiles.UioFiles.pattern">
 <code class="descname">pattern</code><a class="headerlink" href="#UioFiles.UioFiles.pattern" title="Permalink to this definition">¶</a></dt>
-<dd><p>Regular expression pattern. For example: ‘*.grb’</p>
+<dd><p>Regular expression pattern. For example: ‘<a href="#id1"><span class="problematic" id="id2">*</span></a>.grb’</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -2753 +2727 @@
 </div>
 <div class="section" id="modules">
-<h2><a class="toc-backref" href="#id10">Modules</a><a class="headerlink" href="#modules" title="Permalink to this headline">¶</a></h2>
+<h2><a class="toc-backref" href="#id12">Modules</a><a class="headerlink" href="#modules" title="Permalink to this headline">¶</a></h2>
 <div class="section" id="module-get_mars_data">
-<span id="get-mars-data"></span><h3><a class="toc-backref" href="#id11">get_mars_data</a><a class="headerlink" href="#module-get_mars_data" title="Permalink to this headline">¶</a></h3>
+<span id="get-mars-data"></span><h3><a class="toc-backref" href="#id13">get_mars_data</a><a class="headerlink" href="#module-get_mars_data" title="Permalink to this headline">¶</a></h3>
 <p>This script extracts MARS data from ECMWF servers.</p>
 <p>At first, the necessary parameters from command line and CONTROL files are
@@ -2778 +2752 @@
 <dt id="get_mars_data.check_dates_for_nonflux_fc_times">
 <code class="descclassname">get_mars_data.</code><code class="descname">check_dates_for_nonflux_fc_times</code><span class="sig-paren">(</span><em>types</em>, <em>times</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/get_mars_data.html#check_dates_for_nonflux_fc_times"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.check_dates_for_nonflux_fc_times" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
+<dd><p>Checks if the time 18UTC corresponds to forecast field.</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"><ul class="first simple">
+<li><strong>types</strong> (<em>list of str</em>) – List of field types.</li>
+<li><strong>times</strong> (<em>list of str</em><em> or </em><em>str</em>) – The time in hours of the field.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"></p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">True or False</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
 
 <dl class="function">
@@ -2846 +2839 @@
 boundary conditions)</p>
 <p>Since for basetime the extraction contains the 12 hours upfront,
-if basetime is 0, the starting date has to be the day before and</p>
+if basetime is 0, the starting date has to be the day before</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
@@ -2929 +2922 @@
 </div>
 <div class="section" id="module-prepare_flexpart">
-<span id="prepare-flexpart"></span><h3><a class="toc-backref" href="#id12">prepare_flexpart</a><a class="headerlink" href="#module-prepare_flexpart" title="Permalink to this headline">¶</a></h3>
+<span id="prepare-flexpart"></span><h3><a class="toc-backref" href="#id14">prepare_flexpart</a><a class="headerlink" href="#module-prepare_flexpart" title="Permalink to this headline">¶</a></h3>
 <p>This script prepares the final version of the grib files which are
 then used by FLEXPART.</p>
@@ -2982 +2975 @@
 </div>
 <div class="section" id="module-tools">
-<span id="tools"></span><h3><a class="toc-backref" href="#id13">tools</a><a class="headerlink" href="#module-tools" title="Permalink to this headline">¶</a></h3>
+<span id="tools"></span><h3><a class="toc-backref" href="#id15">tools</a><a class="headerlink" href="#module-tools" title="Permalink to this headline">¶</a></h3>
 <p>This module contains a collection of diverse tasks within flex_extract.</p>
 <dl class="function">
@@ -3491 +3484 @@
 </div>
 <div class="section" id="module-checks">
-<span id="checks"></span><h3><a class="toc-backref" href="#id14">checks</a><a class="headerlink" href="#module-checks" title="Permalink to this headline">¶</a></h3>
+<span id="checks"></span><h3><a class="toc-backref" href="#id16">checks</a><a class="headerlink" href="#module-checks" title="Permalink to this headline">¶</a></h3>
 <p>This module contains check methods for the CONTROL paramaters.</p>
 <dl class="function">
@@ -3846 +3839 @@
 <dl class="function">
 <dt id="checks.check_number">
-<code class="descclassname">checks.</code><code class="descname">check_number</code><span class="sig-paren">(</span><em>number</em>, <em>mailfail</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_number"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_number" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">checks.</code><code class="descname">check_number</code><span class="sig-paren">(</span><em>number</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_number"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_number" title="Permalink to this definition">¶</a></dt>
 <dd><p>Check for correct string format of ensemble member numbers.</p>
 <table class="docutils field-list" frame="void" rules="none">
@@ -3852 +3845 @@
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>number</strong> (<em>str</em>) – List of ensemble member forecast runs.</li>
-<li><strong>mailfail</strong> (<em>list of str</em>) – Contains all email addresses which should be notified.
-It might also contain just the ecmwf user name which will trigger
-mailing to the associated email address for this user.</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>number</strong> – String with list of ensemble member forecast runs. E.g. ‘01/02/03/04’</p>
-</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
-</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>number</strong> (<em>str</em>) – List of ensemble member forecast runs.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>number</strong> – String with list of ensemble member forecast runs. E.g. ‘01/02/03/04’</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>
 </tr>
 </tbody>
@@ -4005 +3990 @@
 <dl class="function">
 <dt id="checks.check_step">
-<code class="descclassname">checks.</code><code class="descname">check_step</code><span class="sig-paren">(</span><em>step</em>, <em>mailfail</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_step"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_step" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">checks.</code><code class="descname">check_step</code><span class="sig-paren">(</span><em>step</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_step"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_step" title="Permalink to this definition">¶</a></dt>
 <dd><p>Checks on step format and convert into a list of steps.</p>
 <p>If the steps were defined with “to” and “by” they are converted into
@@ -4014 +3999 @@
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>step</strong> (<em>list of str</em><em> or </em><em>str</em>) – Specifies the forecast time step from forecast base time.
-Valid values are hours (HH) from forecast base time.</li>
-<li><strong>mailfail</strong> (<em>list of str</em>) – Contains all email addresses which should be notified.
-It might also contain just the ecmwf user name which will trigger
-mailing to the associated email address for this user.</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>step</strong> – List of forecast steps in format e.g. [001, 002, …]</p>
-</td>
-</tr>
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of str</p>
-</td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>step</strong> (<em>list of str</em><em> or </em><em>str</em>) – Specifies the forecast time step from forecast base time.
+Valid values are hours (HH) from forecast base time.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>step</strong> – List of forecast steps in format e.g. [001, 002, …]</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list of str</td>
 </tr>
 </tbody>
@@ -4079 +4056 @@
 </div>
 <div class="section" id="module-disaggregation">
-<span id="disaggregation"></span><h3><a class="toc-backref" href="#id15">disaggregation</a><a class="headerlink" href="#module-disaggregation" title="Permalink to this headline">¶</a></h3>
+<span id="disaggregation"></span><h3><a class="toc-backref" href="#id17">disaggregation</a><a class="headerlink" href="#module-disaggregation" title="Permalink to this headline">¶</a></h3>
 <p>Disaggregation of deaccumulated flux data from an ECMWF model FG field.</p>
 <dl class="docutils">