Changeset 2625ca8 in flex_extract.git for documentation/Sphinx/build/html/api.html


Ignore:
Timestamp:
Jan 15, 2019, 1:03:37 AM (5 years ago)
Author:
Anne Philipp <anne.philipp@…>
Branches:
master, ctbto, dev
Children:
6f951ca
Parents:
0629ba8
Message:

new build of sphinx for updated api

File:
1 edited

Legend:

Unmodified
Added
Removed

  • documentation/Sphinx/build/html/api.html

    r274f9ef r2625ca8  
    9898<li class="toctree-l3"><a class="reference internal" href="#module-ControlFile">ControlFile</a></li>
    9999<li class="toctree-l3"><a class="reference internal" href="#module-EcFlexpart">EcFlexpart</a></li>
    100 <li class="toctree-l3"><a class="reference internal" href="#module-GribTools">GribTools</a></li>
     100<li class="toctree-l3"><a class="reference internal" href="#module-GribUtil">GribUtil</a></li>
    101101<li class="toctree-l3"><a class="reference internal" href="#module-MarsRetrieval">MarsRetrieval</a></li>
    102102<li class="toctree-l3"><a class="reference internal" href="#module-UioFiles">UioFiles</a></li>
    … …  
    189189<li><a class="reference internal" href="#module-ControlFile" id="id5">ControlFile</a></li>
    190190<li><a class="reference internal" href="#module-EcFlexpart" id="id6">EcFlexpart</a></li>
    191 <li><a class="reference internal" href="#module-GribTools" id="id7">GribTools</a></li>
     191<li><a class="reference internal" href="#module-GribUtil" id="id7">GribUtil</a></li>
    192192<li><a class="reference internal" href="#module-MarsRetrieval" id="id8">MarsRetrieval</a></li>
    193193<li><a class="reference internal" href="#module-UioFiles" id="id9">UioFiles</a></li>
    … …  
    207207<div class="section" id="module-install">
    208208<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>
    209 <dl class="function">
    210 <dt id="install.delete_convert_build">
    211 <code class="descclassname">install.</code><code class="descname">delete_convert_build</code><span class="sig-paren">(</span><em>src_path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#delete_convert_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.delete_convert_build" title="Permalink to this definition">¶</a></dt>
     209<p>This script installs the flex_extract program.</p>
     210<p>Depending on the selected installation environment (locally or on the
     211ECMWF server ecgate or cca) the program extracts the commandline
     212arguments and the CONTROL file parameter and prepares the corresponding
     213environment.
     214The necessary files are collected in a tar-ball and placed
     215at the target location. There its untared, the environment variables will
     216be set and the Fortran code will be compiled.
     217If the ECMWF environment is selected a job script is prepared and submitted
     218for the remaining configurations after putting the tar-ball to the
     219target ECMWF server.</p>
     220<p>Type: install.py –help
     221to get information about command line parameters.
     222Read the documentation for usage instructions.</p>
     223<dl class="function">
     224<dt id="install.check_install_conditions">
     225<code class="descclassname">install.</code><code class="descname">check_install_conditions</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#check_install_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.check_install_conditions" title="Permalink to this definition">¶</a></dt>
     226<dd><p>Checks a couple of necessary attributes and conditions
     227for the installation such as if they exist and contain values.
     228Otherwise set default values.</p>
     229<table class="docutils field-list" frame="void" rules="none">
     230<col class="field-name" />
     231<col class="field-body" />
     232<tbody valign="top">
     233<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
     234command line.</td>
     235</tr>
     236</tbody>
     237</table>
     238</dd></dl>
     239
     240<dl class="function">
     241<dt id="install.del_convert_build">
     242<code class="descclassname">install.</code><code class="descname">del_convert_build</code><span class="sig-paren">(</span><em>src_path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#del_convert_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.del_convert_build" title="Permalink to this definition">¶</a></dt>
    212243<dd><p>Clean up the Fortran source directory and remove all
    213244build files (e.g. *.o, *.mod and CONVERT2)</p>
    … …  
    216247<col class="field-body" />
    217248<tbody valign="top">
    218 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>src_path</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Path to the fortran source directory.</td>
    219 </tr>
    220 </tbody>
    221 </table>
    222 </dd></dl>
    223 
    224 <dl class="function">
    225 <dt id="install.get_install_cmdline_arguments">
    226 <code class="descclassname">install.</code><code class="descname">get_install_cmdline_arguments</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#get_install_cmdline_arguments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.get_install_cmdline_arguments" title="Permalink to this definition">¶</a></dt>
     249<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>src_path</strong> (<em>str</em>) – Path to the fortran source directory.</td>
     250</tr>
     251</tbody>
     252</table>
     253</dd></dl>
     254
     255<dl class="function">
     256<dt id="install.get_install_cmdline_args">
     257<code class="descclassname">install.</code><code class="descname">get_install_cmdline_args</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#get_install_cmdline_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.get_install_cmdline_args" title="Permalink to this definition">¶</a></dt>
    227258<dd><p>Decomposes the command line arguments and assigns them to variables.
    228259Apply default values for non mentioned arguments.</p>
    … …  
    233264<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>args</strong> – Contains the commandline arguments from script/program call.</td>
    234265</tr>
    235 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Namespace</span></code></td>
     266<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Namespace</td>
    236267</tr>
    237268</tbody>
    … …  
    249280<col class="field-body" />
    250281<tbody valign="top">
    251 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and
     282<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
    252283command line.</td>
    253284</tr>
    … …  
    261292<dd><p>Controls the installation process. Calls the installation function
    262293if target is specified.</p>
    263 </dd></dl>
    264 
    265 <dl class="function">
    266 <dt id="install.make_convert_build">
    267 <code class="descclassname">install.</code><code class="descname">make_convert_build</code><span class="sig-paren">(</span><em>src_path</em>, <em>makefile</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#make_convert_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.make_convert_build" title="Permalink to this definition">¶</a></dt>
    268 <dd><p>Compiles the Fortran code and generates the executable.</p>
    269 <table class="docutils field-list" frame="void" rules="none">
    270 <col class="field-name" />
    271 <col class="field-body" />
    272 <tbody valign="top">
    273 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    274 <li><strong>src_path</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Path to the fortran source directory.</li>
    275 <li><strong>makefile</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The name of the makefile which should be used.</li>
    276 </ul>
    277 </td>
    278 </tr>
    279 </tbody>
    280 </table>
    281294</dd></dl>
    282295
    … …  
    292305<tbody valign="top">
    293306<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    294 <li><strong>makefile</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Name of the makefile which should be used to compile FORTRAN
     307<li><strong>makefile</strong> (<em>str</em>) – Name of the makefile which should be used to compile FORTRAN
    295308CONVERT2 program.</li>
    296 <li><strong>target</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The target where the installation should be done, e.g. the queue.</li>
    297 <li><strong>ecuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The user id on ECMWF server.</li>
    298 <li><strong>ecgid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The group id on ECMWF server.</li>
    299 <li><strong>fp_root</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Path to the root directory of FLEXPART environment or flex_extract
     309<li><strong>target</strong> (<em>str</em>) – The target where the installation should be done, e.g. the queue.</li>
     310<li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li>
     311<li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li>
     312<li><strong>fp_root</strong> (<em>str</em>) – Path to the root directory of FLEXPART environment or flex_extract
    300313environment.</li>
     314</ul>
     315</td>
     316</tr>
     317</tbody>
     318</table>
     319</dd></dl>
     320
     321<dl class="function">
     322<dt id="install.mk_convert_build">
     323<code class="descclassname">install.</code><code class="descname">mk_convert_build</code><span class="sig-paren">(</span><em>src_path</em>, <em>makefile</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#mk_convert_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_convert_build" title="Permalink to this definition">¶</a></dt>
     324<dd><p>Compiles the Fortran code and generates the executable.</p>
     325<table class="docutils field-list" frame="void" rules="none">
     326<col class="field-name" />
     327<col class="field-body" />
     328<tbody valign="top">
     329<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
     330<li><strong>src_path</strong> (<em>str</em>) – Path to the fortran source directory.</li>
     331<li><strong>makefile</strong> (<em>str</em>) – The name of the makefile which should be used.</li>
    301332</ul>
    302333</td>
    … …  
    317348<tbody valign="top">
    318349<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    319 <li><strong>ecuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The user id on ECMWF server.</li>
    320 <li><strong>ecgid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The group id on ECMWF server.</li>
    321 <li><strong>gateway</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The gateway server the user is using.</li>
    322 <li><strong>destination</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The remote destination which is used to transfer files
     350<li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li>
     351<li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li>
     352<li><strong>gateway</strong> (<em>str</em>) – The gateway server the user is using.</li>
     353<li><strong>destination</strong> (<em>str</em>) – The remote destination which is used to transfer files
    323354from ECMWF server to local gateway server.</li>
    324355</ul>
    … …  
    340371<tbody valign="top">
    341372<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    342 <li><strong>ecuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The user id on ECMWF server.</li>
    343 <li><strong>ecgid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The group id on ECMWF server.</li>
    344 <li><strong>gateway</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The gateway server the user is using.</li>
    345 <li><strong>destination</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The remote destination which is used to transfer files
     373<li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li>
     374<li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li>
     375<li><strong>gateway</strong> (<em>str</em>) – The gateway server the user is using.</li>
     376<li><strong>destination</strong> (<em>str</em>) – The remote destination which is used to transfer files
    346377from ECMWF server to local gateway server.</li>
    347 <li><strong>fp_root</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Path to the root directory of FLEXPART environment or flex_extract
     378<li><strong>fp_root</strong> (<em>str</em>) – Path to the root directory of FLEXPART environment or flex_extract
    348379environment.</li>
    349380</ul>
    … …  
    368399<tbody valign="top">
    369400<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    370 <li><strong>tarball_path</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The complete path to the tar file which will contain all
     401<li><strong>tarball_path</strong> (<em>str</em>) – The complete path to the tar file which will contain all
    371402relevant data for flex_extract.</li>
    372 <li><strong>target</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The queue where the job is submitted to.</li>
     403<li><strong>target</strong> (<em>str</em>) – The queue where the job is submitted to.</li>
    373404</ul>
    374405</td>
    … …  
    386417<col class="field-body" />
    387418<tbody valign="top">
    388 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tarball_path</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The complete path to the tar file which will contain all
     419<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tarball_path</strong> (<em>str</em>) – The complete path to the tar file which will contain all
    389420relevant data for flex_extract.</td>
    390421</tr>
    … …  
    396427<div class="section" id="module-submit">
    397428<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>
     429<p>This script allows the user to extract meteorological fields from the ECMWF.</p>
     430<p>It prepares the settings for retrieving the data from ECMWF servers and
     431process the resulting files to prepare them for the use with FLEXPART or
     432FLEXTRA.</p>
     433<p>If it is supposed to work locally then it works through the necessary
     434functions get_mars_data and prepare_flexpart. Otherwise it prepares
     435a job script (korn shell) which will do the necessary work on the
     436ECMWF server. This script will de submitted via the ecaccess command
     437ecaccess-job-submit.</p>
     438<p>This file can also be imported as a module which then contains the following
     439functions:</p>
     440<blockquote>
     441<div><ul class="simple">
     442<li>main - the main function of the script</li>
     443<li>submit - calls mk_jobscript depending on operation mode and submits its</li>
     444<li>mk_jobscript - creates the job script from a template</li>
     445</ul>
     446</div></blockquote>
     447<p>Type: submit.py –help
     448to get information about command line parameters.
     449Read the documentation for usage instructions.</p>
    398450<dl class="function">
    399451<dt id="submit.main">
    … …  
    406458
    407459<dl class="function">
    408 <dt id="submit.submit">
    409 <code class="descclassname">submit.</code><code class="descname">submit</code><span class="sig-paren">(</span><em>jtemplate</em>, <em>c</em>, <em>queue</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/submit.html#submit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#submit.submit" title="Permalink to this definition">¶</a></dt>
    410 <dd><p>Prepares the job script and submit it to the specified queue.</p>
     460<dt id="submit.mk_jobscript">
     461<code class="descclassname">submit.</code><code class="descname">mk_jobscript</code><span class="sig-paren">(</span><em>jtemplate</em>, <em>job_file</em>, <em>clist</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/submit.html#mk_jobscript"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#submit.mk_jobscript" title="Permalink to this definition">¶</a></dt>
     462<dd><p>Creates the job script from template.</p>
    411463<table class="docutils field-list" frame="void" rules="none">
    412464<col class="field-name" />
    … …  
    414466<tbody valign="top">
    415467<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    416 <li><strong>jtemplate</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Job template file from sub-directory “_templates” for
     468<li><strong>jtemplate</strong> (<em>str</em>) – Job template file from sub-directory “_templates” for
    417469submission to ECMWF. It contains all necessary
    418470module and variable settings for the ECMWF environment as well as
    419471the job call and mail report instructions.
    420472Default is “job.temp”.</li>
    421 <li><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and
     473<li><strong>job_file</strong> (<em>str</em>) – Path to the job script file.</li>
     474<li><strong>clist</strong> (<em>list of str</em>) – Contains all necessary parameters for ECMWF CONTROL file.</li>
     475</ul>
     476</td>
     477</tr>
     478</tbody>
     479</table>
     480</dd></dl>
     481
     482<dl class="function">
     483<dt id="submit.submit">
     484<code class="descclassname">submit.</code><code class="descname">submit</code><span class="sig-paren">(</span><em>jtemplate</em>, <em>c</em>, <em>queue</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/submit.html#submit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#submit.submit" title="Permalink to this definition">¶</a></dt>
     485<dd><p>Prepares the job script and submits it to the specified queue.</p>
     486<table class="docutils field-list" frame="void" rules="none">
     487<col class="field-name" />
     488<col class="field-body" />
     489<tbody valign="top">
     490<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
     491<li><strong>jtemplate</strong> (<em>str</em>) – Job template file from sub-directory “_templates” for
     492submission to ECMWF. It contains all necessary
     493module and variable settings for the ECMWF environment as well as
     494the job call and mail report instructions.
     495Default is “job.temp”.</li>
     496<li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
    422497command line.</li>
    423 <li><strong>queue</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Name of queue for submission to ECMWF (e.g. ecgate or cca )</li>
     498<li><strong>queue</strong> (<em>str</em>) – Name of queue for submission to ECMWF (e.g. ecgate or cca )</li>
    424499</ul>
    425500</td>
    … …  
    439514<em class="property">class </em><code class="descclassname">ControlFile.</code><code class="descname">ControlFile</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ControlFile.html#ControlFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile" title="Permalink to this definition">¶</a></dt>
    440515<dd><p>Contains the information which are stored in the CONTROL files.</p>
     516<p>The CONTROL file is the steering part of the FLEXPART extraction
     517software. All necessary parameters needed to retrieve the data fields
     518from the MARS archive for driving FLEXPART are set in a CONTROL file.
     519Some specific parameters like the start and end dates can be overwritten
     520by the command line parameters, but in generel all parameters needed
     521for a complete set of fields for FLEXPART can be set in the CONTROL file.</p>
     522<dl class="attribute">
     523<dt id="ControlFile.ControlFile.controlfile">
     524<code class="descname">controlfile</code><a class="headerlink" href="#ControlFile.ControlFile.controlfile" title="Permalink to this definition">¶</a></dt>
     525<dd><p>The name of the control file to be processed. Default value is the
     526filename passed to the init function when initialised.</p>
     527<table class="docutils field-list" frame="void" rules="none">
     528<col class="field-name" />
     529<col class="field-body" />
     530<tbody valign="top">
     531<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     532</tr>
     533</tbody>
     534</table>
     535</dd></dl>
     536
     537<dl class="attribute">
     538<dt id="ControlFile.ControlFile.start_date">
     539<code class="descname">start_date</code><a class="headerlink" href="#ControlFile.ControlFile.start_date" title="Permalink to this definition">¶</a></dt>
     540<dd><p>The first day of the retrieval period. Default value is None.</p>
     541<table class="docutils field-list" frame="void" rules="none">
     542<col class="field-name" />
     543<col class="field-body" />
     544<tbody valign="top">
     545<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     546</tr>
     547</tbody>
     548</table>
     549</dd></dl>
     550
     551<dl class="attribute">
     552<dt id="ControlFile.ControlFile.end_date">
     553<code class="descname">end_date</code><a class="headerlink" href="#ControlFile.ControlFile.end_date" title="Permalink to this definition">¶</a></dt>
     554<dd><p>The last day of the retrieval period. Default value is None.</p>
     555<table class="docutils field-list" frame="void" rules="none">
     556<col class="field-name" />
     557<col class="field-body" />
     558<tbody valign="top">
     559<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     560</tr>
     561</tbody>
     562</table>
     563</dd></dl>
     564
     565<dl class="attribute">
     566<dt id="ControlFile.ControlFile.date_chunk">
     567<code class="descname">date_chunk</code><a class="headerlink" href="#ControlFile.ControlFile.date_chunk" title="Permalink to this definition">¶</a></dt>
     568<dd><p>Length of period for a single mars retrieval. Default value is 3.</p>
     569<table class="docutils field-list" frame="void" rules="none">
     570<col class="field-name" />
     571<col class="field-body" />
     572<tbody valign="top">
     573<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     574</tr>
     575</tbody>
     576</table>
     577</dd></dl>
     578
     579<dl class="attribute">
     580<dt id="ControlFile.ControlFile.dtime">
     581<code class="descname">dtime</code><a class="headerlink" href="#ControlFile.ControlFile.dtime" title="Permalink to this definition">¶</a></dt>
     582<dd><p>The time step in hours. Default value is None.</p>
     583<table class="docutils field-list" frame="void" rules="none">
     584<col class="field-name" />
     585<col class="field-body" />
     586<tbody valign="top">
     587<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     588</tr>
     589</tbody>
     590</table>
     591</dd></dl>
     592
     593<dl class="attribute">
     594<dt id="ControlFile.ControlFile.basetime">
     595<code class="descname">basetime</code><a class="headerlink" href="#ControlFile.ControlFile.basetime" title="Permalink to this definition">¶</a></dt>
     596<dd><p>The time for a half day retrieval. The 12 hours upfront are to be
     597retrieved. Default value is None.</p>
     598<table class="docutils field-list" frame="void" rules="none">
     599<col class="field-name" />
     600<col class="field-body" />
     601<tbody valign="top">
     602<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     603</tr>
     604</tbody>
     605</table>
     606</dd></dl>
     607
     608<dl class="attribute">
     609<dt id="ControlFile.ControlFile.maxstep">
     610<code class="descname">maxstep</code><a class="headerlink" href="#ControlFile.ControlFile.maxstep" title="Permalink to this definition">¶</a></dt>
     611<dd><p>The maximum forecast step for non flux data. Default value is None.</p>
     612<table class="docutils field-list" frame="void" rules="none">
     613<col class="field-name" />
     614<col class="field-body" />
     615<tbody valign="top">
     616<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     617</tr>
     618</tbody>
     619</table>
     620</dd></dl>
     621
     622<dl class="attribute">
     623<dt id="ControlFile.ControlFile.type">
     624<code class="descname">type</code><a class="headerlink" href="#ControlFile.ControlFile.type" title="Permalink to this definition">¶</a></dt>
     625<dd><p>List of field type per retrieving hour. Default value is None.</p>
     626<table class="docutils field-list" frame="void" rules="none">
     627<col class="field-name" />
     628<col class="field-body" />
     629<tbody valign="top">
     630<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td>
     631</tr>
     632</tbody>
     633</table>
     634</dd></dl>
     635
     636<dl class="attribute">
     637<dt id="ControlFile.ControlFile.time">
     638<code class="descname">time</code><a class="headerlink" href="#ControlFile.ControlFile.time" title="Permalink to this definition">¶</a></dt>
     639<dd><p>List of retrieving times in hours. Default valuer is None.</p>
     640<table class="docutils field-list" frame="void" rules="none">
     641<col class="field-name" />
     642<col class="field-body" />
     643<tbody valign="top">
     644<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td>
     645</tr>
     646</tbody>
     647</table>
     648</dd></dl>
     649
     650<dl class="attribute">
     651<dt id="ControlFile.ControlFile.step">
     652<code class="descname">step</code><a class="headerlink" href="#ControlFile.ControlFile.step" title="Permalink to this definition">¶</a></dt>
     653<dd><p>List of forecast time steps in hours for non flux data.
     654Default value is None.</p>
     655<table class="docutils field-list" frame="void" rules="none">
     656<col class="field-name" />
     657<col class="field-body" />
     658<tbody valign="top">
     659<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str or str</td>
     660</tr>
     661</tbody>
     662</table>
     663</dd></dl>
     664
     665<dl class="attribute">
     666<dt id="ControlFile.ControlFile.acctype">
     667<code class="descname">acctype</code><a class="headerlink" href="#ControlFile.ControlFile.acctype" title="Permalink to this definition">¶</a></dt>
     668<dd><p>The field type for the accumulated forecast fields.
     669Default value is None.</p>
     670<table class="docutils field-list" frame="void" rules="none">
     671<col class="field-name" />
     672<col class="field-body" />
     673<tbody valign="top">
     674<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     675</tr>
     676</tbody>
     677</table>
     678</dd></dl>
     679
     680<dl class="attribute">
     681<dt id="ControlFile.ControlFile.acctime">
     682<code class="descname">acctime</code><a class="headerlink" href="#ControlFile.ControlFile.acctime" title="Permalink to this definition">¶</a></dt>
     683<dd><p>The starting time of the accumulated forecasts. Default value is None.</p>
     684<table class="docutils field-list" frame="void" rules="none">
     685<col class="field-name" />
     686<col class="field-body" />
     687<tbody valign="top">
     688<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     689</tr>
     690</tbody>
     691</table>
     692</dd></dl>
     693
     694<dl class="attribute">
     695<dt id="ControlFile.ControlFile.accmaxstep">
     696<code class="descname">accmaxstep</code><a class="headerlink" href="#ControlFile.ControlFile.accmaxstep" title="Permalink to this definition">¶</a></dt>
     697<dd><p>The maximum forecast step for the accumulated forecast fields
     698(flux data). Default value is None.</p>
     699<table class="docutils field-list" frame="void" rules="none">
     700<col class="field-name" />
     701<col class="field-body" />
     702<tbody valign="top">
     703<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     704</tr>
     705</tbody>
     706</table>
     707</dd></dl>
     708
     709<dl class="attribute">
     710<dt id="ControlFile.ControlFile.marsclass">
     711<code class="descname">marsclass</code><a class="headerlink" href="#ControlFile.ControlFile.marsclass" title="Permalink to this definition">¶</a></dt>
     712<dd><p>Characterisation of dataset. Default value is None.</p>
     713<table class="docutils field-list" frame="void" rules="none">
     714<col class="field-name" />
     715<col class="field-body" />
     716<tbody valign="top">
     717<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     718</tr>
     719</tbody>
     720</table>
     721</dd></dl>
     722
     723<dl class="attribute">
     724<dt id="ControlFile.ControlFile.dataset">
     725<code class="descname">dataset</code><a class="headerlink" href="#ControlFile.ControlFile.dataset" title="Permalink to this definition">¶</a></dt>
     726<dd><p>For public datasets there is the specific naming and parameter
     727dataset which has to be used to characterize the type of
     728data. Default value is None.</p>
     729<table class="docutils field-list" frame="void" rules="none">
     730<col class="field-name" />
     731<col class="field-body" />
     732<tbody valign="top">
     733<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     734</tr>
     735</tbody>
     736</table>
     737</dd></dl>
     738
     739<dl class="attribute">
     740<dt id="ControlFile.ControlFile.stream">
     741<code class="descname">stream</code><a class="headerlink" href="#ControlFile.ControlFile.stream" title="Permalink to this definition">¶</a></dt>
     742<dd><p>Identifies the forecasting system used to generate the data.
     743Default value is None.</p>
     744<table class="docutils field-list" frame="void" rules="none">
     745<col class="field-name" />
     746<col class="field-body" />
     747<tbody valign="top">
     748<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     749</tr>
     750</tbody>
     751</table>
     752</dd></dl>
     753
     754<dl class="attribute">
     755<dt id="ControlFile.ControlFile.number">
     756<code class="descname">number</code><a class="headerlink" href="#ControlFile.ControlFile.number" title="Permalink to this definition">¶</a></dt>
     757<dd><p>Selects the member in ensemble forecast run. Default value is ‘OFF’.</p>
     758<table class="docutils field-list" frame="void" rules="none">
     759<col class="field-name" />
     760<col class="field-body" />
     761<tbody valign="top">
     762<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     763</tr>
     764</tbody>
     765</table>
     766</dd></dl>
     767
     768<dl class="attribute">
     769<dt id="ControlFile.ControlFile.expver">
     770<code class="descname">expver</code><a class="headerlink" href="#ControlFile.ControlFile.expver" title="Permalink to this definition">¶</a></dt>
     771<dd><p>The version number of the dataset. Default value is ‘1’.</p>
     772<table class="docutils field-list" frame="void" rules="none">
     773<col class="field-name" />
     774<col class="field-body" />
     775<tbody valign="top">
     776<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     777</tr>
     778</tbody>
     779</table>
     780</dd></dl>
     781
     782<dl class="attribute">
     783<dt id="ControlFile.ControlFile.gaussian">
     784<code class="descname">gaussian</code><a class="headerlink" href="#ControlFile.ControlFile.gaussian" title="Permalink to this definition">¶</a></dt>
     785<dd><p>This parameter is deprecated and should no longer be used.
     786Specifies the desired type of Gaussian grid for the output.
     787Default value is an empty string ‘’.</p>
     788<table class="docutils field-list" frame="void" rules="none">
     789<col class="field-name" />
     790<col class="field-body" />
     791<tbody valign="top">
     792<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     793</tr>
     794</tbody>
     795</table>
     796</dd></dl>
     797
     798<dl class="attribute">
     799<dt id="ControlFile.ControlFile.grid">
     800<code class="descname">grid</code><a class="headerlink" href="#ControlFile.ControlFile.grid" title="Permalink to this definition">¶</a></dt>
     801<dd><p>Specifies the output grid which can be either a Gaussian grid
     802or a Latitude/Longitude grid. Default value is None.</p>
     803<table class="docutils field-list" frame="void" rules="none">
     804<col class="field-name" />
     805<col class="field-body" />
     806<tbody valign="top">
     807<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     808</tr>
     809</tbody>
     810</table>
     811</dd></dl>
     812
     813<dl class="attribute">
     814<dt id="ControlFile.ControlFile.area">
     815<code class="descname">area</code><a class="headerlink" href="#ControlFile.ControlFile.area" title="Permalink to this definition">¶</a></dt>
     816<dd><p>Specifies the desired sub-area of data to be extracted.
     817Default value is None.</p>
     818<table class="docutils field-list" frame="void" rules="none">
     819<col class="field-name" />
     820<col class="field-body" />
     821<tbody valign="top">
     822<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     823</tr>
     824</tbody>
     825</table>
     826</dd></dl>
     827
     828<dl class="attribute">
     829<dt id="ControlFile.ControlFile.left">
     830<code class="descname">left</code><a class="headerlink" href="#ControlFile.ControlFile.left" title="Permalink to this definition">¶</a></dt>
     831<dd><p>The western most longitude of the area to be extracted.
     832Default value is None.</p>
     833<table class="docutils field-list" frame="void" rules="none">
     834<col class="field-name" />
     835<col class="field-body" />
     836<tbody valign="top">
     837<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     838</tr>
     839</tbody>
     840</table>
     841</dd></dl>
     842
     843<dl class="attribute">
     844<dt id="ControlFile.ControlFile.lower">
     845<code class="descname">lower</code><a class="headerlink" href="#ControlFile.ControlFile.lower" title="Permalink to this definition">¶</a></dt>
     846<dd><p>The southern most latitude of the area to be extracted.
     847Default value is None.</p>
     848<table class="docutils field-list" frame="void" rules="none">
     849<col class="field-name" />
     850<col class="field-body" />
     851<tbody valign="top">
     852<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     853</tr>
     854</tbody>
     855</table>
     856</dd></dl>
     857
     858<dl class="attribute">
     859<dt id="ControlFile.ControlFile.upper">
     860<code class="descname">upper</code><a class="headerlink" href="#ControlFile.ControlFile.upper" title="Permalink to this definition">¶</a></dt>
     861<dd><p>The northern most latitued of the area to be extracted.
     862Default value is None.</p>
     863<table class="docutils field-list" frame="void" rules="none">
     864<col class="field-name" />
     865<col class="field-body" />
     866<tbody valign="top">
     867<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     868</tr>
     869</tbody>
     870</table>
     871</dd></dl>
     872
     873<dl class="attribute">
     874<dt id="ControlFile.ControlFile.right">
     875<code class="descname">right</code><a class="headerlink" href="#ControlFile.ControlFile.right" title="Permalink to this definition">¶</a></dt>
     876<dd><p>The eastern most longitude of the area to be extracted.
     877Default value is None.</p>
     878<table class="docutils field-list" frame="void" rules="none">
     879<col class="field-name" />
     880<col class="field-body" />
     881<tbody valign="top">
     882<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     883</tr>
     884</tbody>
     885</table>
     886</dd></dl>
     887
     888<dl class="attribute">
     889<dt id="ControlFile.ControlFile.level">
     890<code class="descname">level</code><a class="headerlink" href="#ControlFile.ControlFile.level" title="Permalink to this definition">¶</a></dt>
     891<dd><p>Specifies the maximum level. Default value is None.</p>
     892<table class="docutils field-list" frame="void" rules="none">
     893<col class="field-name" />
     894<col class="field-body" />
     895<tbody valign="top">
     896<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     897</tr>
     898</tbody>
     899</table>
     900</dd></dl>
     901
     902<dl class="attribute">
     903<dt id="ControlFile.ControlFile.levelist">
     904<code class="descname">levelist</code><a class="headerlink" href="#ControlFile.ControlFile.levelist" title="Permalink to this definition">¶</a></dt>
     905<dd><p>Specifies the required level list. Default value is None.</p>
     906<table class="docutils field-list" frame="void" rules="none">
     907<col class="field-name" />
     908<col class="field-body" />
     909<tbody valign="top">
     910<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     911</tr>
     912</tbody>
     913</table>
     914</dd></dl>
     915
     916<dl class="attribute">
     917<dt id="ControlFile.ControlFile.resol">
     918<code class="descname">resol</code><a class="headerlink" href="#ControlFile.ControlFile.resol" title="Permalink to this definition">¶</a></dt>
     919<dd><p>Specifies the desired triangular truncation of retrieved data,
     920before carrying out any other selected post-processing.
     921Default value is None.</p>
     922<table class="docutils field-list" frame="void" rules="none">
     923<col class="field-name" />
     924<col class="field-body" />
     925<tbody valign="top">
     926<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     927</tr>
     928</tbody>
     929</table>
     930</dd></dl>
     931
     932<dl class="attribute">
     933<dt id="ControlFile.ControlFile.gauss">
     934<code class="descname">gauss</code><a class="headerlink" href="#ControlFile.ControlFile.gauss" title="Permalink to this definition">¶</a></dt>
     935<dd><p>Switch to select gaussian fields (1) or regular lat/lon (0).
     936Default value is 0.</p>
     937<table class="docutils field-list" frame="void" rules="none">
     938<col class="field-name" />
     939<col class="field-body" />
     940<tbody valign="top">
     941<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     942</tr>
     943</tbody>
     944</table>
     945</dd></dl>
     946
     947<dl class="attribute">
     948<dt id="ControlFile.ControlFile.accuracy">
     949<code class="descname">accuracy</code><a class="headerlink" href="#ControlFile.ControlFile.accuracy" title="Permalink to this definition">¶</a></dt>
     950<dd><p>Specifies the number of bits per value to be used in the
     951generated GRIB coded fields. Default value is 24.</p>
     952<table class="docutils field-list" frame="void" rules="none">
     953<col class="field-name" />
     954<col class="field-body" />
     955<tbody valign="top">
     956<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     957</tr>
     958</tbody>
     959</table>
     960</dd></dl>
     961
     962<dl class="attribute">
     963<dt id="ControlFile.ControlFile.omega">
     964<code class="descname">omega</code><a class="headerlink" href="#ControlFile.ControlFile.omega" title="Permalink to this definition">¶</a></dt>
     965<dd><p>Switch to select omega retrieval (1) or not (0). Default value is 0.</p>
     966<table class="docutils field-list" frame="void" rules="none">
     967<col class="field-name" />
     968<col class="field-body" />
     969<tbody valign="top">
     970<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     971</tr>
     972</tbody>
     973</table>
     974</dd></dl>
     975
     976<dl class="attribute">
     977<dt id="ControlFile.ControlFile.omegadiff">
     978<code class="descname">omegadiff</code><a class="headerlink" href="#ControlFile.ControlFile.omegadiff" title="Permalink to this definition">¶</a></dt>
     979<dd><p>Switch to decide to calculate Omega and Dps/Dt from continuity
     980equation for diagnostic purposes (1) or not (0). Default value is 0.</p>
     981<table class="docutils field-list" frame="void" rules="none">
     982<col class="field-name" />
     983<col class="field-body" />
     984<tbody valign="top">
     985<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     986</tr>
     987</tbody>
     988</table>
     989</dd></dl>
     990
     991<dl class="attribute">
     992<dt id="ControlFile.ControlFile.eta">
     993<code class="descname">eta</code><a class="headerlink" href="#ControlFile.ControlFile.eta" title="Permalink to this definition">¶</a></dt>
     994<dd><p>Switch to select direct retrieval of etadot from MARS (1) or
     995wether it has to be calculated (0). Then Default value is 0.</p>
     996<table class="docutils field-list" frame="void" rules="none">
     997<col class="field-name" />
     998<col class="field-body" />
     999<tbody valign="top">
     1000<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1001</tr>
     1002</tbody>
     1003</table>
     1004</dd></dl>
     1005
     1006<dl class="attribute">
     1007<dt id="ControlFile.ControlFile.etadiff">
     1008<code class="descname">etadiff</code><a class="headerlink" href="#ControlFile.ControlFile.etadiff" title="Permalink to this definition">¶</a></dt>
     1009<dd><p>Switch to select calculation of etadot and Dps/Dt from continuity
     1010equation for diagnostic purposes (1) or not (0). Default value is 0.</p>
     1011<table class="docutils field-list" frame="void" rules="none">
     1012<col class="field-name" />
     1013<col class="field-body" />
     1014<tbody valign="top">
     1015<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1016</tr>
     1017</tbody>
     1018</table>
     1019</dd></dl>
     1020
     1021<dl class="attribute">
     1022<dt id="ControlFile.ControlFile.etapar">
     1023<code class="descname">etapar</code><a class="headerlink" href="#ControlFile.ControlFile.etapar" title="Permalink to this definition">¶</a></dt>
     1024<dd><p>GRIB parameter Id for etadot fields. Default value is 77.</p>
     1025<table class="docutils field-list" frame="void" rules="none">
     1026<col class="field-name" />
     1027<col class="field-body" />
     1028<tbody valign="top">
     1029<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1030</tr>
     1031</tbody>
     1032</table>
     1033</dd></dl>
     1034
     1035<dl class="attribute">
     1036<dt id="ControlFile.ControlFile.dpdeta">
     1037<code class="descname">dpdeta</code><a class="headerlink" href="#ControlFile.ControlFile.dpdeta" title="Permalink to this definition">¶</a></dt>
     1038<dd><p>Switch to select multiplication of etadot with dpdeta.
     1039Default value is 1.</p>
     1040<table class="docutils field-list" frame="void" rules="none">
     1041<col class="field-name" />
     1042<col class="field-body" />
     1043<tbody valign="top">
     1044<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1045</tr>
     1046</tbody>
     1047</table>
     1048</dd></dl>
     1049
     1050<dl class="attribute">
     1051<dt id="ControlFile.ControlFile.smooth">
     1052<code class="descname">smooth</code><a class="headerlink" href="#ControlFile.ControlFile.smooth" title="Permalink to this definition">¶</a></dt>
     1053<dd><p>Spectral truncation of ETADOT after calculation on Gaussian grid.
     1054Default value is 0.</p>
     1055<table class="docutils field-list" frame="void" rules="none">
     1056<col class="field-name" />
     1057<col class="field-body" />
     1058<tbody valign="top">
     1059<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1060</tr>
     1061</tbody>
     1062</table>
     1063</dd></dl>
     1064
     1065<dl class="attribute">
     1066<dt id="ControlFile.ControlFile.format">
     1067<code class="descname">format</code><a class="headerlink" href="#ControlFile.ControlFile.format" title="Permalink to this definition">¶</a></dt>
     1068<dd><p>The format of the GRIB data. Default value is ‘GRIB1’.</p>
     1069<table class="docutils field-list" frame="void" rules="none">
     1070<col class="field-name" />
     1071<col class="field-body" />
     1072<tbody valign="top">
     1073<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1074</tr>
     1075</tbody>
     1076</table>
     1077</dd></dl>
     1078
     1079<dl class="attribute">
     1080<dt id="ControlFile.ControlFile.addpar">
     1081<code class="descname">addpar</code><a class="headerlink" href="#ControlFile.ControlFile.addpar" title="Permalink to this definition">¶</a></dt>
     1082<dd><p>List of additional surface level ECMWF parameter to be retrieved.
     1083Default value is None.</p>
     1084<table class="docutils field-list" frame="void" rules="none">
     1085<col class="field-name" />
     1086<col class="field-body" />
     1087<tbody valign="top">
     1088<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1089</tr>
     1090</tbody>
     1091</table>
     1092</dd></dl>
     1093
     1094<dl class="attribute">
     1095<dt id="ControlFile.ControlFile.prefix">
     1096<code class="descname">prefix</code><a class="headerlink" href="#ControlFile.ControlFile.prefix" title="Permalink to this definition">¶</a></dt>
     1097<dd><p>Prefix string for the final FLEXPART/FLEXTRA ready input files.
     1098Default value is ‘EN’.</p>
     1099<table class="docutils field-list" frame="void" rules="none">
     1100<col class="field-name" />
     1101<col class="field-body" />
     1102<tbody valign="top">
     1103<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1104</tr>
     1105</tbody>
     1106</table>
     1107</dd></dl>
     1108
     1109<dl class="attribute">
     1110<dt id="ControlFile.ControlFile.cwc">
     1111<code class="descname">cwc</code><a class="headerlink" href="#ControlFile.ControlFile.cwc" title="Permalink to this definition">¶</a></dt>
     1112<dd><p>Switch to select wether the sum of cloud liquid water content and
     1113cloud ice water content should be retrieved. Default value is 0.</p>
     1114<table class="docutils field-list" frame="void" rules="none">
     1115<col class="field-name" />
     1116<col class="field-body" />
     1117<tbody valign="top">
     1118<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1119</tr>
     1120</tbody>
     1121</table>
     1122</dd></dl>
     1123
     1124<dl class="attribute">
     1125<dt id="ControlFile.ControlFile.wrf">
     1126<code class="descname">wrf</code><a class="headerlink" href="#ControlFile.ControlFile.wrf" title="Permalink to this definition">¶</a></dt>
     1127<dd><p>Switch to select further parameters for retrievment to support
     1128WRF simulations. Default value is 0.</p>
     1129<table class="docutils field-list" frame="void" rules="none">
     1130<col class="field-name" />
     1131<col class="field-body" />
     1132<tbody valign="top">
     1133<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1134</tr>
     1135</tbody>
     1136</table>
     1137</dd></dl>
     1138
     1139<dl class="attribute">
     1140<dt id="ControlFile.ControlFile.ecfsdir">
     1141<code class="descname">ecfsdir</code><a class="headerlink" href="#ControlFile.ControlFile.ecfsdir" title="Permalink to this definition">¶</a></dt>
     1142<dd><p>Path to the ECMWF storage  ‘ectmp:/${USER}/econdemand/’</p>
     1143<table class="docutils field-list" frame="void" rules="none">
     1144<col class="field-name" />
     1145<col class="field-body" />
     1146<tbody valign="top">
     1147<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1148</tr>
     1149</tbody>
     1150</table>
     1151</dd></dl>
     1152
     1153<dl class="attribute">
     1154<dt id="ControlFile.ControlFile.mailfail">
     1155<code class="descname">mailfail</code><a class="headerlink" href="#ControlFile.ControlFile.mailfail" title="Permalink to this definition">¶</a></dt>
     1156<dd><p>Email list for sending error log files from ECMWF servers.
     1157The email addresses should be seperated by a comma.
     1158Default value is [‘${USER}’].</p>
     1159<table class="docutils field-list" frame="void" rules="none">
     1160<col class="field-name" />
     1161<col class="field-body" />
     1162<tbody valign="top">
     1163<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td>
     1164</tr>
     1165</tbody>
     1166</table>
     1167</dd></dl>
     1168
     1169<dl class="attribute">
     1170<dt id="ControlFile.ControlFile.mailops">
     1171<code class="descname">mailops</code><a class="headerlink" href="#ControlFile.ControlFile.mailops" title="Permalink to this definition">¶</a></dt>
     1172<dd><p>Email list for sending operational log files from ECMWF servers.
     1173The email addresses should be seperated by a comma.
     1174Default value is [‘${USER}’].</p>
     1175<table class="docutils field-list" frame="void" rules="none">
     1176<col class="field-name" />
     1177<col class="field-body" />
     1178<tbody valign="top">
     1179<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td>
     1180</tr>
     1181</tbody>
     1182</table>
     1183</dd></dl>
     1184
     1185<dl class="attribute">
     1186<dt id="ControlFile.ControlFile.grib2flexpart">
     1187<code class="descname">grib2flexpart</code><a class="headerlink" href="#ControlFile.ControlFile.grib2flexpart" title="Permalink to this definition">¶</a></dt>
     1188<dd><p>Switch to select generation of preprocessed FLEXPART files “.fp”.
     1189If it is selected, the program grib2flexpart will try
     1190to convert the flex_extract output files into “.fp” format.</p>
     1191<table class="docutils field-list" frame="void" rules="none">
     1192<col class="field-name" />
     1193<col class="field-body" />
     1194<tbody valign="top">
     1195<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int 0</td>
     1196</tr>
     1197</tbody>
     1198</table>
     1199</dd></dl>
     1200
     1201<dl class="attribute">
     1202<dt id="ControlFile.ControlFile.ecstorage">
     1203<code class="descname">ecstorage</code><a class="headerlink" href="#ControlFile.ControlFile.ecstorage" title="Permalink to this definition">¶</a></dt>
     1204<dd><p>Switch to select storage of FLEXPART ready output files
     1205in the ECFS file system. Default value is 0.</p>
     1206<table class="docutils field-list" frame="void" rules="none">
     1207<col class="field-name" />
     1208<col class="field-body" />
     1209<tbody valign="top">
     1210<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1211</tr>
     1212</tbody>
     1213</table>
     1214</dd></dl>
     1215
     1216<dl class="attribute">
     1217<dt id="ControlFile.ControlFile.ectrans">
     1218<code class="descname">ectrans</code><a class="headerlink" href="#ControlFile.ControlFile.ectrans" title="Permalink to this definition">¶</a></dt>
     1219<dd><p>Switch to select the transfer of FLEXPART ready output files
     1220to the gateway server. Default value is 0.</p>
     1221<table class="docutils field-list" frame="void" rules="none">
     1222<col class="field-name" />
     1223<col class="field-body" />
     1224<tbody valign="top">
     1225<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1226</tr>
     1227</tbody>
     1228</table>
     1229</dd></dl>
     1230
     1231<dl class="attribute">
     1232<dt id="ControlFile.ControlFile.inputdir">
     1233<code class="descname">inputdir</code><a class="headerlink" href="#ControlFile.ControlFile.inputdir" title="Permalink to this definition">¶</a></dt>
     1234<dd><p>Path to the temporary directory for the retrieval grib files and
     1235other processing files. Default value is _config.PATH_INPUT_DIR.</p>
     1236<table class="docutils field-list" frame="void" rules="none">
     1237<col class="field-name" />
     1238<col class="field-body" />
     1239<tbody valign="top">
     1240<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1241</tr>
     1242</tbody>
     1243</table>
     1244</dd></dl>
     1245
     1246<dl class="attribute">
     1247<dt id="ControlFile.ControlFile.outputdir">
     1248<code class="descname">outputdir</code><a class="headerlink" href="#ControlFile.ControlFile.outputdir" title="Permalink to this definition">¶</a></dt>
     1249<dd><p>Path to the final directory where the final FLEXPART ready input
     1250files are stored. Default value is None.</p>
     1251<table class="docutils field-list" frame="void" rules="none">
     1252<col class="field-name" />
     1253<col class="field-body" />
     1254<tbody valign="top">
     1255<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1256</tr>
     1257</tbody>
     1258</table>
     1259</dd></dl>
     1260
     1261<dl class="attribute">
     1262<dt id="ControlFile.ControlFile.flexextractdir">
     1263<code class="descname">flexextractdir</code><a class="headerlink" href="#ControlFile.ControlFile.flexextractdir" title="Permalink to this definition">¶</a></dt>
     1264<dd><p>Path to the flex_extract root directory. Default value is
     1265_config.PATH_FLEXEXTRACT_DIR.</p>
     1266<table class="docutils field-list" frame="void" rules="none">
     1267<col class="field-name" />
     1268<col class="field-body" />
     1269<tbody valign="top">
     1270<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1271</tr>
     1272</tbody>
     1273</table>
     1274</dd></dl>
     1275
     1276<dl class="attribute">
     1277<dt id="ControlFile.ControlFile.exedir">
     1278<code class="descname">exedir</code><a class="headerlink" href="#ControlFile.ControlFile.exedir" title="Permalink to this definition">¶</a></dt>
     1279<dd><p>Path to the FORTRAN executable file. Default value is
     1280_config.PATH_FORTRAN_SRC.</p>
     1281<table class="docutils field-list" frame="void" rules="none">
     1282<col class="field-name" />
     1283<col class="field-body" />
     1284<tbody valign="top">
     1285<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1286</tr>
     1287</tbody>
     1288</table>
     1289</dd></dl>
     1290
     1291<dl class="attribute">
     1292<dt id="ControlFile.ControlFile.flexpartdir">
     1293<code class="descname">flexpartdir</code><a class="headerlink" href="#ControlFile.ControlFile.flexpartdir" title="Permalink to this definition">¶</a></dt>
     1294<dd><p>Path to a FLEXPART root directory. Default value is None.</p>
     1295<table class="docutils field-list" frame="void" rules="none">
     1296<col class="field-name" />
     1297<col class="field-body" />
     1298<tbody valign="top">
     1299<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1300</tr>
     1301</tbody>
     1302</table>
     1303</dd></dl>
     1304
     1305<dl class="attribute">
     1306<dt id="ControlFile.ControlFile.makefile">
     1307<code class="descname">makefile</code><a class="headerlink" href="#ControlFile.ControlFile.makefile" title="Permalink to this definition">¶</a></dt>
     1308<dd><p>Name of the makefile to be used for the Fortran program.
     1309Default value is ‘Makefile.gfortran’.</p>
     1310<table class="docutils field-list" frame="void" rules="none">
     1311<col class="field-name" />
     1312<col class="field-body" />
     1313<tbody valign="top">
     1314<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1315</tr>
     1316</tbody>
     1317</table>
     1318</dd></dl>
     1319
     1320<dl class="attribute">
     1321<dt id="ControlFile.ControlFile.destination">
     1322<code class="descname">destination</code><a class="headerlink" href="#ControlFile.ControlFile.destination" title="Permalink to this definition">¶</a></dt>
     1323<dd><p>The remote destination which is used to transfer files
     1324from ECMWF server to local gateway server. Default value is None.</p>
     1325<table class="docutils field-list" frame="void" rules="none">
     1326<col class="field-name" />
     1327<col class="field-body" />
     1328<tbody valign="top">
     1329<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1330</tr>
     1331</tbody>
     1332</table>
     1333</dd></dl>
     1334
     1335<dl class="attribute">
     1336<dt id="ControlFile.ControlFile.gateway">
     1337<code class="descname">gateway</code><a class="headerlink" href="#ControlFile.ControlFile.gateway" title="Permalink to this definition">¶</a></dt>
     1338<dd><p>The gateway server the user is using. Default value is None.</p>
     1339<table class="docutils field-list" frame="void" rules="none">
     1340<col class="field-name" />
     1341<col class="field-body" />
     1342<tbody valign="top">
     1343<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1344</tr>
     1345</tbody>
     1346</table>
     1347</dd></dl>
     1348
     1349<dl class="attribute">
     1350<dt id="ControlFile.ControlFile.ecuid">
     1351<code class="descname">ecuid</code><a class="headerlink" href="#ControlFile.ControlFile.ecuid" title="Permalink to this definition">¶</a></dt>
     1352<dd><p>The user id on ECMWF server. Default value is None.</p>
     1353<table class="docutils field-list" frame="void" rules="none">
     1354<col class="field-name" />
     1355<col class="field-body" />
     1356<tbody valign="top">
     1357<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1358</tr>
     1359</tbody>
     1360</table>
     1361</dd></dl>
     1362
     1363<dl class="attribute">
     1364<dt id="ControlFile.ControlFile.ecgid">
     1365<code class="descname">ecgid</code><a class="headerlink" href="#ControlFile.ControlFile.ecgid" title="Permalink to this definition">¶</a></dt>
     1366<dd><p>The group id on ECMWF server. Default value is None.</p>
     1367<table class="docutils field-list" frame="void" rules="none">
     1368<col class="field-name" />
     1369<col class="field-body" />
     1370<tbody valign="top">
     1371<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1372</tr>
     1373</tbody>
     1374</table>
     1375</dd></dl>
     1376
     1377<dl class="attribute">
     1378<dt id="ControlFile.ControlFile.install_target">
     1379<code class="descname">install_target</code><a class="headerlink" href="#ControlFile.ControlFile.install_target" title="Permalink to this definition">¶</a></dt>
     1380<dd><p>Defines the location where the installation is to be done.
     1381Default value is None.</p>
     1382<table class="docutils field-list" frame="void" rules="none">
     1383<col class="field-name" />
     1384<col class="field-body" />
     1385<tbody valign="top">
     1386<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1387</tr>
     1388</tbody>
     1389</table>
     1390</dd></dl>
     1391
     1392<dl class="attribute">
     1393<dt id="ControlFile.ControlFile.debug">
     1394<code class="descname">debug</code><a class="headerlink" href="#ControlFile.ControlFile.debug" title="Permalink to this definition">¶</a></dt>
     1395<dd><p>Switch to keep temporary files at the end of postprocessing (1) or
     1396to delete all temporary files except the final output files (0).
     1397Default value is 0.</p>
     1398<table class="docutils field-list" frame="void" rules="none">
     1399<col class="field-name" />
     1400<col class="field-body" />
     1401<tbody valign="top">
     1402<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1403</tr>
     1404</tbody>
     1405</table>
     1406</dd></dl>
     1407
     1408<dl class="attribute">
     1409<dt id="ControlFile.ControlFile.request">
     1410<code class="descname">request</code><a class="headerlink" href="#ControlFile.ControlFile.request" title="Permalink to this definition">¶</a></dt>
     1411<dd><p>Switch to select between just retrieving the data (0), writing the mars
     1412parameter values to a csv file (1) or doing both (2).
     1413Default value is 0.</p>
     1414<table class="docutils field-list" frame="void" rules="none">
     1415<col class="field-name" />
     1416<col class="field-body" />
     1417<tbody valign="top">
     1418<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1419</tr>
     1420</tbody>
     1421</table>
     1422</dd></dl>
     1423
     1424<dl class="attribute">
     1425<dt id="ControlFile.ControlFile.public">
     1426<code class="descname">public</code><a class="headerlink" href="#ControlFile.ControlFile.public" title="Permalink to this definition">¶</a></dt>
     1427<dd><p>Switch to select kind of ECMWF Web Api access and the
     1428possible data sets. Public data sets (1) and Memberstate data sets (0).
     1429Default value is 0.</p>
     1430<table class="docutils field-list" frame="void" rules="none">
     1431<col class="field-name" />
     1432<col class="field-body" />
     1433<tbody valign="top">
     1434<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1435</tr>
     1436</tbody>
     1437</table>
     1438</dd></dl>
     1439
     1440<dl class="attribute">
     1441<dt id="ControlFile.ControlFile.ecapi">
     1442<code class="descname">ecapi</code><a class="headerlink" href="#ControlFile.ControlFile.ecapi" title="Permalink to this definition">¶</a></dt>
     1443<dd><p>Tells wether the ECMWF Web APi was able to load or not.
     1444Default value is None.</p>
     1445<table class="docutils field-list" frame="void" rules="none">
     1446<col class="field-name" />
     1447<col class="field-body" />
     1448<tbody valign="top">
     1449<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td>
     1450</tr>
     1451</tbody>
     1452</table>
     1453</dd></dl>
     1454
     1455<dl class="attribute">
     1456<dt id="ControlFile.ControlFile.purefc">
     1457<code class="descname">purefc</code><a class="headerlink" href="#ControlFile.ControlFile.purefc" title="Permalink to this definition">¶</a></dt>
     1458<dd><p>Switch to decide wether the job is a pure forecast retrieval or
     1459coupled with analysis data. Default value is 0.</p>
     1460<table class="docutils field-list" frame="void" rules="none">
     1461<col class="field-name" />
     1462<col class="field-body" />
     1463<tbody valign="top">
     1464<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1465</tr>
     1466</tbody>
     1467</table>
     1468</dd></dl>
     1469
     1470<dl class="attribute">
     1471<dt id="ControlFile.ControlFile.rrint">
     1472<code class="descname">rrint</code><a class="headerlink" href="#ControlFile.ControlFile.rrint" title="Permalink to this definition">¶</a></dt>
     1473<dd><p>Switch to select between old precipitation disaggregation method (0)
     1474or the new IA3 disaggegration method (1). Default value is 0.</p>
     1475<table class="docutils field-list" frame="void" rules="none">
     1476<col class="field-name" />
     1477<col class="field-body" />
     1478<tbody valign="top">
     1479<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1480</tr>
     1481</tbody>
     1482</table>
     1483</dd></dl>
     1484
     1485<dl class="attribute">
     1486<dt id="ControlFile.ControlFile.logicals">
     1487<code class="descname">logicals</code><a class="headerlink" href="#ControlFile.ControlFile.logicals" title="Permalink to this definition">¶</a></dt>
     1488<dd><p>List of the names of logical switches which controls the flow
     1489of the program. Default list is [‘gauss’, ‘omega’, ‘omegadiff’, ‘eta’,
     1490‘etadiff’, ‘dpdeta’, ‘cwc’, ‘wrf’, ‘grib2flexpart’, ‘ecstorage’,
     1491‘ectrans’, ‘debug’, ‘request’, ‘public’, ‘purefc’, ‘rrint’]</p>
     1492<table class="docutils field-list" frame="void" rules="none">
     1493<col class="field-name" />
     1494<col class="field-body" />
     1495<tbody valign="top">
     1496<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td>
     1497</tr>
     1498</tbody>
     1499</table>
     1500</dd></dl>
     1501
    4411502<dl class="method">
    4421503<dt id="ControlFile.ControlFile.assign_args_to_control">
    … …  
    4481509<col class="field-body" />
    4491510<tbody valign="top">
    450 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>args</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Namespace</span></code>) – Contains the commandline arguments from script/program call.</td>
     1511<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>args</strong> (<em>Namespace</em>) – Contains the commandline arguments from script/program call.</td>
    4511512</tr>
    4521513</tbody>
    … …  
    4621523<col class="field-body" />
    4631524<tbody valign="top">
    464 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>envs</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dictionary</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">strings</span></code>) – Contains the ECMWF environment parameternames “ECUID”, “ECGID”,
     1525<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>envs</strong> (<em>dict of str</em>) – Contains the ECMWF environment parameternames “ECUID”, “ECGID”,
    4651526“DESTINATION” and “GATEWAY” with its corresponding values.
    4661527They were read from the file “ECMWF_ENV”.</td>
    … …  
    4801541<col class="field-body" />
    4811542<tbody valign="top">
    482 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>queue</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Name of the queue if submitted to the ECMWF servers.
     1543<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>queue</strong> (<em>str</em>) – Name of the queue if submitted to the ECMWF servers.
    4831544Used to check if ecuid, ecgid, gateway and destination
    4841545are set correctly and are not empty.</td>
    … …  
    4861547</tbody>
    4871548</table>
    488 </dd></dl>
    489 
    490 <dl class="method">
    491 <dt id="ControlFile.ControlFile.check_install_conditions">
    492 <code class="descname">check_install_conditions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ControlFile.html#ControlFile.check_install_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.check_install_conditions" title="Permalink to this definition">¶</a></dt>
    493 <dd><p>Checks a couple of necessary attributes and conditions
    494 for the installation such as if they exist and contain values.
    495 Otherwise set default values.</p>
    4961549</dd></dl>
    4971550
    … …  
    5011554<dd><p>Just generates a list of strings containing the attributes and
    5021555assigned values except the attributes “_expanded”, “exedir”,
    503 “ecmwfdatadir” and “flexpart_root_scripts”.</p>
     1556“flexextractdir” and “flexpartdir”.</p>
    5041557<table class="docutils field-list" frame="void" rules="none">
    5051558<col class="field-name" />
    … …  
    5081561<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>l</strong> – A sorted list of the all ControlFile class attributes with
    5091562their values except the attributes “_expanded”, “exedir”,
    510 “ecmwfdatadir” and “flexpart_root_scripts”.</td>
    511 </tr>
    512 <tr class="field-even 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></td>
     1563“flexextractdir” and “flexpartdir”.</td>
     1564</tr>
     1565<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of *</td>
    5131566</tr>
    5141567</tbody>
    … …  
    5241577<dt id="EcFlexpart.EcFlexpart">
    5251578<em class="property">class </em><code class="descclassname">EcFlexpart.</code><code class="descname">EcFlexpart</code><span class="sig-paren">(</span><em>c</em>, <em>fluxes=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart" title="Permalink to this definition">¶</a></dt>
    526 <dd><p>Class to retrieve FLEXPART specific ECMWF data.</p>
     1579<dd><p>Class to represent FLEXPART specific ECMWF data.</p>
     1580<p>FLEXPART needs grib files in a specifc format. All necessary data fields
     1581for one time step are stored in a single file. The class represents an
     1582instance with all the parameter and settings necessary for retrieving
     1583MARS data and modifing them so they are fitting FLEXPART needs. The class
     1584is able to disaggregate the fluxes and convert grid types to the one needed
     1585by FLEXPART, therefore using the FORTRAN program.</p>
     1586<dl class="attribute">
     1587<dt id="EcFlexpart.EcFlexpart.mreq_count">
     1588<code class="descname">mreq_count</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.mreq_count" title="Permalink to this definition">¶</a></dt>
     1589<dd><p>Counter for the number of generated mars requests.</p>
     1590<table class="docutils field-list" frame="void" rules="none">
     1591<col class="field-name" />
     1592<col class="field-body" />
     1593<tbody valign="top">
     1594<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1595</tr>
     1596</tbody>
     1597</table>
     1598</dd></dl>
     1599
     1600<dl class="attribute">
     1601<dt id="EcFlexpart.EcFlexpart.inputdir">
     1602<code class="descname">inputdir</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.inputdir" title="Permalink to this definition">¶</a></dt>
     1603<dd><p>Path to the directory where the retrieved data is stored.</p>
     1604<table class="docutils field-list" frame="void" rules="none">
     1605<col class="field-name" />
     1606<col class="field-body" />
     1607<tbody valign="top">
     1608<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1609</tr>
     1610</tbody>
     1611</table>
     1612</dd></dl>
     1613
     1614<dl class="attribute">
     1615<dt id="EcFlexpart.EcFlexpart.dataset">
     1616<code class="descname">dataset</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.dataset" title="Permalink to this definition">¶</a></dt>
     1617<dd><p>For public datasets there is the specific naming and parameter
     1618dataset which has to be used to characterize the type of
     1619data.</p>
     1620<table class="docutils field-list" frame="void" rules="none">
     1621<col class="field-name" />
     1622<col class="field-body" />
     1623<tbody valign="top">
     1624<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1625</tr>
     1626</tbody>
     1627</table>
     1628</dd></dl>
     1629
     1630<dl class="attribute">
     1631<dt id="EcFlexpart.EcFlexpart.basetime">
     1632<code class="descname">basetime</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.basetime" title="Permalink to this definition">¶</a></dt>
     1633<dd><p>The time for a half day retrieval. The 12 hours upfront are to be
     1634retrieved.</p>
     1635<table class="docutils field-list" frame="void" rules="none">
     1636<col class="field-name" />
     1637<col class="field-body" />
     1638<tbody valign="top">
     1639<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1640</tr>
     1641</tbody>
     1642</table>
     1643</dd></dl>
     1644
     1645<dl class="attribute">
     1646<dt id="EcFlexpart.EcFlexpart.dtime">
     1647<code class="descname">dtime</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.dtime" title="Permalink to this definition">¶</a></dt>
     1648<dd><p>Time step in hours.</p>
     1649<table class="docutils field-list" frame="void" rules="none">
     1650<col class="field-name" />
     1651<col class="field-body" />
     1652<tbody valign="top">
     1653<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1654</tr>
     1655</tbody>
     1656</table>
     1657</dd></dl>
     1658
     1659<dl class="attribute">
     1660<dt id="EcFlexpart.EcFlexpart.acctype">
     1661<code class="descname">acctype</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.acctype" title="Permalink to this definition">¶</a></dt>
     1662<dd><p>The field type for the accumulated forecast fields.</p>
     1663<table class="docutils field-list" frame="void" rules="none">
     1664<col class="field-name" />
     1665<col class="field-body" />
     1666<tbody valign="top">
     1667<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1668</tr>
     1669</tbody>
     1670</table>
     1671</dd></dl>
     1672
     1673<dl class="attribute">
     1674<dt id="EcFlexpart.EcFlexpart.acctime">
     1675<code class="descname">acctime</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.acctime" title="Permalink to this definition">¶</a></dt>
     1676<dd><p>The starting time from the accumulated forecasts.</p>
     1677<table class="docutils field-list" frame="void" rules="none">
     1678<col class="field-name" />
     1679<col class="field-body" />
     1680<tbody valign="top">
     1681<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1682</tr>
     1683</tbody>
     1684</table>
     1685</dd></dl>
     1686
     1687<dl class="attribute">
     1688<dt id="EcFlexpart.EcFlexpart.accmaxstep">
     1689<code class="descname">accmaxstep</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.accmaxstep" title="Permalink to this definition">¶</a></dt>
     1690<dd><p>The maximum forecast step for the accumulated forecast fields.</p>
     1691<table class="docutils field-list" frame="void" rules="none">
     1692<col class="field-name" />
     1693<col class="field-body" />
     1694<tbody valign="top">
     1695<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1696</tr>
     1697</tbody>
     1698</table>
     1699</dd></dl>
     1700
     1701<dl class="attribute">
     1702<dt id="EcFlexpart.EcFlexpart.marsclass">
     1703<code class="descname">marsclass</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.marsclass" title="Permalink to this definition">¶</a></dt>
     1704<dd><p>Characterisation of dataset.</p>
     1705<table class="docutils field-list" frame="void" rules="none">
     1706<col class="field-name" />
     1707<col class="field-body" />
     1708<tbody valign="top">
     1709<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1710</tr>
     1711</tbody>
     1712</table>
     1713</dd></dl>
     1714
     1715<dl class="attribute">
     1716<dt id="EcFlexpart.EcFlexpart.stream">
     1717<code class="descname">stream</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.stream" title="Permalink to this definition">¶</a></dt>
     1718<dd><p>Identifies the forecasting system used to generate the data.</p>
     1719<table class="docutils field-list" frame="void" rules="none">
     1720<col class="field-name" />
     1721<col class="field-body" />
     1722<tbody valign="top">
     1723<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1724</tr>
     1725</tbody>
     1726</table>
     1727</dd></dl>
     1728
     1729<dl class="attribute">
     1730<dt id="EcFlexpart.EcFlexpart.number">
     1731<code class="descname">number</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.number" title="Permalink to this definition">¶</a></dt>
     1732<dd><p>Selects the member in ensemble forecast run.</p>
     1733<table class="docutils field-list" frame="void" rules="none">
     1734<col class="field-name" />
     1735<col class="field-body" />
     1736<tbody valign="top">
     1737<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1738</tr>
     1739</tbody>
     1740</table>
     1741</dd></dl>
     1742
     1743<dl class="attribute">
     1744<dt id="EcFlexpart.EcFlexpart.resol">
     1745<code class="descname">resol</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.resol" title="Permalink to this definition">¶</a></dt>
     1746<dd><p>Specifies the desired triangular truncation of retrieved data,
     1747before carrying out any other selected post-processing.</p>
     1748<table class="docutils field-list" frame="void" rules="none">
     1749<col class="field-name" />
     1750<col class="field-body" />
     1751<tbody valign="top">
     1752<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1753</tr>
     1754</tbody>
     1755</table>
     1756</dd></dl>
     1757
     1758<dl class="attribute">
     1759<dt id="EcFlexpart.EcFlexpart.accuracy">
     1760<code class="descname">accuracy</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.accuracy" title="Permalink to this definition">¶</a></dt>
     1761<dd><p>Specifies the number of bits per value to be used in the
     1762generated GRIB coded fields.</p>
     1763<table class="docutils field-list" frame="void" rules="none">
     1764<col class="field-name" />
     1765<col class="field-body" />
     1766<tbody valign="top">
     1767<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1768</tr>
     1769</tbody>
     1770</table>
     1771</dd></dl>
     1772
     1773<dl class="attribute">
     1774<dt id="EcFlexpart.EcFlexpart.addpar">
     1775<code class="descname">addpar</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.addpar" title="Permalink to this definition">¶</a></dt>
     1776<dd><p>List of additional parameters to be retrieved.</p>
     1777<table class="docutils field-list" frame="void" rules="none">
     1778<col class="field-name" />
     1779<col class="field-body" />
     1780<tbody valign="top">
     1781<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1782</tr>
     1783</tbody>
     1784</table>
     1785</dd></dl>
     1786
     1787<dl class="attribute">
     1788<dt id="EcFlexpart.EcFlexpart.level">
     1789<code class="descname">level</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.level" title="Permalink to this definition">¶</a></dt>
     1790<dd><p>Specifies the maximum level.</p>
     1791<table class="docutils field-list" frame="void" rules="none">
     1792<col class="field-name" />
     1793<col class="field-body" />
     1794<tbody valign="top">
     1795<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1796</tr>
     1797</tbody>
     1798</table>
     1799</dd></dl>
     1800
     1801<dl class="attribute">
     1802<dt id="EcFlexpart.EcFlexpart.expver">
     1803<code class="descname">expver</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.expver" title="Permalink to this definition">¶</a></dt>
     1804<dd><p>The version of the dataset.</p>
     1805<table class="docutils field-list" frame="void" rules="none">
     1806<col class="field-name" />
     1807<col class="field-body" />
     1808<tbody valign="top">
     1809<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1810</tr>
     1811</tbody>
     1812</table>
     1813</dd></dl>
     1814
     1815<dl class="attribute">
     1816<dt id="EcFlexpart.EcFlexpart.levelist">
     1817<code class="descname">levelist</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.levelist" title="Permalink to this definition">¶</a></dt>
     1818<dd><p>Specifies the required levels.</p>
     1819<table class="docutils field-list" frame="void" rules="none">
     1820<col class="field-name" />
     1821<col class="field-body" />
     1822<tbody valign="top">
     1823<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1824</tr>
     1825</tbody>
     1826</table>
     1827</dd></dl>
     1828
     1829<dl class="attribute">
     1830<dt id="EcFlexpart.EcFlexpart.glevelist">
     1831<code class="descname">glevelist</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.glevelist" title="Permalink to this definition">¶</a></dt>
     1832<dd><p>Specifies the required levels for gaussian grids.</p>
     1833<table class="docutils field-list" frame="void" rules="none">
     1834<col class="field-name" />
     1835<col class="field-body" />
     1836<tbody valign="top">
     1837<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1838</tr>
     1839</tbody>
     1840</table>
     1841</dd></dl>
     1842
     1843<dl class="attribute">
     1844<dt id="EcFlexpart.EcFlexpart.gaussian">
     1845<code class="descname">gaussian</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.gaussian" title="Permalink to this definition">¶</a></dt>
     1846<dd><p>This parameter is deprecated and should no longer be used.
     1847Specifies the desired type of Gaussian grid for the output.</p>
     1848<table class="docutils field-list" frame="void" rules="none">
     1849<col class="field-name" />
     1850<col class="field-body" />
     1851<tbody valign="top">
     1852<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1853</tr>
     1854</tbody>
     1855</table>
     1856</dd></dl>
     1857
     1858<dl class="attribute">
     1859<dt id="EcFlexpart.EcFlexpart.grid">
     1860<code class="descname">grid</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.grid" title="Permalink to this definition">¶</a></dt>
     1861<dd><p>Specifies the output grid which can be either a Gaussian grid
     1862or a Latitude/Longitude grid.</p>
     1863<table class="docutils field-list" frame="void" rules="none">
     1864<col class="field-name" />
     1865<col class="field-body" />
     1866<tbody valign="top">
     1867<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1868</tr>
     1869</tbody>
     1870</table>
     1871</dd></dl>
     1872
     1873<dl class="attribute">
     1874<dt id="EcFlexpart.EcFlexpart.area">
     1875<code class="descname">area</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.area" title="Permalink to this definition">¶</a></dt>
     1876<dd><p>Specifies the desired sub-area of data to be extracted.</p>
     1877<table class="docutils field-list" frame="void" rules="none">
     1878<col class="field-name" />
     1879<col class="field-body" />
     1880<tbody valign="top">
     1881<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1882</tr>
     1883</tbody>
     1884</table>
     1885</dd></dl>
     1886
     1887<dl class="attribute">
     1888<dt id="EcFlexpart.EcFlexpart.purefc">
     1889<code class="descname">purefc</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.purefc" title="Permalink to this definition">¶</a></dt>
     1890<dd><p>Switch for definition of pure forecast mode or not.</p>
     1891<table class="docutils field-list" frame="void" rules="none">
     1892<col class="field-name" />
     1893<col class="field-body" />
     1894<tbody valign="top">
     1895<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1896</tr>
     1897</tbody>
     1898</table>
     1899</dd></dl>
     1900
     1901<dl class="attribute">
     1902<dt id="EcFlexpart.EcFlexpart.outputfilelist">
     1903<code class="descname">outputfilelist</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.outputfilelist" title="Permalink to this definition">¶</a></dt>
     1904<dd><p>The final list of FLEXPART ready input files.</p>
     1905<table class="docutils field-list" frame="void" rules="none">
     1906<col class="field-name" />
     1907<col class="field-body" />
     1908<tbody valign="top">
     1909<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td>
     1910</tr>
     1911</tbody>
     1912</table>
     1913</dd></dl>
     1914
     1915<dl class="attribute">
     1916<dt id="EcFlexpart.EcFlexpart.types">
     1917<code class="descname">types</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.types" title="Permalink to this definition">¶</a></dt>
     1918<dd><p>Determines the combination of type of fields, time and forecast step
     1919to be retrieved.</p>
     1920<table class="docutils field-list" frame="void" rules="none">
     1921<col class="field-name" />
     1922<col class="field-body" />
     1923<tbody valign="top">
     1924<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">dictionary</td>
     1925</tr>
     1926</tbody>
     1927</table>
     1928</dd></dl>
     1929
     1930<dl class="attribute">
     1931<dt id="EcFlexpart.EcFlexpart.params">
     1932<code class="descname">params</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.params" title="Permalink to this definition">¶</a></dt>
     1933<dd><p>Collection of grid types and their corresponding parameters,
     1934levels, level types and the grid definition.</p>
     1935<table class="docutils field-list" frame="void" rules="none">
     1936<col class="field-name" />
     1937<col class="field-body" />
     1938<tbody valign="top">
     1939<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">dictionary</td>
     1940</tr>
     1941</tbody>
     1942</table>
     1943</dd></dl>
     1944
     1945<dl class="attribute">
     1946<dt id="EcFlexpart.EcFlexpart.server">
     1947<code class="descname">server</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.server" title="Permalink to this definition">¶</a></dt>
     1948<dd><p>This is the connection to the ECMWF data servers.</p>
     1949<table class="docutils field-list" frame="void" rules="none">
     1950<col class="field-name" />
     1951<col class="field-body" />
     1952<tbody valign="top">
     1953<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">ECMWFService or ECMWFDataServer</td>
     1954</tr>
     1955</tbody>
     1956</table>
     1957</dd></dl>
     1958
     1959<dl class="attribute">
     1960<dt id="EcFlexpart.EcFlexpart.public">
     1961<code class="descname">public</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.public" title="Permalink to this definition">¶</a></dt>
     1962<dd><p>Decides which Web API Server version is used.</p>
     1963<table class="docutils field-list" frame="void" rules="none">
     1964<col class="field-name" />
     1965<col class="field-body" />
     1966<tbody valign="top">
     1967<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     1968</tr>
     1969</tbody>
     1970</table>
     1971</dd></dl>
     1972
     1973<dl class="attribute">
     1974<dt id="EcFlexpart.EcFlexpart.dates">
     1975<code class="descname">dates</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.dates" title="Permalink to this definition">¶</a></dt>
     1976<dd><p>Contains start and end date of the retrieval in the format
     1977“YYYYMMDD/to/YYYYMMDD”</p>
     1978<table class="docutils field-list" frame="void" rules="none">
     1979<col class="field-name" />
     1980<col class="field-body" />
     1981<tbody valign="top">
     1982<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     1983</tr>
     1984</tbody>
     1985</table>
     1986</dd></dl>
     1987
    5271988<dl class="method">
    5281989<dt id="EcFlexpart.EcFlexpart.create">
    … …  
    5462007<tbody valign="top">
    5472008<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    548 <li><strong>inputfiles</strong> (<a class="reference internal" href="#module-UioFiles" title="UioFiles"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UioFiles</span></code></a>) – Contains a list of files.</li>
    549 <li><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and
     2009<li><strong>inputfiles</strong> (<a class="reference internal" href="#UioFiles.UioFiles" title="UioFiles.UioFiles"><em>UioFiles</em></a>) – Contains a list of files.</li>
     2010<li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
    5502011command line.</li>
    5512012</ul>
    … …  
    5592020<dt id="EcFlexpart.EcFlexpart.deacc_fluxes">
    5602021<code class="descname">deacc_fluxes</code><span class="sig-paren">(</span><em>inputfiles</em>, <em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.deacc_fluxes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.deacc_fluxes" title="Permalink to this definition">¶</a></dt>
    561 <dd><p>Goes through all flux fields in ordered time and de-accumulate
     2022<dd><p>De-accumulate and disaggregate flux data.</p>
     2023<p>Goes through all flux fields in ordered time and de-accumulate
    5622024the fields. Afterwards the fields are disaggregated in time.
    5632025Different versions of disaggregation is provided for rainfall
    … …  
    5692031<tbody valign="top">
    5702032<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    571 <li><strong>inputfiles</strong> (<a class="reference internal" href="#module-UioFiles" title="UioFiles"><code class="xref py py-obj docutils literal notranslate"><span class="pre">UioFiles</span></code></a>) – Contains a list of files.</li>
    572 <li><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and
     2033<li><strong>inputfiles</strong> (<a class="reference internal" href="#UioFiles.UioFiles" title="UioFiles.UioFiles"><em>UioFiles</em></a>) – Contains the list of files that contain flux data.</li>
     2034<li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
    5732035command line.</li>
    5742036</ul>
    … …  
    5872049<col class="field-body" />
    5882050<tbody valign="top">
    589 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and
     2051<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
    5902052command line.</td>
    5912053</tr>
    … …  
    5972059<dt id="EcFlexpart.EcFlexpart.process_output">
    5982060<code class="descname">process_output</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.process_output"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.process_output" title="Permalink to this definition">¶</a></dt>
    599 <dd><p>The grib files are postprocessed depending on the selection in
     2061<dd><p>Postprocessing of FLEXPART input files.</p>
     2062<p>The grib files are postprocessed depending on the selection in
    6002063CONTROL file. The resulting files are moved to the output
    6012064directory if its not equal to the input directory.
    … …  
    6092072<col class="field-body" />
    6102073<tbody valign="top">
    611 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and
     2074<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
    6122075command line.</td>
    6132076</tr>
    … …  
    6272090<tbody valign="top">
    6282091<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    629 <li><strong>server</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">ECMWFService</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">ECMWFDataServer</span></code>) – The connection to the ECMWF server. This is different
     2092<li><strong>server</strong> (<em>ECMWFService</em><em> or </em><em>ECMWFDataServer</em>) – The connection to the ECMWF server. This is different
    6302093for member state users which have full access and non
    6312094member state users which have only access to the public
    … …  
    6332096“public”; for public access its True (ECMWFDataServer)
    6342097for member state users its False (ECMWFService)</li>
    635 <li><strong>dates</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Contains start and end date of the retrieval in the format
     2098<li><strong>dates</strong> (<em>str</em>) – Contains start and end date of the retrieval in the format
    6362099“YYYYMMDD/to/YYYYMMDD”</li>
    637 <li><strong>request</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">integer</span></code>) – Selects the mode of retrieval.
     2100<li><strong>request</strong> (<em>int</em>) – Selects the mode of retrieval.
    63821010: Retrieves the data from ECMWF.
    63921021: Prints the mars requests to an output file.
    64021032: Retrieves the data and prints the mars request.</li>
    641 <li><strong>inputdir</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Path to the directory where the retrieved data is about
     2104<li><strong>inputdir</strong> (<em>str</em><em>, </em><em>optional</em>) – Path to the directory where the retrieved data is about
    6422105to be stored. The default is the current directory (‘.’).</li>
    6432106</ul>
    … …  
    6602123<tbody valign="top">
    6612124<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    662 <li><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and
     2125<li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
    6632126command line.</li>
    664 <li><strong>filename</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Name of the namelist file.</li>
     2127<li><strong>filename</strong> (<em>str</em>) – Name of the namelist file.</li>
    6652128</ul>
    6662129</td>
    … …  
    6732136
    6742137</div>
    675 <div class="section" id="module-GribTools">
    676 <span id="gribtools"></span><h3><a class="toc-backref" href="#id7">GribTools</a><a class="headerlink" href="#module-GribTools" title="Permalink to this headline">¶</a></h3>
     2138<div class="section" id="module-GribUtil">
     2139<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>
    6772140<dl class="class">
    678 <dt id="GribTools.GribTools">
    679 <em class="property">class </em><code class="descclassname">GribTools.</code><code class="descname">GribTools</code><span class="sig-paren">(</span><em>filenames</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribTools.html#GribTools"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribTools.GribTools" title="Permalink to this definition">¶</a></dt>
     2141<dt id="GribUtil.GribUtil">
     2142<em class="property">class </em><code class="descclassname">GribUtil.</code><code class="descname">GribUtil</code><span class="sig-paren">(</span><em>filenames</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribUtil.html#GribUtil"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil" title="Permalink to this definition">¶</a></dt>
    6802143<dd><p>Class for GRIB utilities (new methods) based on GRIB API</p>
    6812144<dl class="method">
    682 <dt id="GribTools.GribTools.copy">
    683 <code class="descname">copy</code><span class="sig-paren">(</span><em>filename_in</em>, <em>selectWhere=True</em>, <em>keynames=[]</em>, <em>keyvalues=[]</em>, <em>filemode='w'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribTools.html#GribTools.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribTools.GribTools.copy" title="Permalink to this definition">¶</a></dt>
     2145<dt id="GribUtil.GribUtil.copy_dummy_msg">
     2146<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='w'</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>
    6842147<dd><p>Add the content of another input grib file to the objects file but
    6852148only messages corresponding to keys/values passed to the function.
    … …  
    6962159function. Default is True.</li>
    6972160<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>
    698 <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 keynames. Default is an empty list.</li>
     2161<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>
    6992162<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 “w”.</li>
    7002163</ul>
    … …  
    7062169
    7072170<dl class="method">
    708 <dt id="GribTools.GribTools.get_keys">
    709 <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/GribTools.html#GribTools.get_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribTools.GribTools.get_keys" title="Permalink to this definition">¶</a></dt>
     2171<dt id="GribUtil.GribUtil.get_keys">
     2172<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>
    7102173<dd><p>Get keyvalues for a given list of keynames a where statement
    7112174can be given (list of key and list of values)</p>
    … …  
    7322195
    7332196<dl class="method">
    734 <dt id="GribTools.GribTools.index">
    735 <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/GribTools.html#GribTools.index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribTools.GribTools.index" title="Permalink to this definition">¶</a></dt>
     2197<dt id="GribUtil.GribUtil.index">
     2198<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>
    7362199<dd><p>Create index file from a list of files if it does not exist or
    7372200read an index file.</p>
    … …  
    7602223
    7612224<dl class="method">
    762 <dt id="GribTools.GribTools.set_keys">
    763 <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='w'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribTools.html#GribTools.set_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribTools.GribTools.set_keys" title="Permalink to this definition">¶</a></dt>
     2225<dt id="GribUtil.GribUtil.set_keys">
     2226<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='w'</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>
    7642227<dd><p>Opens the file to read the grib messages and then write
    765 them to a new output file. By default all messages are
    766 written out. Also, the keyvalues of the passed list of
    767 keynames are set or only those meeting the where statement.
    768 (list of key and list of values).</p>
     2228the selected messages (with wherekeys) to a new output file.
     2229Also, the keyvalues of the passed list of keynames are set.</p>
    7692230<table class="docutils field-list" frame="void" rules="none">
    7702231<col class="field-name" />
    … …  
    7732234<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    7742235<li><strong>fromfile</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>
    775 <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. Default is an empty list.</li>
    776 <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 keynames. Default is an empty list.</li>
    777 <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>
    778 <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>
     2236<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 to set in the selected messages.
     2237Default is an empty list.</li>
     2238<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.
     2239Default is an empty list.</li>
     2240<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.
     2241Default value is an empty list.</li>
     2242<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.
     2243Default value is an empty list.</li>
    7792244<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
    7802245is written out the grib file (False) or only those
    … …  
    7962261<dt id="MarsRetrieval.MarsRetrieval">
    7972262<em class="property">class </em><code class="descclassname">MarsRetrieval.</code><code class="descname">MarsRetrieval</code><span class="sig-paren">(</span><em>server</em>, <em>public</em>, <em>marsclass='ei'</em>, <em>dataset=''</em>, <em>type=''</em>, <em>levtype=''</em>, <em>levelist=''</em>, <em>repres=''</em>, <em>date=''</em>, <em>resol=''</em>, <em>stream=''</em>, <em>area=''</em>, <em>time=''</em>, <em>step=''</em>, <em>expver='1'</em>, <em>number=''</em>, <em>accuracy=''</em>, <em>grid=''</em>, <em>gaussian=''</em>, <em>target=''</em>, <em>param=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MarsRetrieval.html#MarsRetrieval"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval" title="Permalink to this definition">¶</a></dt>
    798 <dd><p>Class for submitting MARS retrievals.</p>
     2263<dd><p>Specific syntax and content for submission of MARS retrievals.</p>
     2264<p>A MARS revtrieval has a specific syntax with a selection of keywords and
     2265their corresponding values. This class provides the necessary functions
     2266by displaying the selected parameters and their values and the actual
     2267retrievement of the data through a mars request or a Python web api
     2268interface. The initialization already expects all the keyword values.</p>
    7992269<p>A description of MARS keywords/arguments and examples of their
    8002270values can be found here:
    8012271<a class="reference external" href="https://software.ecmwf.int/wiki/display/UDOC/">https://software.ecmwf.int/wiki/display/UDOC/</a>                   Identification+keywords#Identificationkeywords-class</p>
     2272<dl class="attribute">
     2273<dt id="MarsRetrieval.MarsRetrieval.server">
     2274<code class="descname">server</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.server" title="Permalink to this definition">¶</a></dt>
     2275<dd><p>This is the connection to the ECMWF data servers.</p>
     2276<table class="docutils field-list" frame="void" rules="none">
     2277<col class="field-name" />
     2278<col class="field-body" />
     2279<tbody valign="top">
     2280<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">ECMWFService or ECMWFDataServer</td>
     2281</tr>
     2282</tbody>
     2283</table>
     2284</dd></dl>
     2285
     2286<dl class="attribute">
     2287<dt id="MarsRetrieval.MarsRetrieval.public">
     2288<code class="descname">public</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.public" title="Permalink to this definition">¶</a></dt>
     2289<dd><p>Decides which Web API Server version is used.</p>
     2290<table class="docutils field-list" frame="void" rules="none">
     2291<col class="field-name" />
     2292<col class="field-body" />
     2293<tbody valign="top">
     2294<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td>
     2295</tr>
     2296</tbody>
     2297</table>
     2298</dd></dl>
     2299
     2300<dl class="attribute">
     2301<dt id="MarsRetrieval.MarsRetrieval.marsclass">
     2302<code class="descname">marsclass</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.marsclass" title="Permalink to this definition">¶</a></dt>
     2303<dd><p>Characterisation of dataset.</p>
     2304<table class="docutils field-list" frame="void" rules="none">
     2305<col class="field-name" />
     2306<col class="field-body" />
     2307<tbody valign="top">
     2308<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2309</tr>
     2310</tbody>
     2311</table>
     2312</dd></dl>
     2313
     2314<dl class="attribute">
     2315<dt id="MarsRetrieval.MarsRetrieval.dataset">
     2316<code class="descname">dataset</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.dataset" title="Permalink to this definition">¶</a></dt>
     2317<dd><p>For public datasets there is the specific naming and parameter
     2318dataset which has to be used to characterize the type of
     2319data.</p>
     2320<table class="docutils field-list" frame="void" rules="none">
     2321<col class="field-name" />
     2322<col class="field-body" />
     2323<tbody valign="top">
     2324<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2325</tr>
     2326</tbody>
     2327</table>
     2328</dd></dl>
     2329
     2330<dl class="attribute">
     2331<dt id="MarsRetrieval.MarsRetrieval.type">
     2332<code class="descname">type</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.type" title="Permalink to this definition">¶</a></dt>
     2333<dd><p>Determines the type of fields to be retrieved.</p>
     2334<table class="docutils field-list" frame="void" rules="none">
     2335<col class="field-name" />
     2336<col class="field-body" />
     2337<tbody valign="top">
     2338<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2339</tr>
     2340</tbody>
     2341</table>
     2342</dd></dl>
     2343
     2344<dl class="attribute">
     2345<dt id="MarsRetrieval.MarsRetrieval.levtype">
     2346<code class="descname">levtype</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.levtype" title="Permalink to this definition">¶</a></dt>
     2347<dd><p>Denotes type of level.</p>
     2348<table class="docutils field-list" frame="void" rules="none">
     2349<col class="field-name" />
     2350<col class="field-body" />
     2351<tbody valign="top">
     2352<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2353</tr>
     2354</tbody>
     2355</table>
     2356</dd></dl>
     2357
     2358<dl class="attribute">
     2359<dt id="MarsRetrieval.MarsRetrieval.levelist">
     2360<code class="descname">levelist</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.levelist" title="Permalink to this definition">¶</a></dt>
     2361<dd><p>Specifies the required levels.</p>
     2362<table class="docutils field-list" frame="void" rules="none">
     2363<col class="field-name" />
     2364<col class="field-body" />
     2365<tbody valign="top">
     2366<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2367</tr>
     2368</tbody>
     2369</table>
     2370</dd></dl>
     2371
     2372<dl class="attribute">
     2373<dt id="MarsRetrieval.MarsRetrieval.repres">
     2374<code class="descname">repres</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.repres" title="Permalink to this definition">¶</a></dt>
     2375<dd><p>Selects the representation of the archived data.</p>
     2376<table class="docutils field-list" frame="void" rules="none">
     2377<col class="field-name" />
     2378<col class="field-body" />
     2379<tbody valign="top">
     2380<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2381</tr>
     2382</tbody>
     2383</table>
     2384</dd></dl>
     2385
     2386<dl class="attribute">
     2387<dt id="MarsRetrieval.MarsRetrieval.date">
     2388<code class="descname">date</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.date" title="Permalink to this definition">¶</a></dt>
     2389<dd><p>Specifies the Analysis date, the Forecast base date or
     2390Observations date.</p>
     2391<table class="docutils field-list" frame="void" rules="none">
     2392<col class="field-name" />
     2393<col class="field-body" />
     2394<tbody valign="top">
     2395<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2396</tr>
     2397</tbody>
     2398</table>
     2399</dd></dl>
     2400
     2401<dl class="attribute">
     2402<dt id="MarsRetrieval.MarsRetrieval.resol">
     2403<code class="descname">resol</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.resol" title="Permalink to this definition">¶</a></dt>
     2404<dd><p>Specifies the desired triangular truncation of retrieved data,
     2405before carrying out any other selected post-processing.</p>
     2406<table class="docutils field-list" frame="void" rules="none">
     2407<col class="field-name" />
     2408<col class="field-body" />
     2409<tbody valign="top">
     2410<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2411</tr>
     2412</tbody>
     2413</table>
     2414</dd></dl>
     2415
     2416<dl class="attribute">
     2417<dt id="MarsRetrieval.MarsRetrieval.stream">
     2418<code class="descname">stream</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.stream" title="Permalink to this definition">¶</a></dt>
     2419<dd><p>Identifies the forecasting system used to generate the data.</p>
     2420<table class="docutils field-list" frame="void" rules="none">
     2421<col class="field-name" />
     2422<col class="field-body" />
     2423<tbody valign="top">
     2424<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2425</tr>
     2426</tbody>
     2427</table>
     2428</dd></dl>
     2429
     2430<dl class="attribute">
     2431<dt id="MarsRetrieval.MarsRetrieval.area">
     2432<code class="descname">area</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.area" title="Permalink to this definition">¶</a></dt>
     2433<dd><p>Specifies the desired sub-area of data to be extracted.</p>
     2434<table class="docutils field-list" frame="void" rules="none">
     2435<col class="field-name" />
     2436<col class="field-body" />
     2437<tbody valign="top">
     2438<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2439</tr>
     2440</tbody>
     2441</table>
     2442</dd></dl>
     2443
     2444<dl class="attribute">
     2445<dt id="MarsRetrieval.MarsRetrieval.time">
     2446<code class="descname">time</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.time" title="Permalink to this definition">¶</a></dt>
     2447<dd><p>Specifies the time of the data in hours and minutes.</p>
     2448<table class="docutils field-list" frame="void" rules="none">
     2449<col class="field-name" />
     2450<col class="field-body" />
     2451<tbody valign="top">
     2452<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2453</tr>
     2454</tbody>
     2455</table>
     2456</dd></dl>
     2457
     2458<dl class="attribute">
     2459<dt id="MarsRetrieval.MarsRetrieval.step">
     2460<code class="descname">step</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.step" title="Permalink to this definition">¶</a></dt>
     2461<dd><p>Specifies the forecast time step from forecast base time.</p>
     2462<table class="docutils field-list" frame="void" rules="none">
     2463<col class="field-name" />
     2464<col class="field-body" />
     2465<tbody valign="top">
     2466<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2467</tr>
     2468</tbody>
     2469</table>
     2470</dd></dl>
     2471
     2472<dl class="attribute">
     2473<dt id="MarsRetrieval.MarsRetrieval.expver">
     2474<code class="descname">expver</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.expver" title="Permalink to this definition">¶</a></dt>
     2475<dd><p>The version of the dataset.</p>
     2476<table class="docutils field-list" frame="void" rules="none">
     2477<col class="field-name" />
     2478<col class="field-body" />
     2479<tbody valign="top">
     2480<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2481</tr>
     2482</tbody>
     2483</table>
     2484</dd></dl>
     2485
     2486<dl class="attribute">
     2487<dt id="MarsRetrieval.MarsRetrieval.number">
     2488<code class="descname">number</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.number" title="Permalink to this definition">¶</a></dt>
     2489<dd><p>Selects the member in ensemble forecast run.</p>
     2490<table class="docutils field-list" frame="void" rules="none">
     2491<col class="field-name" />
     2492<col class="field-body" />
     2493<tbody valign="top">
     2494<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2495</tr>
     2496</tbody>
     2497</table>
     2498</dd></dl>
     2499
     2500<dl class="attribute">
     2501<dt id="MarsRetrieval.MarsRetrieval.accuracy">
     2502<code class="descname">accuracy</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.accuracy" title="Permalink to this definition">¶</a></dt>
     2503<dd><p>Specifies the number of bits per value to be used in the
     2504generated GRIB coded fields.</p>
     2505<table class="docutils field-list" frame="void" rules="none">
     2506<col class="field-name" />
     2507<col class="field-body" />
     2508<tbody valign="top">
     2509<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2510</tr>
     2511</tbody>
     2512</table>
     2513</dd></dl>
     2514
     2515<dl class="attribute">
     2516<dt id="MarsRetrieval.MarsRetrieval.grid">
     2517<code class="descname">grid</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.grid" title="Permalink to this definition">¶</a></dt>
     2518<dd><p>Specifies the output grid which can be either a Gaussian grid
     2519or a Latitude/Longitude grid.</p>
     2520<table class="docutils field-list" frame="void" rules="none">
     2521<col class="field-name" />
     2522<col class="field-body" />
     2523<tbody valign="top">
     2524<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2525</tr>
     2526</tbody>
     2527</table>
     2528</dd></dl>
     2529
     2530<dl class="attribute">
     2531<dt id="MarsRetrieval.MarsRetrieval.gaussian">
     2532<code class="descname">gaussian</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.gaussian" title="Permalink to this definition">¶</a></dt>
     2533<dd><p>This parameter is deprecated and should no longer be used.
     2534Specifies the desired type of Gaussian grid for the output.</p>
     2535<table class="docutils field-list" frame="void" rules="none">
     2536<col class="field-name" />
     2537<col class="field-body" />
     2538<tbody valign="top">
     2539<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2540</tr>
     2541</tbody>
     2542</table>
     2543</dd></dl>
     2544
     2545<dl class="attribute">
     2546<dt id="MarsRetrieval.MarsRetrieval.target">
     2547<code class="descname">target</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.target" title="Permalink to this definition">¶</a></dt>
     2548<dd><p>Specifies a file into which data is to be written after
     2549retrieval or manipulation.</p>
     2550<table class="docutils field-list" frame="void" rules="none">
     2551<col class="field-name" />
     2552<col class="field-body" />
     2553<tbody valign="top">
     2554<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2555</tr>
     2556</tbody>
     2557</table>
     2558</dd></dl>
     2559
     2560<dl class="attribute">
     2561<dt id="MarsRetrieval.MarsRetrieval.param">
     2562<code class="descname">param</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.param" title="Permalink to this definition">¶</a></dt>
     2563<dd><p>Specifies the meteorological parameter.</p>
     2564<table class="docutils field-list" frame="void" rules="none">
     2565<col class="field-name" />
     2566<col class="field-body" />
     2567<tbody valign="top">
     2568<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td>
     2569</tr>
     2570</tbody>
     2571</table>
     2572</dd></dl>
     2573
    8022574<dl class="method">
    8032575<dt id="MarsRetrieval.MarsRetrieval.data_retrieve">
    … …  
    8172589
    8182590<dl class="method">
    819 <dt id="MarsRetrieval.MarsRetrieval.print_info">
    820 <code class="descname">print_info</code><span class="sig-paren">(</span><em>inputdir</em>, <em>request_number</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MarsRetrieval.html#MarsRetrieval.print_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.print_info" title="Permalink to this definition">¶</a></dt>
    821 <dd><p>Prints all mars requests to an extra file for debugging and
    822 information.</p>
    823 <table class="docutils field-list" frame="void" rules="none">
    824 <col class="field-name" />
    825 <col class="field-body" />
    826 <tbody valign="top">
    827 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    828 <li><strong>inputdir</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The path where all data from the retrievals are stored.</li>
    829 <li><strong>request_number</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">integer</span></code>) – Number of mars requests for flux and non-flux data.</li>
    830 </ul>
    831 </td>
    832 </tr>
    833 </tbody>
    834 </table>
    835 </dd></dl>
    836 
    837 <dl class="method">
    8382591<dt id="MarsRetrieval.MarsRetrieval.print_infodata_csv">
    8392592<code class="descname">print_infodata_csv</code><span class="sig-paren">(</span><em>inputdir</em>, <em>request_number</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MarsRetrieval.html#MarsRetrieval.print_infodata_csv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.print_infodata_csv" title="Permalink to this definition">¶</a></dt>
    … …  
    8442597<tbody valign="top">
    8452598<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    846 <li><strong>inputdir</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The path where all data from the retrievals are stored.</li>
    847 <li><strong>request_number</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">integer</span></code>) – Number of mars requests for flux and non-flux data.</li>
     2599<li><strong>inputdir</strong> (<em>str</em>) – The path where all data from the retrievals are stored.</li>
     2600<li><strong>request_number</strong> (<em>int</em>) – Number of mars requests for flux and non-flux data.</li>
    8482601</ul>
    8492602</td>
    … …  
    8612614<dt id="UioFiles.UioFiles">
    8622615<em class="property">class </em><code class="descclassname">UioFiles.</code><code class="descname">UioFiles</code><span class="sig-paren">(</span><em>path</em>, <em>pattern</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/UioFiles.html#UioFiles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#UioFiles.UioFiles" title="Permalink to this definition">¶</a></dt>
    863 <dd><p>Class to manipulate files. At initialisation it has the pattern
    864 which stores a regular expression pattern for the files, the path
    865 to the files and the files already.</p>
     2616<dd><p>Collection of files matching a specific pattern.</p>
     2617<p>The pattern can contain regular expressions for the files.
     2618The files are listed and can be transformed to a single string or
     2619they can be deleted.</p>
     2620<dl class="attribute">
     2621<dt id="UioFiles.UioFiles.path">
     2622<code class="descname">path</code><a class="headerlink" href="#UioFiles.UioFiles.path" title="Permalink to this definition">¶</a></dt>
     2623<dd><p>Directory where to list the files.</p>
     2624<table class="docutils field-list" frame="void" rules="none">
     2625<col class="field-name" />
     2626<col class="field-body" />
     2627<tbody valign="top">
     2628<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     2629</tr>
     2630</tbody>
     2631</table>
     2632</dd></dl>
     2633
     2634<dl class="attribute">
     2635<dt id="UioFiles.UioFiles.pattern">
     2636<code class="descname">pattern</code><a class="headerlink" href="#UioFiles.UioFiles.pattern" title="Permalink to this definition">¶</a></dt>
     2637<dd><p>Regular expression pattern. For example: ‘*.grb’</p>
     2638<table class="docutils field-list" frame="void" rules="none">
     2639<col class="field-name" />
     2640<col class="field-body" />
     2641<tbody valign="top">
     2642<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td>
     2643</tr>
     2644</tbody>
     2645</table>
     2646</dd></dl>
     2647
     2648<dl class="attribute">
     2649<dt id="UioFiles.UioFiles.files">
     2650<code class="descname">files</code><a class="headerlink" href="#UioFiles.UioFiles.files" title="Permalink to this definition">¶</a></dt>
     2651<dd><p>List of files matching the pattern in the path.</p>
     2652<table class="docutils field-list" frame="void" rules="none">
     2653<col class="field-name" />
     2654<col class="field-body" />
     2655<tbody valign="top">
     2656<tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td>
     2657</tr>
     2658</tbody>
     2659</table>
     2660</dd></dl>
     2661
    8662662<dl class="method">
    8672663<dt id="UioFiles.UioFiles.delete_files">
    … …  
    8782674<div class="section" id="module-get_mars_data">
    8792675<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>
     2676<p>This script extracts MARS data from ECMWF servers.</p>
     2677<p>At first, the necessary parameters from command line and CONTROL files are
     2678extracted. They define the data set to be extracted from MARS.</p>
     2679<p>This file can also be imported as a module and contains the following
     2680functions:</p>
     2681<blockquote>
     2682<div><ul class="simple">
     2683<li>main - the main function of the script</li>
     2684<li>get_mars_data - overall control of ECMWF data retrievment</li>
     2685<li>write_reqheader - writes the header into the mars_request file</li>
     2686<li>mk_server - creates the server connection to ECMWF servers</li>
     2687<li>mk_dates - defines the start and end date</li>
     2688<li>remove_old - deletes old retrieved grib files</li>
     2689<li>do_retrievement - creates individual retrievals</li>
     2690</ul>
     2691</div></blockquote>
     2692<p>Type: get_mars_data.py –help
     2693to get information about command line parameters.
     2694Read the documentation for usage instructions.</p>
    8802695<dl class="function">
    8812696<dt id="get_mars_data.do_retrievement">
    … …  
    8882703<tbody valign="top">
    8892704<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    890 <li><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and
     2705<li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
    8912706command line.</li>
    892 <li><strong>server</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">ECMWFService</span></code>) – The server connection to ECMWF.</li>
    893 <li><strong>start</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime</span></code>) – The start date of the retrieval.</li>
    894 <li><strong>end</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime</span></code>) – The end date of the retrieval.</li>
    895 <li><strong>delta_t</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">datetime</span></code>) – Delta_t + 1 is the maximal time period of a single
     2707<li><strong>server</strong> (<em>ECMWFService</em><em> or </em><em>ECMWFDataServer</em>) – The server connection to ECMWF.</li>
     2708<li><strong>start</strong> (<em>datetime</em>) – The start date of the retrieval.</li>
     2709<li><strong>end</strong> (<em>datetime</em>) – The end date of the retrieval.</li>
     2710<li><strong>delta_t</strong> (<em>datetime</em>) – Delta_t + 1 is the maximal time period of a single
    8962711retrieval.</li>
    897 <li><strong>fluxes</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">boolean</span></code>, optional) – Decides if the flux parameters are to be retrieved or
     2712<li><strong>fluxes</strong> (<em>boolean</em><em>, </em><em>optional</em>) – Decides if the flux parameters are to be retrieved or
    8982713the rest of the parameter list.
    8992714Default value is False.</li>
    … …  
    9162731<col class="field-body" />
    9172732<tbody valign="top">
    918 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and
     2733<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
    9192734command line.</td>
    9202735</tr>
    … …  
    9312746</dd></dl>
    9322747
     2748<dl class="function">
     2749<dt id="get_mars_data.mk_dates">
     2750<code class="descclassname">get_mars_data.</code><code class="descname">mk_dates</code><span class="sig-paren">(</span><em>c</em>, <em>fluxes</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#mk_dates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.mk_dates" title="Permalink to this definition">¶</a></dt>
     2751<dd><p>Prepares start and end date depending on flux or non flux data.</p>
     2752<p>If forecast for maximum one day (upto 24h) are to be retrieved, then
     2753collect accumulation data (flux data) with additional days in the
     2754beginning and at the end (used for complete disaggregation of
     2755original period)</p>
     2756<p>If forecast data longer than 24h are to be retrieved, then
     2757collect accumulation data (flux data) with the exact start and end date
     2758(disaggregation will be done for the exact time period with
     2759boundary conditions)</p>
     2760<p>Since for basetime the extraction contains the 12 hours upfront,
     2761if basetime is 0, the starting date has to be the day before and</p>
     2762<table class="docutils field-list" frame="void" rules="none">
     2763<col class="field-name" />
     2764<col class="field-body" />
     2765<tbody valign="top">
     2766<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
     2767<li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
     2768command line.</li>
     2769<li><strong>fluxes</strong> (<em>boolean</em><em>, </em><em>optional</em>) – Decides if the flux parameter settings are stored or
     2770the rest of the parameter list.
     2771Default value is False.</li>
     2772</ul>
     2773</td>
     2774</tr>
     2775<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><ul class="simple">
     2776<li><strong>start</strong> (<em>datetime</em>) – The start date of the retrieving data set.</li>
     2777<li><strong>end</strong> (<em>datetime</em>) – The end date of the retrieving data set.</li>
     2778<li><strong>chunk</strong> (<em>datetime</em>) – Time period in days for one single mars retrieval.</li>
     2779</ul>
     2780</p>
     2781</td>
     2782</tr>
     2783</tbody>
     2784</table>
     2785</dd></dl>
     2786
     2787<dl class="function">
     2788<dt id="get_mars_data.mk_server">
     2789<code class="descclassname">get_mars_data.</code><code class="descname">mk_server</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#mk_server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.mk_server" title="Permalink to this definition">¶</a></dt>
     2790<dd><p>Creates server connection if ECMWF WebAPI is available.</p>
     2791<table class="docutils field-list" frame="void" rules="none">
     2792<col class="field-name" />
     2793<col class="field-body" />
     2794<tbody valign="top">
     2795<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
     2796command line.</td>
     2797</tr>
     2798<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>server</strong> – Connection to ECMWF server via python interface ECMWF WebAPI.</td>
     2799</tr>
     2800<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">ECMWFDataServer or ECMWFService</td>
     2801</tr>
     2802</tbody>
     2803</table>
     2804</dd></dl>
     2805
     2806<dl class="function">
     2807<dt id="get_mars_data.remove_old">
     2808<code class="descclassname">get_mars_data.</code><code class="descname">remove_old</code><span class="sig-paren">(</span><em>pattern</em>, <em>inputdir</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#remove_old"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.remove_old" title="Permalink to this definition">¶</a></dt>
     2809<dd><p>Deletes old retrieval files from current input directory
     2810matching the pattern.</p>
     2811<table class="docutils field-list" frame="void" rules="none">
     2812<col class="field-name" />
     2813<col class="field-body" />
     2814<tbody valign="top">
     2815<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
     2816<li><strong>pattern</strong> (<em>str</em>) – The sub string pattern which identifies the files to be deleted.</li>
     2817<li><strong>inputdir</strong> (<em>str</em><em>, </em><em>optional</em>) – Path to the directory where the retrieved data is stored.</li>
     2818</ul>
     2819</td>
     2820</tr>
     2821</tbody>
     2822</table>
     2823</dd></dl>
     2824
     2825<dl class="function">
     2826<dt id="get_mars_data.write_reqheader">
     2827<code class="descclassname">get_mars_data.</code><code class="descname">write_reqheader</code><span class="sig-paren">(</span><em>marsfile</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#write_reqheader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.write_reqheader" title="Permalink to this definition">¶</a></dt>
     2828<dd><p>Writes header with column names into mars request file.</p>
     2829<table class="docutils field-list" frame="void" rules="none">
     2830<col class="field-name" />
     2831<col class="field-body" />
     2832<tbody valign="top">
     2833<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>marsfile</strong> (<em>str</em>) – Path to the mars request file.</td>
     2834</tr>
     2835</tbody>
     2836</table>
     2837</dd></dl>
     2838
    9332839</div>
    9342840<div class="section" id="module-prepare_flexpart">
    9352841<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>
     2842<p>This script prepares the final version of the grib files which are
     2843then used by FLEXPART.</p>
     2844<p>It converts the bunch of grib files extracted via get_mars_data before,
     2845by doing the necessary conversion to get consistent grids or the
     2846disaggregation of flux data. Finally, the data fields are combined
     2847in files per available hour with the naming convention xxYYMMDDHH,
     2848where xx should be 2 arbitrary letters (mostly xx is chosen to be “EN”).</p>
     2849<p>This file can also be imported as a module which then contains the following
     2850functions:</p>
     2851<blockquote>
     2852<div><ul class="simple">
     2853<li>main</li>
     2854<li>prepare_flexpart</li>
     2855</ul>
     2856</div></blockquote>
     2857<p>Type: prepare_flexpart.py –help
     2858to get information about command line parameters.
     2859Read the documentation for usage instructions.</p>
    9362860<dl class="function">
    9372861<dt id="prepare_flexpart.main">
    … …  
    9552879<tbody valign="top">
    9562880<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    957 <li><strong>ppid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">int</span></code>) – Contains the ppid number of the current ECMWF job. It will be None if
     2881<li><strong>ppid</strong> (<em>int</em>) – Contains the ppid number of the current ECMWF job. It will be None if
    9582882the method was called within this module.</li>
    959 <li><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and
     2883<li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
    9602884command line.</li>
    9612885</ul>
    … …  
    9692893<div class="section" id="module-tools">
    9702894<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>
     2895<p>This module contains a collection of diverse tasks within flex_extract.</p>
    9712896<dl class="function">
    9722897<dt id="tools.clean_up">
    9732898<code class="descclassname">tools.</code><code class="descname">clean_up</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#clean_up"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.clean_up" title="Permalink to this definition">¶</a></dt>
    974 <dd><p>Remove all files from intermediate directory (inputdir).</p>
    975 <table class="docutils field-list" frame="void" rules="none">
    976 <col class="field-name" />
    977 <col class="field-body" />
    978 <tbody valign="top">
    979 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#module-ControlFile" title="ControlFile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ControlFile</span></code></a>) – Contains all the parameters of CONTROL file and
     2899<dd><p>Remove files from the intermediate directory (inputdir).</p>
     2900<p>It keeps the final FLEXPART input files if program runs without
     2901ECMWF Api and keywords “ectrans” or “ecstorage” are set to “1”.</p>
     2902<table class="docutils field-list" frame="void" rules="none">
     2903<col class="field-name" />
     2904<col class="field-body" />
     2905<tbody valign="top">
     2906<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and
    9802907command line.</td>
    9812908</tr>
    … …  
    9852912
    9862913<dl class="function">
    987 <dt id="tools.get_cmdline_arguments">
    988 <code class="descclassname">tools.</code><code class="descname">get_cmdline_arguments</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#get_cmdline_arguments"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_cmdline_arguments" title="Permalink to this definition">¶</a></dt>
     2914<dt id="tools.execute_subprocess">
     2915<code class="descclassname">tools.</code><code class="descname">execute_subprocess</code><span class="sig-paren">(</span><em>cmd_list</em>, <em>error_msg='SUBPROCESS FAILED!'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#execute_subprocess"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.execute_subprocess" title="Permalink to this definition">¶</a></dt>
     2916<dd><p>Executes a command line instruction via a subprocess.</p>
     2917<p>Error handling is done if an error occures.</p>
     2918<table class="docutils field-list" frame="void" rules="none">
     2919<col class="field-name" />
     2920<col class="field-body" />
     2921<tbody valign="top">
     2922<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cmd_list</strong> (<em>list of str</em>) – A list of the components for the command line execution. Each
     2923list entry is a single part of the command which is seperated from
     2924the rest by a blank space.
     2925E.g. [‘mv’, file1, file2]</td>
     2926</tr>
     2927<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>error_msg</strong> – The possible error message if the subprocess failed.
     2928By default it will just tell “SUBPROCESS FAILED!”.</td>
     2929</tr>
     2930<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str, optional</td>
     2931</tr>
     2932</tbody>
     2933</table>
     2934</dd></dl>
     2935
     2936<dl class="function">
     2937<dt id="tools.get_cmdline_args">
     2938<code class="descclassname">tools.</code><code class="descname">get_cmdline_args</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#get_cmdline_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_cmdline_args" title="Permalink to this definition">¶</a></dt>
    9892939<dd><p>Decomposes the command line arguments and assigns them to variables.
    9902940Apply default values for non mentioned arguments.</p>
    … …  
    9952945<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>args</strong> – Contains the commandline arguments from script/program call.</td>
    9962946</tr>
    997 <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Namespace</span></code></td>
     2947<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Namespace</td>
     2948</tr>
     2949</tbody>
     2950</table>
     2951</dd></dl>
     2952
     2953<dl class="function">
     2954<dt id="tools.get_dimensions">
     2955<code class="descclassname">tools.</code><code class="descname">get_dimensions</code><span class="sig-paren">(</span><em>info</em>, <em>purefc</em>, <em>dtime</em>, <em>index_vals</em>, <em>start_date</em>, <em>end_date</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#get_dimensions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_dimensions" title="Permalink to this definition">¶</a></dt>
     2956<dd><p>This function specifies the correct dimensions for x, y and t.</p>
     2957<table class="docutils field-list" frame="void" rules="none">
     2958<col class="field-name" />
     2959<col class="field-body" />
     2960<tbody valign="top">
     2961<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
     2962<li><strong>info</strong> (<em>dict</em>) – Contains basic informations of the ECMWF grib files, e.g.
     2963‘Ni’, ‘Nj’, ‘latitudeOfFirstGridPointInDegrees’,
     2964‘longitudeOfFirstGridPointInDegrees’, ‘latitudeOfLastGridPointInDegrees’,
     2965‘longitudeOfLastGridPointInDegrees’, ‘jDirectionIncrementInDegrees’,
     2966‘iDirectionIncrementInDegrees’, ‘missingValue’</li>
     2967<li><strong>purefc</strong> (<em>int</em>) – Switch for definition of pure forecast mode or not.</li>
     2968<li><strong>dtime</strong> (<em>str</em>) – Time step in hours.</li>
     2969<li><strong>index_vals</strong> (<em>list of list of str</em>) – Contains the values from the keys used for a distinct selection
     2970of grib messages in processing  the grib files.
     2971Content looks like e.g.:
     2972index_vals[0]: (‘20171106’, ‘20171107’, ‘20171108’) ; date
     2973index_vals[1]: (‘0’, ‘1200’, ‘1800’, ‘600’) ; time
     2974index_vals[2]: (‘0’, ‘12’, ‘3’, ‘6’, ‘9’) ; stepRange</li>
     2975<li><strong>start_date</strong> (<em>str</em>) – The start date of the retrieval job.</li>
     2976<li><strong>end_date</strong> (<em>str</em>) – The end date of the retrieval job.</li>
     2977</ul>
     2978</td>
     2979</tr>
     2980<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>(ix, jy, it)</strong> – Dimension in x-direction, y-direction and in time.</p>
     2981</td>
     2982</tr>
     2983<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">tuple of int</p>
     2984</td>
     2985</tr>
     2986</tbody>
     2987</table>
     2988</dd></dl>
     2989
     2990<dl class="function">
     2991<dt id="tools.get_informations">
     2992<code class="descclassname">tools.</code><code class="descname">get_informations</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#get_informations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_informations" title="Permalink to this definition">¶</a></dt>
     2993<dd><p>Gets basic information from an example grib file.</p>
     2994<p>These information are important for later use and the
     2995initialization of numpy arrays for data storing.</p>
     2996<table class="docutils field-list" frame="void" rules="none">
     2997<col class="field-name" />
     2998<col class="field-body" />
     2999<tbody valign="top">
     3000<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>str</em>) – Name of the file which will be opened to extract basic information.</td>
     3001</tr>
     3002<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>data</strong> – Contains basic informations of the ECMWF grib files, e.g.
     3003‘Ni’, ‘Nj’, ‘latitudeOfFirstGridPointInDegrees’,
     3004‘longitudeOfFirstGridPointInDegrees’, ‘latitudeOfLastGridPointInDegrees’,
     3005‘longitudeOfLastGridPointInDegrees’, ‘jDirectionIncrementInDegrees’,
     3006‘iDirectionIncrementInDegrees’, ‘missingValue’</td>
     3007</tr>
     3008<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
    9983009</tr>
    9993010</tbody>
    … …  
    10103021<tbody valign="top">
    10113022<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1012 <li><strong>list_obj</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – A list with arbitrary content.</li>
    1013 <li><strong>concatenate_sign</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – A string which is used to concatenate the single
     3023<li><strong>list_obj</strong> (<em>list of *</em>) – A list with arbitrary content.</li>
     3024<li><strong>concatenate_sign</strong> (<em>str</em><em>, </em><em>optional</em>) – A string which is used to concatenate the single
    10143025list elements. Default value is “, “.</li>
    10153026</ul>
    … …  
    10193030</td>
    10203031</tr>
    1021 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code></p>
     3032<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
    10223033</td>
    10233034</tr>
    … …  
    10343045<col class="field-body" />
    10353046<tbody valign="top">
    1036 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filepath</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Path to file of ECMWF grib table number 128.</td>
     3047<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filepath</strong> (<em>str</em>) – Path to file of ECMWF grib table number 128.</td>
    10373048</tr>
    10383049<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>table128</strong> – Contains the ECMWF grib table 128 information.
    … …  
    10403051short name of the parameter.</td>
    10413052</tr>
    1042 <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">dictionary</span></code></td>
     3053<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
    10433054</tr>
    10443055</tbody>
    … …  
    10493060<dt id="tools.make_dir">
    10503061<code class="descclassname">tools.</code><code class="descname">make_dir</code><span class="sig-paren">(</span><em>directory</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#make_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.make_dir" title="Permalink to this definition">¶</a></dt>
    1051 <dd><p>Creates a directory and gives a warning if the directory
    1052 already exists. The program stops only if there is another problem.</p>
    1053 <table class="docutils field-list" frame="void" rules="none">
    1054 <col class="field-name" />
    1055 <col class="field-body" />
    1056 <tbody valign="top">
    1057 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>directory</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The directory name including the path which should be created.</td>
     3062<dd><p>Creates a directory.</p>
     3063<p>It gives a warning if the directory already exists and skips process.
     3064The program stops only if there is another problem.</p>
     3065<table class="docutils field-list" frame="void" rules="none">
     3066<col class="field-name" />
     3067<col class="field-body" />
     3068<tbody valign="top">
     3069<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>directory</strong> (<em>str</em>) – The path to directory which should be created.</td>
    10583070</tr>
    10593071</tbody>
    … …  
    10713083<tbody valign="top">
    10723084<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    1073 <li><strong>user</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 all email addresses which should be notified.
     3085<li><strong>user</strong> (<em>list of str</em>) – Contains all email addresses which should be notified.
    10743086It might also contain just the ecmwf user name which wil trigger
    10753087mailing to the associated email address for this user.</li>
    1076 <li><strong>message</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Error message. Default value is “ERROR”.</li>
     3088<li><strong>message</strong> (<em>str</em><em>, </em><em>optional</em>) – Error message. Default value is “ERROR”.</li>
    10773089</ul>
    10783090</td>
    … …  
    10913103<col class="field-body" />
    10923104<tbody valign="top">
    1093 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – String to be checked for the “None” word.</td>
     3105<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> (<em>str</em>) – String to be checked for the “None” word.</td>
    10943106</tr>
    10953107<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Return depends on the content of the input value. If it was “None”,
    … …  
    11123124<col class="field-body" />
    11133125<tbody valign="top">
    1114 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – String to be checked for the “None” word.</td>
     3126<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> (<em>str</em>) – String to be checked for the “None” word.</td>
    11153127</tr>
    11163128<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Return depends on the content of the input value. If it was “None”,
    … …  
    11253137<dl class="function">
    11263138<dt id="tools.normal_exit">
    1127 <code class="descclassname">tools.</code><code class="descname">normal_exit</code><span class="sig-paren">(</span><em>users</em>, <em>message='Done!'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#normal_exit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.normal_exit" title="Permalink to this definition">¶</a></dt>
     3139<code class="descclassname">tools.</code><code class="descname">normal_exit</code><span class="sig-paren">(</span><em>message='Done!'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#normal_exit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.normal_exit" title="Permalink to this definition">¶</a></dt>
    11283140<dd><p>Prints a specific exit message which can be passed to the function.</p>
    11293141<table class="docutils field-list" frame="void" rules="none">
    … …  
    11313143<col class="field-body" />
    11323144<tbody valign="top">
    1133 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    1134 <li><strong>user</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 all email addresses which should be notified.
    1135 It might also contain just the ecmwf user name which wil trigger
    1136 mailing to the associated email address for this user.</li>
    1137 <li><strong>message</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Message for exiting program. Default value is “Done!”.</li>
    1138 </ul>
    1139 </td>
     3145<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> (<em>str</em><em>, </em><em>optional</em>) – Message for exiting program. Default value is “Done!”.</td>
    11403146</tr>
    11413147</tbody>
    … …  
    11463152<dt id="tools.product">
    11473153<code class="descclassname">tools.</code><code class="descname">product</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwds</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#product"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.product" title="Permalink to this definition">¶</a></dt>
    1148 <dd><p>This method combines the single characters of the passed arguments
     3154<dd><p>Creates combinations of all passed arguments.</p>
     3155<p>This method combines the single characters of the passed arguments
    11493156with each other. So that each character of each argument value
    11503157will be combined with each character of the other arguments as a tuple.</p>
    … …  
    11623169<tbody valign="top">
    11633170<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1164 <li><strong>*args</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">tuple</span></code>) – Positional arguments (arbitrary number).</li>
    1165 <li><strong>**kwds</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dictionary</span></code>) – Contains all the keyword arguments from *args.</li>
     3171<li><strong>*args</strong> (<em>list</em><em> or </em><em>str</em>) – Positional arguments (arbitrary number).</li>
     3172<li><strong>**kwds</strong> (<em>dict</em>) – Contains all the keyword arguments from *args.</li>
    11663173</ul>
    11673174</td>
    … …  
    11923199<col class="field-body" />
    11933200<tbody valign="top">
    1194 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1195 <li><strong>ecd</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The path were the file is stored.</li>
    1196 <li><strong>filename</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The name of the file to send to the ECMWF server.</li>
    1197 <li><strong>target</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The target queue where the file should be sent to.</li>
    1198 <li><strong>ecuid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The user id on ECMWF server.</li>
    1199 <li><strong>ecgid</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The group id on ECMWF server.</li>
    1200 </ul>
    1201 </td>
    1202 </tr>
    1203 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>rcode</strong> – Resulting code of command execution. If successful the string
    1204 will be empty.</p>
    1205 </td>
    1206 </tr>
    1207 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code></p>
     3201<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
     3202<li><strong>ecd</strong> (<em>str</em>) – The path were the file is stored.</li>
     3203<li><strong>filename</strong> (<em>str</em>) – The name of the file to send to the ECMWF server.</li>
     3204<li><strong>target</strong> (<em>str</em>) – The target queue where the file should be sent to.</li>
     3205<li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li>
     3206<li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li>
     3207</ul>
    12083208</td>
    12093209</tr>
    … …  
    12143214<dl class="function">
    12153215<dt id="tools.read_ecenv">
    1216 <code class="descclassname">tools.</code><code class="descname">read_ecenv</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#read_ecenv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.read_ecenv" title="Permalink to this definition">¶</a></dt>
     3216<code class="descclassname">tools.</code><code class="descname">read_ecenv</code><span class="sig-paren">(</span><em>filepath</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#read_ecenv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.read_ecenv" title="Permalink to this definition">¶</a></dt>
    12173217<dd><p>Reads the file into a dictionary where the key values are the parameter
    12183218names.</p>
    … …  
    12213221<col class="field-body" />
    12223222<tbody valign="top">
    1223 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Path to file where the ECMWF environment parameters are stored.</td>
     3223<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filepath</strong> (<em>str</em>) – Path to file where the ECMWF environment parameters are stored.</td>
    12243224</tr>
    12253225<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>envs</strong> – Contains the environment parameter ecuid, ecgid, gateway
    12263226and destination for ECMWF server environments.</td>
    12273227</tr>
    1228 <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">dictionary</span></code></td>
     3228<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
     3229</tr>
     3230</tbody>
     3231</table>
     3232</dd></dl>
     3233
     3234<dl class="function">
     3235<dt id="tools.send_mail">
     3236<code class="descclassname">tools.</code><code class="descname">send_mail</code><span class="sig-paren">(</span><em>users</em>, <em>success_mode</em>, <em>message</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#send_mail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.send_mail" title="Permalink to this definition">¶</a></dt>
     3237<dd><p>Prints a specific exit message which can be passed to the function.</p>
     3238<table class="docutils field-list" frame="void" rules="none">
     3239<col class="field-name" />
     3240<col class="field-body" />
     3241<tbody valign="top">
     3242<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
     3243<li><strong>users</strong> (<em>list of str</em>) – Contains all email addresses which should be notified.
     3244It might also contain just the ecmwf user name which wil trigger
     3245mailing to the associated email address for this user.</li>
     3246<li><strong>success_mode</strong> (<em>str</em>) – States the exit mode of the program to put into
     3247the mail subject line.</li>
     3248<li><strong>message</strong> (<em>str</em><em>, </em><em>optional</em>) – Message for exiting program. Default value is “Done!”.</li>
     3249</ul>
     3250</td>
    12293251</tr>
    12303252</tbody>
    … …  
    12413263<col class="field-body" />
    12423264<tbody valign="top">
    1243 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The name of the file to be removed without notification.</td>
     3265<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>str</em>) – The name of the file to be removed without notification.</td>
    12443266</tr>
    12453267</tbody>
    … …  
    12623284<tbody valign="top">
    12633285<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1264 <li><strong>target</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The target where the file should be sent to, e.g. the queue.</li>
    1265 <li><strong>jobname</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – The name of the jobfile to be submitted to the ECMWF server.</li>
    1266 </ul>
    1267 </td>
    1268 </tr>
    1269 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>rcode</strong> – Resulting code of command execution. If successful the string
    1270 will contain an integer number, representing the id of the job
    1271 at the ecmwf server.</p>
    1272 </td>
    1273 </tr>
    1274 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code></p>
     3286<li><strong>target</strong> (<em>str</em>) – The target where the file should be sent to, e.g. the queue.</li>
     3287<li><strong>jobname</strong> (<em>str</em>) – The name of the jobfile to be submitted to the ECMWF server.</li>
     3288</ul>
     3289</td>
     3290</tr>
     3291<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>job_id</strong> – The id number of the job as a reference at the ecmwf server.</p>
     3292</td>
     3293</tr>
     3294<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">int</p>
    12753295</td>
    12763296</tr>
    … …  
    12883308<tbody valign="top">
    12893309<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
    1290 <li><strong>pars</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Addpar argument from CONTROL file in the format of
     3310<li><strong>pars</strong> (<em>str</em>) – Addpar argument from CONTROL file in the format of
    12913311parameter names instead of ids. The parameter short
    12923312names are sepearted with “/” and they are passed as
    12933313one single string.</li>
    1294 <li><strong>table</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">dictionary</span></code>) – Contains the ECMWF grib table 128 information.
     3314<li><strong>table</strong> (<em>dict</em>) – Contains the ECMWF grib table 128 information.
    12953315The key is the parameter number and the value is the
    12963316short name of the parameter.</li>
    … …  
    13023322</td>
    13033323</tr>
    1304 <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><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">integer</span></code></p>
     3324<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of int</p>
    13053325</td>
    13063326</tr>
    … …  
    13123332<div class="section" id="module-disaggregation">
    13133333<span id="disaggregation"></span><h3><a class="toc-backref" href="#id14">disaggregation</a><a class="headerlink" href="#module-disaggregation" title="Permalink to this headline">¶</a></h3>
     3334<p>Disaggregation of deaccumulated flux data from an ECMWF model FG field.</p>
     3335<dl class="docutils">
     3336<dt>Initially the flux data to be concerned are:</dt>
     3337<dd><ul class="first last simple">
     3338<li>large-scale precipitation</li>
     3339<li>convective precipitation</li>
     3340<li>surface sensible heat flux</li>
     3341<li>surface solar radiation</li>
     3342<li>u stress</li>
     3343<li>v stress</li>
     3344</ul>
     3345</dd>
     3346</dl>
     3347<p>Different versions of disaggregation is provided for rainfall
     3348data (darain, modified linear) and the surface fluxes and
     3349stress data (dapoly, cubic polynomial).</p>
    13143350<dl class="function">
    13153351<dt id="disaggregation.IA3">
    … …  
    13233359<div class="admonition note">
    13243360<p class="first admonition-title">Note</p>
    1325 <p>Copyright 2017
     3361<p>(C) Copyright 2017-2019
    13263362Sabine Hittmeir, Anne Philipp, Petra Seibert</p>
    13273363<p class="last">This work is licensed under the Creative Commons Attribution 4.0
    … …  
    13343370<col class="field-body" />
    13353371<tbody valign="top">
    1336 <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
     3372<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>g</strong> (<em>list of float</em>) – Complete data series that will be interpolated having
    13373373the dimension of the original raw series.</td>
    13383374</tr>
    … …  
    13413377times three.</td>
    13423378</tr>
    1343 <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>
     3379<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list of float</td>
    13443380</tr>
    13453381</tbody>
    … …  
    13693405<col class="field-body" />
    13703406<tbody valign="top">
    1371 <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.
     3407<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>alist</strong> (<em>list of array of float</em>) – List of 4 timespans as 2-dimensional, horizontal fields.
    13723408E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</td>
    13733409</tr>
    13743410<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>
    13753411</tr>
    1376 <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>
     3412<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">array of float</td>
    13773413</tr>
    13783414</tbody>
    … …  
    14063442<col class="field-body" />
    14073443<tbody valign="top">
    1408 <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.
     3444<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>alist</strong> (<em>list of array of float</em>) – List of 4 timespans as 2-dimensional, horizontal fields.
    14093445E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</td>
    14103446</tr>
    14113447<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>
    14123448</tr>
    1413 <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>
     3449<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">array of float</td>
    14143450</tr>
    14153451</tbody>
    … …  
    14523488  <div role="contentinfo">
    14533489    <p>
    1454         &copy; Copyright 2018, Anne Philipp and Leopold Haimberger.
     3490        &copy; Copyright 2018, Anne Philipp and Leopold Haimberger
    14553491
    14563492    </p>
    … …  
    14713507 
    14723508
    1473     <script type="text/javascript">
    1474         var DOCUMENTATION_OPTIONS = {
    1475             URL_ROOT:'./',
    1476             VERSION:'7.1 alpha',
    1477             LANGUAGE:'None',
    1478             COLLAPSE_INDEX:false,
    1479             FILE_SUFFIX:'.html',
    1480             HAS_SOURCE:  true,
    1481             SOURCELINK_SUFFIX: '.txt'
    1482         };
    1483     </script>
    1484       <script type="text/javascript" src="_static/jquery.js"></script>
    1485       <script type="text/javascript" src="_static/underscore.js"></script>
    1486       <script type="text/javascript" src="_static/doctools.js"></script>
    1487       <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
     3509   
     3510   
     3511      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
     3512        <script type="text/javascript" src="_static/jquery.js"></script>
     3513        <script type="text/javascript" src="_static/underscore.js"></script>
     3514        <script type="text/javascript" src="_static/doctools.js"></script>
     3515   
    14883516
    14893517 
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG