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


Ignore:
Timestamp:
Mar 8, 2019, 10:00:34 AM (5 years ago)
Author:
Anne Philipp <anne.philipp@…>
Branches:
master, ctbto, dev
Children:
b4a4777
Parents:
8778c5a
Message:

deleted jobscripts for tracking and updated Sphinx doc

File:
1 edited

Legend:

Unmodified
Added
Removed
  • documentation/Sphinx/build/html/api.html

    r2625ca8 rf66f990  
    523523<dt id="ControlFile.ControlFile.controlfile">
    524524<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
     525<dd><p><em>str</em> – The name of the control file to be processed. Default value is the
    526526filename 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>
    535527</dd></dl>
    536528
     
    538530<dt id="ControlFile.ControlFile.start_date">
    539531<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>
     532<dd><p><em>str</em> – The first day of the retrieval period. Default value is None.</p>
    549533</dd></dl>
    550534
     
    552536<dt id="ControlFile.ControlFile.end_date">
    553537<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>
     538<dd><p><em>str</em> – The last day of the retrieval period. Default value is None.</p>
    563539</dd></dl>
    564540
     
    566542<dt id="ControlFile.ControlFile.date_chunk">
    567543<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>
     544<dd><p><em>int</em> – Length of period for a single mars retrieval. Default value is 3.</p>
    577545</dd></dl>
    578546
     
    580548<dt id="ControlFile.ControlFile.dtime">
    581549<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>
     550<dd><p><em>str</em> – The time step in hours. Default value is None.</p>
    591551</dd></dl>
    592552
     
    594554<dt id="ControlFile.ControlFile.basetime">
    595555<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
     556<dd><p><em>int</em> – The time for a half day retrieval. The 12 hours upfront are to be
    597557retrieved. 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>
    606558</dd></dl>
    607559
     
    609561<dt id="ControlFile.ControlFile.maxstep">
    610562<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>
     563<dd><p><em>int</em> – The maximum forecast step for non flux data. Default value is None.</p>
    620564</dd></dl>
    621565
     
    623567<dt id="ControlFile.ControlFile.type">
    624568<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>
     569<dd><p><em>list of str</em> – List of field type per retrieving hour. Default value is None.</p>
    634570</dd></dl>
    635571
     
    637573<dt id="ControlFile.ControlFile.time">
    638574<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>
     575<dd><p><em>list of str</em> – List of retrieving times in hours. Default valuer is None.</p>
    648576</dd></dl>
    649577
     
    651579<dt id="ControlFile.ControlFile.step">
    652580<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.
     581<dd><p><em>list of str or str</em> – List of forecast time steps in hours for non flux data.
    654582Default 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>
    663583</dd></dl>
    664584
     
    666586<dt id="ControlFile.ControlFile.acctype">
    667587<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.
     588<dd><p><em>str</em> – The field type for the accumulated forecast fields.
    669589Default 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>
    678590</dd></dl>
    679591
     
    681593<dt id="ControlFile.ControlFile.acctime">
    682594<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>
     595<dd><p><em>str</em> – The starting time of the accumulated forecasts. Default value is None.</p>
    692596</dd></dl>
    693597
     
    695599<dt id="ControlFile.ControlFile.accmaxstep">
    696600<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
     601<dd><p><em>int</em> – The maximum forecast step for the accumulated forecast fields
    698602(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>
    707603</dd></dl>
    708604
     
    710606<dt id="ControlFile.ControlFile.marsclass">
    711607<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>
     608<dd><p><em>str</em> – Characterisation of dataset. Default value is None.</p>
    721609</dd></dl>
    722610
     
    724612<dt id="ControlFile.ControlFile.dataset">
    725613<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
     614<dd><p><em>str</em> – For public datasets there is the specific naming and parameter
    727615dataset which has to be used to characterize the type of
    728616data. 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>
    737617</dd></dl>
    738618
     
    740620<dt id="ControlFile.ControlFile.stream">
    741621<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.
     622<dd><p><em>str</em> – Identifies the forecasting system used to generate the data.
    743623Default 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>
    752624</dd></dl>
    753625
     
    755627<dt id="ControlFile.ControlFile.number">
    756628<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>
     629<dd><p><em>str</em> – Selects the member in ensemble forecast run. Default value is ‘OFF’.</p>
    766630</dd></dl>
    767631
     
    769633<dt id="ControlFile.ControlFile.expver">
    770634<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>
     635<dd><p><em>str</em> – The version number of the dataset. Default value is ‘1’.</p>
    780636</dd></dl>
    781637
     
    783639<dt id="ControlFile.ControlFile.gaussian">
    784640<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.
     641<dd><p><em>str</em> – This parameter is deprecated and should no longer be used.
    786642Specifies the desired type of Gaussian grid for the output.
    787643Default 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>
    796644</dd></dl>
    797645
     
    799647<dt id="ControlFile.ControlFile.grid">
    800648<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
     649<dd><p><em>str</em> – Specifies the output grid which can be either a Gaussian grid
    802650or 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>
    811651</dd></dl>
    812652
     
    814654<dt id="ControlFile.ControlFile.area">
    815655<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.
     656<dd><p><em>str</em> – Specifies the desired sub-area of data to be extracted.
    817657Default 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>
    826658</dd></dl>
    827659
     
    829661<dt id="ControlFile.ControlFile.left">
    830662<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.
     663<dd><p><em>str</em> – The western most longitude of the area to be extracted.
    832664Default 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>
    841665</dd></dl>
    842666
     
    844668<dt id="ControlFile.ControlFile.lower">
    845669<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.
     670<dd><p><em>str</em> – The southern most latitude of the area to be extracted.
    847671Default 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>
    856672</dd></dl>
    857673
     
    859675<dt id="ControlFile.ControlFile.upper">
    860676<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.
     677<dd><p><em>str</em> – The northern most latitued of the area to be extracted.
    862678Default 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>
    871679</dd></dl>
    872680
     
    874682<dt id="ControlFile.ControlFile.right">
    875683<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.
     684<dd><p><em>str</em> – The eastern most longitude of the area to be extracted.
    877685Default 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>
    886686</dd></dl>
    887687
     
    889689<dt id="ControlFile.ControlFile.level">
    890690<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>
     691<dd><p><em>str</em> – Specifies the maximum level. Default value is None.</p>
    900692</dd></dl>
    901693
     
    903695<dt id="ControlFile.ControlFile.levelist">
    904696<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>
     697<dd><p><em>str</em> – Specifies the required level list. Default value is None.</p>
    914698</dd></dl>
    915699
     
    917701<dt id="ControlFile.ControlFile.resol">
    918702<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,
     703<dd><p><em>str</em> – Specifies the desired triangular truncation of retrieved data,
    920704before carrying out any other selected post-processing.
    921705Default 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>
    930706</dd></dl>
    931707
     
    933709<dt id="ControlFile.ControlFile.gauss">
    934710<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).
     711<dd><p><em>int</em> – Switch to select gaussian fields (1) or regular lat/lon (0).
    936712Default 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>
    945713</dd></dl>
    946714
     
    948716<dt id="ControlFile.ControlFile.accuracy">
    949717<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
     718<dd><p><em>int</em> – Specifies the number of bits per value to be used in the
    951719generated 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>
    960720</dd></dl>
    961721
     
    963723<dt id="ControlFile.ControlFile.omega">
    964724<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>
     725<dd><p><em>int</em> – Switch to select omega retrieval (1) or not (0). Default value is 0.</p>
    974726</dd></dl>
    975727
     
    977729<dt id="ControlFile.ControlFile.omegadiff">
    978730<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
     731<dd><p><em>int</em> – Switch to decide to calculate Omega and Dps/Dt from continuity
    980732equation 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>
    989733</dd></dl>
    990734
     
    992736<dt id="ControlFile.ControlFile.eta">
    993737<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
     738<dd><p><em>int</em> – Switch to select direct retrieval of etadot from MARS (1) or
    995739wether 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>
    1004740</dd></dl>
    1005741
     
    1007743<dt id="ControlFile.ControlFile.etadiff">
    1008744<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
     745<dd><p><em>int</em> – Switch to select calculation of etadot and Dps/Dt from continuity
    1010746equation 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>
    1019747</dd></dl>
    1020748
     
    1022750<dt id="ControlFile.ControlFile.etapar">
    1023751<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>
     752<dd><p><em>int</em> – GRIB parameter Id for etadot fields. Default value is 77.</p>
    1033753</dd></dl>
    1034754
     
    1036756<dt id="ControlFile.ControlFile.dpdeta">
    1037757<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.
     758<dd><p><em>int</em> – Switch to select multiplication of etadot with dpdeta.
    1039759Default 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>
    1048760</dd></dl>
    1049761
     
    1051763<dt id="ControlFile.ControlFile.smooth">
    1052764<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.
     765<dd><p><em>int</em> – Spectral truncation of ETADOT after calculation on Gaussian grid.
    1054766Default 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>
    1063767</dd></dl>
    1064768
     
    1066770<dt id="ControlFile.ControlFile.format">
    1067771<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>
     772<dd><p><em>str</em> – The format of the GRIB data. Default value is ‘GRIB1’.</p>
    1077773</dd></dl>
    1078774
     
    1080776<dt id="ControlFile.ControlFile.addpar">
    1081777<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.
     778<dd><p><em>str</em> – List of additional surface level ECMWF parameter to be retrieved.
    1083779Default 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>
    1092780</dd></dl>
    1093781
     
    1095783<dt id="ControlFile.ControlFile.prefix">
    1096784<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.
     785<dd><p><em>str</em> – Prefix string for the final FLEXPART/FLEXTRA ready input files.
    1098786Default 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>
    1107787</dd></dl>
    1108788
     
    1110790<dt id="ControlFile.ControlFile.cwc">
    1111791<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
     792<dd><p><em>int</em> – Switch to select wether the sum of cloud liquid water content and
    1113793cloud 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>
    1122794</dd></dl>
    1123795
     
    1125797<dt id="ControlFile.ControlFile.wrf">
    1126798<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
     799<dd><p><em>int</em> – Switch to select further parameters for retrievment to support
    1128800WRF 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>
    1137801</dd></dl>
    1138802
     
    1140804<dt id="ControlFile.ControlFile.ecfsdir">
    1141805<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>
     806<dd><p><em>str</em> – Path to the ECMWF storage  ‘ectmp:/${USER}/econdemand/’</p>
    1151807</dd></dl>
    1152808
     
    1154810<dt id="ControlFile.ControlFile.mailfail">
    1155811<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.
     812<dd><p><em>list of str</em> – Email list for sending error log files from ECMWF servers.
    1157813The email addresses should be seperated by a comma.
    1158814Default 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>
    1167815</dd></dl>
    1168816
     
    1170818<dt id="ControlFile.ControlFile.mailops">
    1171819<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.
     820<dd><p><em>list of str</em> – Email list for sending operational log files from ECMWF servers.
    1173821The email addresses should be seperated by a comma.
    1174822Default 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>
    1183823</dd></dl>
    1184824
     
    1186826<dt id="ControlFile.ControlFile.grib2flexpart">
    1187827<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”.
     828<dd><p><em>int 0</em> – Switch to select generation of preprocessed FLEXPART files “.fp”.
    1189829If it is selected, the program grib2flexpart will try
    1190830to 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>
    1199831</dd></dl>
    1200832
     
    1202834<dt id="ControlFile.ControlFile.ecstorage">
    1203835<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
     836<dd><p><em>int</em> – Switch to select storage of FLEXPART ready output files
    1205837in 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>
    1214838</dd></dl>
    1215839
     
    1217841<dt id="ControlFile.ControlFile.ectrans">
    1218842<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
     843<dd><p><em>int</em> – Switch to select the transfer of FLEXPART ready output files
    1220844to 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>
    1229845</dd></dl>
    1230846
     
    1232848<dt id="ControlFile.ControlFile.inputdir">
    1233849<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
     850<dd><p><em>str</em> – Path to the temporary directory for the retrieval grib files and
    1235851other 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>
    1244852</dd></dl>
    1245853
     
    1247855<dt id="ControlFile.ControlFile.outputdir">
    1248856<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
     857<dd><p><em>str</em> – Path to the final directory where the final FLEXPART ready input
    1250858files 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>
    1259859</dd></dl>
    1260860
     
    1262862<dt id="ControlFile.ControlFile.flexextractdir">
    1263863<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
     864<dd><p><em>str</em> – Path to the flex_extract root directory. Default value is
    1265865_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>
    1274866</dd></dl>
    1275867
     
    1277869<dt id="ControlFile.ControlFile.exedir">
    1278870<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
     871<dd><p><em>str</em> – Path to the FORTRAN executable file. Default value is
    1280872_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>
    1289873</dd></dl>
    1290874
     
    1292876<dt id="ControlFile.ControlFile.flexpartdir">
    1293877<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>
     878<dd><p><em>str</em> – Path to a FLEXPART root directory. Default value is None.</p>
    1303879</dd></dl>
    1304880
     
    1306882<dt id="ControlFile.ControlFile.makefile">
    1307883<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.
     884<dd><p><em>str</em> – Name of the makefile to be used for the Fortran program.
    1309885Default 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>
    1318886</dd></dl>
    1319887
     
    1321889<dt id="ControlFile.ControlFile.destination">
    1322890<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
     891<dd><p><em>str</em> – The remote destination which is used to transfer files
    1324892from 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>
    1333893</dd></dl>
    1334894
     
    1336896<dt id="ControlFile.ControlFile.gateway">
    1337897<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>
     898<dd><p><em>str</em> – The gateway server the user is using. Default value is None.</p>
    1347899</dd></dl>
    1348900
     
    1350902<dt id="ControlFile.ControlFile.ecuid">
    1351903<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>
     904<dd><p><em>str</em> – The user id on ECMWF server. Default value is None.</p>
    1361905</dd></dl>
    1362906
     
    1364908<dt id="ControlFile.ControlFile.ecgid">
    1365909<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>
     910<dd><p><em>str</em> – The group id on ECMWF server. Default value is None.</p>
    1375911</dd></dl>
    1376912
     
    1378914<dt id="ControlFile.ControlFile.install_target">
    1379915<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.
     916<dd><p><em>str</em> – Defines the location where the installation is to be done.
    1381917Default 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>
    1390918</dd></dl>
    1391919
     
    1393921<dt id="ControlFile.ControlFile.debug">
    1394922<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
     923<dd><p><em>int</em> – Switch to keep temporary files at the end of postprocessing (1) or
    1396924to delete all temporary files except the final output files (0).
    1397925Default 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>
     926</dd></dl>
     927
     928<dl class="attribute">
     929<dt id="ControlFile.ControlFile.oper">
     930<code class="descname">oper</code><a class="headerlink" href="#ControlFile.ControlFile.oper" title="Permalink to this definition">¶</a></dt>
     931<dd><p><em>int</em> – Switch to prepare the operational job script. Start date, end date and
     932basetime will be prepared with environment variables.
     933Default value is 0.</p>
    1406934</dd></dl>
    1407935
     
    1409937<dt id="ControlFile.ControlFile.request">
    1410938<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
     939<dd><p><em>int</em> – Switch to select between just retrieving the data (0), writing the mars
    1412940parameter values to a csv file (1) or doing both (2).
    1413941Default 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>
    1422942</dd></dl>
    1423943
     
    1425945<dt id="ControlFile.ControlFile.public">
    1426946<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
     947<dd><p><em>int</em> – Switch to select kind of ECMWF Web Api access and the
    1428948possible data sets. Public data sets (1) and Memberstate data sets (0).
    1429949Default 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.
     950</dd></dl>
     951
     952<dl class="attribute">
     953<dt id="ControlFile.ControlFile.ec_api">
     954<code class="descname">ec_api</code><a class="headerlink" href="#ControlFile.ControlFile.ec_api" title="Permalink to this definition">¶</a></dt>
     955<dd><p><em>boolean</em> – Tells wether the ECMWF Web API was able to load or not.
    1444956Default 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>
     957</dd></dl>
     958
     959<dl class="attribute">
     960<dt id="ControlFile.ControlFile.cds_api">
     961<code class="descname">cds_api</code><a class="headerlink" href="#ControlFile.ControlFile.cds_api" title="Permalink to this definition">¶</a></dt>
     962<dd><p><em>boolean</em> – Tells wether the CDS API was able to load or not.
     963Default value is None.</p>
    1453964</dd></dl>
    1454965
     
    1456967<dt id="ControlFile.ControlFile.purefc">
    1457968<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
     969<dd><p><em>int</em> – Switch to decide wether the job is a pure forecast retrieval or
    1459970coupled 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>
    1468971</dd></dl>
    1469972
     
    1471974<dt id="ControlFile.ControlFile.rrint">
    1472975<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)
     976<dd><p><em>int</em> – Switch to select between old precipitation disaggregation method (0)
    1474977or 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>
    1483978</dd></dl>
    1484979
     
    1486981<dt id="ControlFile.ControlFile.logicals">
    1487982<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
     983<dd><p><em>list of str</em> – List of the names of logical switches which controls the flow
    1489984of the program. Default list is [‘gauss’, ‘omega’, ‘omegadiff’, ‘eta’,
    1490985‘etadiff’, ‘dpdeta’, ‘cwc’, ‘wrf’, ‘grib2flexpart’, ‘ecstorage’,
    1491986‘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>
    1500987</dd></dl>
    1501988
     
    15871074<dt id="EcFlexpart.EcFlexpart.mreq_count">
    15881075<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>
     1076<dd><p><em>int</em> – Counter for the number of generated mars requests.</p>
    15981077</dd></dl>
    15991078
     
    16011080<dt id="EcFlexpart.EcFlexpart.inputdir">
    16021081<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>
     1082<dd><p><em>str</em> – Path to the directory where the retrieved data is stored.</p>
    16121083</dd></dl>
    16131084
     
    16151086<dt id="EcFlexpart.EcFlexpart.dataset">
    16161087<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
     1088<dd><p><em>str</em> – For public datasets there is the specific naming and parameter
    16181089dataset which has to be used to characterize the type of
    16191090data.</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>
    16281091</dd></dl>
    16291092
     
    16311094<dt id="EcFlexpart.EcFlexpart.basetime">
    16321095<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
     1096<dd><p><em>int</em> – The time for a half day retrieval. The 12 hours upfront are to be
    16341097retrieved.</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>
    16431098</dd></dl>
    16441099
     
    16461101<dt id="EcFlexpart.EcFlexpart.dtime">
    16471102<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>
     1103<dd><p><em>str</em> – Time step in hours.</p>
    16571104</dd></dl>
    16581105
     
    16601107<dt id="EcFlexpart.EcFlexpart.acctype">
    16611108<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>
     1109<dd><p><em>str</em> – The field type for the accumulated forecast fields.</p>
    16711110</dd></dl>
    16721111
     
    16741113<dt id="EcFlexpart.EcFlexpart.acctime">
    16751114<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>
     1115<dd><p><em>str</em> – The starting time from the accumulated forecasts.</p>
    16851116</dd></dl>
    16861117
     
    16881119<dt id="EcFlexpart.EcFlexpart.accmaxstep">
    16891120<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>
     1121<dd><p><em>str</em> – The maximum forecast step for the accumulated forecast fields.</p>
    16991122</dd></dl>
    17001123
     
    17021125<dt id="EcFlexpart.EcFlexpart.marsclass">
    17031126<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>
     1127<dd><p><em>str</em> – Characterisation of dataset.</p>
    17131128</dd></dl>
    17141129
     
    17161131<dt id="EcFlexpart.EcFlexpart.stream">
    17171132<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>
     1133<dd><p><em>str</em> – Identifies the forecasting system used to generate the data.</p>
    17271134</dd></dl>
    17281135
     
    17301137<dt id="EcFlexpart.EcFlexpart.number">
    17311138<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>
     1139<dd><p><em>str</em> – Selects the member in ensemble forecast run.</p>
    17411140</dd></dl>
    17421141
     
    17441143<dt id="EcFlexpart.EcFlexpart.resol">
    17451144<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,
     1145<dd><p><em>str</em> – Specifies the desired triangular truncation of retrieved data,
    17471146before 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>
    17561147</dd></dl>
    17571148
     
    17591150<dt id="EcFlexpart.EcFlexpart.accuracy">
    17601151<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
     1152<dd><p><em>str</em> – Specifies the number of bits per value to be used in the
    17621153generated 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>
    17711154</dd></dl>
    17721155
     
    17741157<dt id="EcFlexpart.EcFlexpart.addpar">
    17751158<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>
     1159<dd><p><em>str</em> – List of additional parameters to be retrieved.</p>
    17851160</dd></dl>
    17861161
     
    17881163<dt id="EcFlexpart.EcFlexpart.level">
    17891164<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>
     1165<dd><p><em>str</em> – Specifies the maximum level.</p>
    17991166</dd></dl>
    18001167
     
    18021169<dt id="EcFlexpart.EcFlexpart.expver">
    18031170<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>
     1171<dd><p><em>str</em> – The version of the dataset.</p>
    18131172</dd></dl>
    18141173
     
    18161175<dt id="EcFlexpart.EcFlexpart.levelist">
    18171176<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>
     1177<dd><p><em>str</em> – Specifies the required levels.</p>
    18271178</dd></dl>
    18281179
     
    18301181<dt id="EcFlexpart.EcFlexpart.glevelist">
    18311182<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>
     1183<dd><p><em>str</em> – Specifies the required levels for gaussian grids.</p>
    18411184</dd></dl>
    18421185
     
    18441187<dt id="EcFlexpart.EcFlexpart.gaussian">
    18451188<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.
     1189<dd><p><em>str</em> – This parameter is deprecated and should no longer be used.
    18471190Specifies 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>
    18561191</dd></dl>
    18571192
     
    18591194<dt id="EcFlexpart.EcFlexpart.grid">
    18601195<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
     1196<dd><p><em>str</em> – Specifies the output grid which can be either a Gaussian grid
    18621197or 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>
    18711198</dd></dl>
    18721199
     
    18741201<dt id="EcFlexpart.EcFlexpart.area">
    18751202<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>
     1203<dd><p><em>str</em> – Specifies the desired sub-area of data to be extracted.</p>
    18851204</dd></dl>
    18861205
     
    18881207<dt id="EcFlexpart.EcFlexpart.purefc">
    18891208<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>
     1209<dd><p><em>int</em> – Switch for definition of pure forecast mode or not.</p>
    18991210</dd></dl>
    19001211
     
    19021213<dt id="EcFlexpart.EcFlexpart.outputfilelist">
    19031214<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>
     1215<dd><p><em>list of str</em> – The final list of FLEXPART ready input files.</p>
    19131216</dd></dl>
    19141217
     
    19161219<dt id="EcFlexpart.EcFlexpart.types">
    19171220<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
     1221<dd><p><em>dictionary</em> – Determines the combination of type of fields, time and forecast step
    19191222to 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>
    19281223</dd></dl>
    19291224
     
    19311226<dt id="EcFlexpart.EcFlexpart.params">
    19321227<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,
     1228<dd><p><em>dictionary</em> – Collection of grid types and their corresponding parameters,
    19341229levels, 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>
    19431230</dd></dl>
    19441231
     
    19461233<dt id="EcFlexpart.EcFlexpart.server">
    19471234<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>
     1235<dd><p><em>ECMWFService or ECMWFDataServer</em> – This is the connection to the ECMWF data servers.</p>
    19571236</dd></dl>
    19581237
     
    19601239<dt id="EcFlexpart.EcFlexpart.public">
    19611240<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>
     1241<dd><p><em>int</em> – Decides which Web API Server version is used.</p>
    19711242</dd></dl>
    19721243
     
    19741245<dt id="EcFlexpart.EcFlexpart.dates">
    19751246<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
     1247<dd><p><em>str</em> – Contains start and end date of the retrieval in the format
    19771248“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>
     1249</dd></dl>
     1250
     1251<dl class="method">
     1252<dt id="EcFlexpart.EcFlexpart.calc_extra_elda">
     1253<code class="descname">calc_extra_elda</code><span class="sig-paren">(</span><em>path</em>, <em>prefix</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.calc_extra_elda"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.calc_extra_elda" title="Permalink to this definition">¶</a></dt>
     1254<dd><p>Calculates extra ensemble members for ELDA - Stream.</p>
     1255<table class="docutils field-list" frame="void" rules="none">
     1256<col class="field-name" />
     1257<col class="field-body" />
     1258<tbody valign="top">
     1259<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
     1260<li><strong>path</strong> (<em>str</em>) – Path to the output files.</li>
     1261<li><strong>prefix</strong> (<em>str</em>) – The prefix of the output filenames as defined in Control file.</li>
     1262</ul>
     1263</td>
    19831264</tr>
    19841265</tbody>
     
    22601541<dl class="class">
    22611542<dt id="MarsRetrieval.MarsRetrieval">
    2262 <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>
     1543<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='EA'</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>
    22631544<dd><p>Specific syntax and content for submission of MARS retrievals.</p>
    22641545<p>A MARS revtrieval has a specific syntax with a selection of keywords and
     
    22731554<dt id="MarsRetrieval.MarsRetrieval.server">
    22741555<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>
     1556<dd><p><em>ECMWFService or ECMWFDataServer</em> – This is the connection to the ECMWF data servers.</p>
    22841557</dd></dl>
    22851558
     
    22871560<dt id="MarsRetrieval.MarsRetrieval.public">
    22881561<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>
     1562<dd><p><em>int</em> – Decides which Web API Server version is used.</p>
    22981563</dd></dl>
    22991564
     
    23011566<dt id="MarsRetrieval.MarsRetrieval.marsclass">
    23021567<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>
     1568<dd><p><em>str, optional</em> – Characterisation of dataset.</p>
    23121569</dd></dl>
    23131570
     
    23151572<dt id="MarsRetrieval.MarsRetrieval.dataset">
    23161573<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
     1574<dd><p><em>str, optional</em> – For public datasets there is the specific naming and parameter
    23181575dataset which has to be used to characterize the type of
    23191576data.</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>
    23281577</dd></dl>
    23291578
     
    23311580<dt id="MarsRetrieval.MarsRetrieval.type">
    23321581<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>
     1582<dd><p><em>str, optional</em> – Determines the type of fields to be retrieved.</p>
    23421583</dd></dl>
    23431584
     
    23451586<dt id="MarsRetrieval.MarsRetrieval.levtype">
    23461587<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>
     1588<dd><p><em>str, optional</em> – Denotes type of level.</p>
    23561589</dd></dl>
    23571590
     
    23591592<dt id="MarsRetrieval.MarsRetrieval.levelist">
    23601593<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>
     1594<dd><p><em>str, optional</em> – Specifies the required levels.</p>
    23701595</dd></dl>
    23711596
     
    23731598<dt id="MarsRetrieval.MarsRetrieval.repres">
    23741599<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>
     1600<dd><p><em>str, optional</em> – Selects the representation of the archived data.</p>
    23841601</dd></dl>
    23851602
     
    23871604<dt id="MarsRetrieval.MarsRetrieval.date">
    23881605<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
     1606<dd><p><em>str, optional</em> – Specifies the Analysis date, the Forecast base date or
    23901607Observations 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>
    23991608</dd></dl>
    24001609
     
    24021611<dt id="MarsRetrieval.MarsRetrieval.resol">
    24031612<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,
     1613<dd><p><em>str, optional</em> – Specifies the desired triangular truncation of retrieved data,
    24051614before 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>
    24141615</dd></dl>
    24151616
     
    24171618<dt id="MarsRetrieval.MarsRetrieval.stream">
    24181619<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>
     1620<dd><p><em>str, optional</em> – Identifies the forecasting system used to generate the data.</p>
    24281621</dd></dl>
    24291622
     
    24311624<dt id="MarsRetrieval.MarsRetrieval.area">
    24321625<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>
     1626<dd><p><em>str, optional</em> – Specifies the desired sub-area of data to be extracted.</p>
    24421627</dd></dl>
    24431628
     
    24451630<dt id="MarsRetrieval.MarsRetrieval.time">
    24461631<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>
     1632<dd><p><em>str, optional</em> – Specifies the time of the data in hours and minutes.</p>
    24561633</dd></dl>
    24571634
     
    24591636<dt id="MarsRetrieval.MarsRetrieval.step">
    24601637<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>
     1638<dd><p><em>str, optional</em> – Specifies the forecast time step from forecast base time.</p>
    24701639</dd></dl>
    24711640
     
    24731642<dt id="MarsRetrieval.MarsRetrieval.expver">
    24741643<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>
     1644<dd><p><em>str, optional</em> – The version of the dataset.</p>
    24841645</dd></dl>
    24851646
     
    24871648<dt id="MarsRetrieval.MarsRetrieval.number">
    24881649<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>
     1650<dd><p><em>str, optional</em> – Selects the member in ensemble forecast run.</p>
    24981651</dd></dl>
    24991652
     
    25011654<dt id="MarsRetrieval.MarsRetrieval.accuracy">
    25021655<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
     1656<dd><p><em>str, optional</em> – Specifies the number of bits per value to be used in the
    25041657generated 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>
    25131658</dd></dl>
    25141659
     
    25161661<dt id="MarsRetrieval.MarsRetrieval.grid">
    25171662<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
     1663<dd><p><em>str, optional</em> – Specifies the output grid which can be either a Gaussian grid
    25191664or 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>
    25281665</dd></dl>
    25291666
     
    25311668<dt id="MarsRetrieval.MarsRetrieval.gaussian">
    25321669<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.
     1670<dd><p><em>str, optional</em> – This parameter is deprecated and should no longer be used.
    25341671Specifies 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>
    25431672</dd></dl>
    25441673
     
    25461675<dt id="MarsRetrieval.MarsRetrieval.target">
    25471676<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
     1677<dd><p><em>str, optional</em> – Specifies a file into which data is to be written after
    25491678retrieval 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>
    25581679</dd></dl>
    25591680
     
    25611682<dt id="MarsRetrieval.MarsRetrieval.param">
    25621683<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>
     1684<dd><p><em>str, optional</em> – Specifies the meteorological parameter.</p>
    25721685</dd></dl>
    25731686
     
    25761689<code class="descname">data_retrieve</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/MarsRetrieval.html#MarsRetrieval.data_retrieve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.data_retrieve" title="Permalink to this definition">¶</a></dt>
    25771690<dd><p>Submits a MARS retrieval. Depending on the existence of
    2578 ECMWF Web-API it is submitted via Python or a
     1691ECMWF Web-API or CDS API it is submitted via Python or a
    25791692subprocess in the Shell. The parameter for the mars retrieval
    25801693are taken from the defined class attributes.</p>
     
    26211734<dt id="UioFiles.UioFiles.path">
    26221735<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>
     1736<dd><p><em>str</em> – Directory where to list the files.</p>
    26321737</dd></dl>
    26331738
     
    26351740<dt id="UioFiles.UioFiles.pattern">
    26361741<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>
     1742<dd><p><em>str</em> – Regular expression pattern. For example: ‘*.grb’</p>
    26461743</dd></dl>
    26471744
     
    26491746<dt id="UioFiles.UioFiles.files">
    26501747<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>
     1748<dd><p><em>list of str</em> – List of files matching the pattern in the path.</p>
    26601749</dd></dl>
    26611750
     
    26941783Read the documentation for usage instructions.</p>
    26951784<dl class="function">
     1785<dt id="get_mars_data.check_dates_for_nonflux_fc_times">
     1786<code class="descclassname">get_mars_data.</code><code class="descname">check_dates_for_nonflux_fc_times</code><span class="sig-paren">(</span><em>types</em>, <em>times</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#check_dates_for_nonflux_fc_times"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.check_dates_for_nonflux_fc_times" title="Permalink to this definition">¶</a></dt>
     1787<dd></dd></dl>
     1788
     1789<dl class="function">
    26961790<dt id="get_mars_data.do_retrievement">
    26971791<code class="descclassname">get_mars_data.</code><code class="descname">do_retrievement</code><span class="sig-paren">(</span><em>c</em>, <em>server</em>, <em>start</em>, <em>end</em>, <em>delta_t</em>, <em>fluxes=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#do_retrievement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.do_retrievement" title="Permalink to this definition">¶</a></dt>
     
    27881882<dt id="get_mars_data.mk_server">
    27891883<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>
     1884<dd><p>Creates a server connection with available python API.</p>
     1885<p>Which API is used depends on availability and the dataset to be retrieved.
     1886The CDS API is used for ERA5 dataset no matter if the user is a member or
     1887a public user. ECMWF WebAPI is used for all other available datasets.</p>
    27911888<table class="docutils field-list" frame="void" rules="none">
    27921889<col class="field-name" />
     
    27961893command line.</td>
    27971894</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>
     1895<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 or CDS API.</td>
     1896</tr>
     1897<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">ECMWFDataServer, ECMWFService or Client</td>
    28011898</tr>
    28021899</tbody>
     
    30752172<dl class="function">
    30762173<dt id="tools.my_error">
    3077 <code class="descclassname">tools.</code><code class="descname">my_error</code><span class="sig-paren">(</span><em>users</em>, <em>message='ERROR'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#my_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.my_error" title="Permalink to this definition">¶</a></dt>
     2174<code class="descclassname">tools.</code><code class="descname">my_error</code><span class="sig-paren">(</span><em>message='ERROR'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#my_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.my_error" title="Permalink to this definition">¶</a></dt>
    30782175<dd><p>Prints a specified error message which can be passed to the function
    30792176before exiting the program.</p>
     
    30822179<col class="field-body" />
    30832180<tbody valign="top">
    3084 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    3085 <li><strong>user</strong> (<em>list of str</em>) – Contains all email addresses which should be notified.
    3086 It might also contain just the ecmwf user name which wil trigger
    3087 mailing to the associated email address for this user.</li>
    3088 <li><strong>message</strong> (<em>str</em><em>, </em><em>optional</em>) – Error message. Default value is “ERROR”.</li>
    3089 </ul>
    3090 </td>
     2181<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>) – Error message. Default value is “ERROR”.</td>
    30912182</tr>
    30922183</tbody>
     
    32552346
    32562347<dl class="function">
     2348<dt id="tools.setup_controldata">
     2349<code class="descclassname">tools.</code><code class="descname">setup_controldata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#setup_controldata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.setup_controldata" title="Permalink to this definition">¶</a></dt>
     2350<dd><p>Collects, stores and checks controlling arguments from command line,
     2351CONTROL file and ECMWF_ENV file.</p>
     2352<table class="docutils field-list" frame="void" rules="none">
     2353<col class="field-name" />
     2354<col class="field-body" />
     2355<tbody valign="top">
     2356<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><ul class="simple">
     2357<li><strong>c</strong> (<em>ControlFile</em>) – Contains all the parameters of CONTROL file and
     2358command line.</li>
     2359<li><strong>ppid</strong> (<em>str</em>) – Parent process id.</li>
     2360<li><strong>queue</strong> (<em>str</em>) – Name of queue for submission to ECMWF (e.g. ecgate or cca )</li>
     2361<li><strong>job_template</strong> (<em>str</em>) – Name of the job template file for submission to ECMWF server.</li>
     2362</ul>
     2363</td>
     2364</tr>
     2365</tbody>
     2366</table>
     2367</dd></dl>
     2368
     2369<dl class="function">
    32572370<dt id="tools.silent_remove">
    32582371<code class="descclassname">tools.</code><code class="descname">silent_remove</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#silent_remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.silent_remove" title="Permalink to this definition">¶</a></dt>
     
    33232436</tr>
    33242437<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of int</p>
     2438</td>
     2439</tr>
     2440</tbody>
     2441</table>
     2442</dd></dl>
     2443
     2444<dl class="function">
     2445<dt id="tools.to_param_id_with_tablenumber">
     2446<code class="descclassname">tools.</code><code class="descname">to_param_id_with_tablenumber</code><span class="sig-paren">(</span><em>pars</em>, <em>table</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#to_param_id_with_tablenumber"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.to_param_id_with_tablenumber" title="Permalink to this definition">¶</a></dt>
     2447<dd><p>Transform parameter names to parameter ids and add table id.</p>
     2448<p>Conversion with ECMWF grib table 128.</p>
     2449<table class="docutils field-list" frame="void" rules="none">
     2450<col class="field-name" />
     2451<col class="field-body" />
     2452<tbody valign="top">
     2453<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
     2454<li><strong>pars</strong> (<em>str</em>) – Addpar argument from CONTROL file in the format of
     2455parameter names instead of ids. The parameter short
     2456names are sepearted with “/” and they are passed as
     2457one single string.</li>
     2458<li><strong>table</strong> (<em>dict</em>) – Contains the ECMWF grib table 128 information.
     2459The key is the parameter number and the value is the
     2460short name of the parameter.</li>
     2461</ul>
     2462</td>
     2463</tr>
     2464<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>spar</strong> – List of addpar parameters from CONTROL file transformed to
     2465parameter ids in the format of integer.</p>
     2466</td>
     2467</tr>
     2468<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
    33252469</td>
    33262470</tr>
     
    34882632  <div role="contentinfo">
    34892633    <p>
    3490         &copy; Copyright 2018, Anne Philipp and Leopold Haimberger
     2634        &copy; Copyright 2018, Anne Philipp and Leopold Haimberger.
    34912635
    34922636    </p>
     
    35072651 
    35082652
    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    
     2653    <script type="text/javascript">
     2654        var DOCUMENTATION_OPTIONS = {
     2655            URL_ROOT:'./',
     2656            VERSION:'7.1 alpha',
     2657            LANGUAGE:'None',
     2658            COLLAPSE_INDEX:false,
     2659            FILE_SUFFIX:'.html',
     2660            HAS_SOURCE:  true,
     2661            SOURCELINK_SUFFIX: '.txt'
     2662        };
     2663    </script>
     2664      <script type="text/javascript" src="_static/jquery.js"></script>
     2665      <script type="text/javascript" src="_static/underscore.js"></script>
     2666      <script type="text/javascript" src="_static/doctools.js"></script>
     2667      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
    35162668
    35172669 
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG