source: flex_extract.git/Documentation/html/Documentation/Input/control_params.html @ 6931f61

ctbtodev
Last change on this file since 6931f61 was 6931f61, checked in by anphi <anne.philipp@…>, 4 years ago

Update Onlinedocumentation after review of language editing

  • Property mode set to 100644
File size: 38.3 KB
Line 
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7  <meta charset="utf-8">
8 
9  <meta name="viewport" content="width=device-width, initial-scale=1.0">
10 
11  <title>The CONTROL parameters &mdash; flex_extract 7.1.2 documentation</title>
12 
13
14 
15 
16 
17 
18
19 
20  <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
21 
22   
23      <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
24        <script src="../../_static/jquery.js"></script>
25        <script src="../../_static/underscore.js"></script>
26        <script src="../../_static/doctools.js"></script>
27        <script src="../../_static/language_data.js"></script>
28        <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
29   
30    <script type="text/javascript" src="../../_static/js/theme.js"></script>
31
32   
33
34 
35  <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
36  <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
37  <link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" />
38  <link rel="stylesheet" href="../../_static/css/theme_overrides.css" type="text/css" />
39    <link rel="index" title="Index" href="../../genindex.html" />
40    <link rel="search" title="Search" href="../../search.html" />
41    <link rel="next" title="CONTROL file examples" href="examples.html" />
42    <link rel="prev" title="The CONTROL file" href="control.html" /> 
43</head>
44
45<body class="wy-body-for-nav">
46
47   
48  <div class="wy-grid-for-nav">
49   
50    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
51      <div class="wy-side-scroll">
52        <div class="wy-side-nav-search" >
53         
54
55         
56            <a href="../../index.html" class="icon icon-home"> flex_extract
57         
58
59         
60          </a>
61
62         
63           
64           
65              <div class="version">
66                7.1.2
67              </div>
68           
69         
70
71         
72<div role="search">
73  <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
74    <input type="text" name="q" placeholder="Search docs" />
75    <input type="hidden" name="check_keywords" value="yes" />
76    <input type="hidden" name="area" value="default" />
77  </form>
78</div>
79
80         
81        </div>
82
83        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
84         
85           
86           
87             
88           
89           
90              <p class="caption"><span class="caption-text">Table of Contents:</span></p>
91<ul class="current">
92<li class="toctree-l1"><a class="reference internal" href="../../ecmwf_data.html">ECMWF Data</a></li>
93<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
94<li class="toctree-l1"><a class="reference internal" href="../../quick_start.html">Usage</a></li>
95<li class="toctree-l1 current"><a class="reference internal" href="../../documentation.html">Code-Level Documentation</a><ul class="current">
96<li class="toctree-l2"><a class="reference internal" href="../overview.html">Overview</a></li>
97<li class="toctree-l2 current"><a class="reference internal" href="../input.html">Control &amp; input data</a><ul class="current">
98<li class="toctree-l3"><a class="reference internal" href="setup.html">The installation script - <code class="docutils literal notranslate"><span class="pre">setup.sh</span></code></a></li>
99<li class="toctree-l3"><a class="reference internal" href="compilejob.html">The compilation job script <code class="docutils literal notranslate"><span class="pre">compilejob.ksh</span></code></a></li>
100<li class="toctree-l3"><a class="reference internal" href="fortran_makefile.html">The Fortran makefile for <code class="docutils literal notranslate"><span class="pre">calc_etadot</span></code></a></li>
101<li class="toctree-l3"><a class="reference internal" href="run.html">The executable script - <code class="docutils literal notranslate"><span class="pre">run.sh</span></code></a></li>
102<li class="toctree-l3"><a class="reference internal" href="jobscript.html">The job script <code class="docutils literal notranslate"><span class="pre">job.ksh</span></code></a></li>
103<li class="toctree-l3"><a class="reference internal" href="control.html">The CONTROL file</a></li>
104<li class="toctree-l3 current"><a class="current reference internal" href="#">The CONTROL parameters</a><ul>
105<li class="toctree-l4"><a class="reference internal" href="#user-section">User Section</a></li>
106<li class="toctree-l4"><a class="reference internal" href="#general-section">General Section</a></li>
107<li class="toctree-l4"><a class="reference internal" href="#time-section">Time Section</a></li>
108<li class="toctree-l4"><a class="reference internal" href="#data-section">Data Section</a></li>
109<li class="toctree-l4"><a class="reference internal" href="#data-field-section">Data field Section</a></li>
110<li class="toctree-l4"><a class="reference internal" href="#flux-data-section">Flux data Section</a></li>
111<li class="toctree-l4"><a class="reference internal" href="#domain-section">Domain Section</a></li>
112<li class="toctree-l4"><a class="reference internal" href="#vertical-wind-section">Vertical wind Section</a></li>
113<li class="toctree-l4"><a class="reference internal" href="#additional-data-section">Additional data Section</a></li>
114</ul>
115</li>
116<li class="toctree-l3"><a class="reference internal" href="examples.html">CONTROL file examples</a></li>
117<li class="toctree-l3"><a class="reference internal" href="changes.html">CONTROL file changes</a></li>
118<li class="toctree-l3"><a class="reference internal" href="ecmwf_env.html">ECMWF user credential file <code class="docutils literal notranslate"><span class="pre">ECMWF_ENV</span></code></a></li>
119<li class="toctree-l3"><a class="reference internal" href="templates.html">Templates</a></li>
120</ul>
121</li>
122<li class="toctree-l2"><a class="reference internal" href="../output.html">Output data</a></li>
123<li class="toctree-l2"><a class="reference internal" href="../disagg.html">Disaggregation of flux data</a></li>
124<li class="toctree-l2"><a class="reference internal" href="../vertco.html">Vertical wind</a></li>
125<li class="toctree-l2"><a class="reference internal" href="../api.html">Auto-generated documentation</a></li>
126</ul>
127</li>
128<li class="toctree-l1"><a class="reference internal" href="../../evaluation.html">Evaluation</a></li>
129<li class="toctree-l1"><a class="reference internal" href="../../dev_guide.html">Developer Guide</a></li>
130<li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changelog</a></li>
131<li class="toctree-l1"><a class="reference internal" href="../../support.html">Support</a></li>
132<li class="toctree-l1"><a class="reference internal" href="../../Support/faq.html">FAQ - Frequently asked questions</a></li>
133<li class="toctree-l1"><a class="reference internal" href="../../authors.html">Developer Team</a></li>
134</ul>
135
136           
137         
138        </div>
139      </div>
140    </nav>
141
142    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
143
144     
145      <nav class="wy-nav-top" aria-label="top navigation">
146       
147          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
148          <a href="../../index.html">flex_extract</a>
149       
150      </nav>
151
152
153      <div class="wy-nav-content">
154       
155        <div class="rst-content">
156       
157         
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173<div role="navigation" aria-label="breadcrumbs navigation">
174
175  <ul class="wy-breadcrumbs">
176   
177      <li><a href="../../index.html">Docs</a> &raquo;</li>
178       
179          <li><a href="../../documentation.html">Code-Level Documentation</a> &raquo;</li>
180       
181          <li><a href="../input.html">Control &amp; input data</a> &raquo;</li>
182       
183      <li>The CONTROL parameters</li>
184   
185   
186      <li class="wy-breadcrumbs-aside">
187       
188           
189            <a href="../../_sources/Documentation/Input/control_params.rst.txt" rel="nofollow"> View page source</a>
190         
191       
192      </li>
193   
194  </ul>
195
196 
197  <hr/>
198</div>
199          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
200           <div itemprop="articleBody">
201           
202  <div class="section" id="the-control-parameters">
203<h1>The CONTROL parameters<a class="headerlink" href="#the-control-parameters" title="Permalink to this headline"></a></h1>
204<div class="section" id="user-section">
205<span id="ref-control-user"></span><h2>User Section<a class="headerlink" href="#user-section" title="Permalink to this headline"></a></h2>
206<table class="docutils align-default" id="id1">
207<caption><span class="caption-text">User parameters in CONTROL file</span><a class="headerlink" href="#id1" title="Permalink to this table"></a></caption>
208<colgroup>
209<col style="width: 18%" />
210<col style="width: 10%" />
211<col style="width: 15%" />
212<col style="width: 9%" />
213<col style="width: 16%" />
214<col style="width: 32%" />
215</colgroup>
216<thead>
217<tr class="row-odd"><th class="head"><p>PARAMETER</p></th>
218<th class="head"><p>Format</p></th>
219<th class="head"><p>Possible value range</p></th>
220<th class="head"><p>Default</p></th>
221<th class="head"><p>Description</p></th>
222<th class="head"><p>Information / Conditions</p></th>
223</tr>
224</thead>
225<tbody>
226<tr class="row-even"><td><p>ECUID</p></td>
227<td><p>String</p></td>
228<td><p></p></td>
229<td><p>None</p></td>
230<td><p></p></td>
231<td><p></p></td>
232</tr>
233<tr class="row-odd"><td><p>ECGID</p></td>
234<td><p>String</p></td>
235<td><p></p></td>
236<td><p>None</p></td>
237<td><p></p></td>
238<td><p></p></td>
239</tr>
240<tr class="row-even"><td><p>DESTINATION</p></td>
241<td><p>String</p></td>
242<td><p>&lt;name&gt;&#64; generic&lt;scope&gt;</p></td>
243<td><p>None</p></td>
244<td><p>The remote destination which is used to transfer files from ECMWF server to local gateway server. </p></td>
245<td><p>This has to be set up by the user on the local gateway server. See installation instruction for more information of how to set it up.</p></td>
246</tr>
247<tr class="row-odd"><td><p>GATEWAY</p></td>
248<td><p>String</p></td>
249<td><p>server address</p></td>
250<td><p>None</p></td>
251<td><p>The gateway server the user is using.</p></td>
252<td><p></p></td>
253</tr>
254</tbody>
255</table>
256</div>
257<div class="section" id="general-section">
258<span id="ref-control-general"></span><h2>General Section<a class="headerlink" href="#general-section" title="Permalink to this headline"></a></h2>
259<table class="docutils align-default" id="id2">
260<caption><span class="caption-text">General parameters in CONTROL file</span><a class="headerlink" href="#id2" title="Permalink to this table"></a></caption>
261<colgroup>
262<col style="width: 13%" />
263<col style="width: 7%" />
264<col style="width: 9%" />
265<col style="width: 9%" />
266<col style="width: 25%" />
267<col style="width: 36%" />
268</colgroup>
269<thead>
270<tr class="row-odd"><th class="head"><p>PARAMETER</p></th>
271<th class="head"><p>Format</p></th>
272<th class="head"><p>Possible value range</p></th>
273<th class="head"><p>Default</p></th>
274<th class="head"><p>Description</p></th>
275<th class="head"><p>Information / Conditions</p></th>
276</tr>
277</thead>
278<tbody>
279<tr class="row-even"><td><p>DEBUG</p></td>
280<td><p>Integer</p></td>
281<td><p>0;1</p></td>
282<td><p>0</p></td>
283<td><p>If set to “1” all temporary output files from the mars requests are kept and some extra information is written out to the log file.</p></td>
284<td><p>Usually all temporary files except the FLEXPART ready output files are deleted at the end of flex_extract.</p></td>
285</tr>
286<tr class="row-odd"><td><p>REQUEST</p></td>
287<td><p>Integer</p></td>
288<td><p>0;1;2</p></td>
289<td><p>2</p></td>
290<td><p>This parameter allows to write out the mars requests in a seperate file.</p></td>
291<td><p>The requests are stored in the file “mars_requests.csv”.
292Possible selections are:
2930: normal data retrievement;
2941: neglect data retrievement and just writes out the mars requests;
2952: retrieve data and write out the mars requests.</p></td>
296</tr>
297<tr class="row-even"><td><p>PUBLIC</p></td>
298<td><p>Integer</p></td>
299<td><p>0;1</p></td>
300<td><p>0</p></td>
301<td><p>This specifies the selection of the kind of ECMWF Web Api access and therefore the kind of available datasets. Public data sets (1) and Memberstate data sets (0).</p></td>
302<td><p>Selecting the public access method, the DATASET parameter has explicitly to be set to select the dataset. (CLASS is not enough.) ATTENTION: For public datasets, the user has to accept the license of the dataset to be retrieved. See here for available datasets and their licenses:  https://software.ecmwf.int/wiki/display/WEBAPI/ Available+ECMWF+ Public+Datasets</p></td>
303</tr>
304<tr class="row-odd"><td><p>OPER</p></td>
305<td><p>Integer</p></td>
306<td><p>0;1</p></td>
307<td><p>0</p></td>
308<td><p>Switch to prepare the operational job script. Start date, end date and basetime will be prepared with environment variables at ecgate.</p></td>
309<td><p>This is only necessary if extraction of half-day retrievals should be done automatically. Specific extra feature which is usually not used by normal flex_extract users.</p></td>
310</tr>
311<tr class="row-even"><td><p>ECSTORAGE</p></td>
312<td><p>Integer</p></td>
313<td><p>0;1</p></td>
314<td><p>0</p></td>
315<td><p>Switch to store FLEXPART ready output files in the ECFS file system.</p></td>
316<td><p>Mind the data limit.</p></td>
317</tr>
318<tr class="row-odd"><td><p>ECTRANS</p></td>
319<td><p>Integer</p></td>
320<td><p>0;1</p></td>
321<td><p>0</p></td>
322<td><p>Switch to transfer FLEXPART ready input files to the gateway server.</p></td>
323<td><p>The gateway server has to be up and running. A destination has to be installed. See installation instructions for more information.</p></td>
324</tr>
325<tr class="row-even"><td><p>PREFIX</p></td>
326<td><p>String</p></td>
327<td><p>anything</p></td>
328<td><p>EN</p></td>
329<td><p>Prefix of FLEXPART ready input files</p></td>
330<td><p>The output files usually have the format &lt;PREFIX&gt;YYMMDDHH. Sometimes it also has some more information, e.g. to distinguish between numbers or in pure forecast mode.</p></td>
331</tr>
332<tr class="row-odd"><td><p>ECFSDIR</p></td>
333<td><p>String</p></td>
334<td><p>any path available</p></td>
335<td><p>ectmp:/${USER}/econdemand/</p></td>
336<td><p>The destination directory on ECFS file system if the retrieved data should be stored on ECMWF servers. This is only used if parameter ECSTORAGE is set to “1”.</p></td>
337<td><p></p></td>
338</tr>
339<tr class="row-even"><td><p>MAILOPS</p></td>
340<td><p>list of String [m1, m2, …]</p></td>
341<td><p>any number of mail addresses, seperated by comma</p></td>
342<td><p>${USER}</p></td>
343<td><p>Email list for operational log files on ECMWF servers. The email addresses should be seperated by a comma.</p></td>
344<td><p>For the ECMWF server it is enough to give ${USER} as input. On local system an actual email is prefered to operate correctly. </p></td>
345</tr>
346</tbody>
347</table>
348</div>
349<div class="section" id="time-section">
350<span id="ref-control-time"></span><h2>Time Section<a class="headerlink" href="#time-section" title="Permalink to this headline"></a></h2>
351<table class="docutils align-default" id="id3">
352<caption><span class="caption-text">Time parameters in CONTROL file</span><a class="headerlink" href="#id3" title="Permalink to this table"></a></caption>
353<colgroup>
354<col style="width: 15%" />
355<col style="width: 8%" />
356<col style="width: 12%" />
357<col style="width: 8%" />
358<col style="width: 28%" />
359<col style="width: 28%" />
360</colgroup>
361<thead>
362<tr class="row-odd"><th class="head"><p>PARAMETER</p></th>
363<th class="head"><p>Format</p></th>
364<th class="head"><p>Possible value range</p></th>
365<th class="head"><p>Default</p></th>
366<th class="head"><p>Description</p></th>
367<th class="head"><p>Information / Conditions</p></th>
368</tr>
369</thead>
370<tbody>
371<tr class="row-even"><td><p>START_DATE</p></td>
372<td><p>String (YYYYMMDD)</p></td>
373<td><p>depends on dataset</p></td>
374<td><p>None</p></td>
375<td><p>The first day of the retrieval period.</p></td>
376<td><p>If END_DATE is set, START_DATE must be greater than END_DATE.</p></td>
377</tr>
378<tr class="row-odd"><td><p>END_DATE</p></td>
379<td><p>String (YYYYMMDD)</p></td>
380<td><p>depends on dataset</p></td>
381<td><p>None</p></td>
382<td><p>The last day of the retrieval period. For a one day retrieval it has to be the same date as START_DATE. If not set, it is automatically equal to START_DATE. </p></td>
383<td><p>Doesn’t have to be set. If set, it has to be greater or equal than START_DATE.</p></td>
384</tr>
385<tr class="row-even"><td><p>DTIME</p></td>
386<td><p>Integer</p></td>
387<td><p>1, 3, 6</p></td>
388<td><p>None</p></td>
389<td><p>Time step of retrieved data. Detects TYPE, TIME, STEP, ACCTYPE, ACCTIME according to DTIME. Therefore CONTROL file can have more values than needed.</p></td>
390<td><p>Available resolution in time depends on availability in the data set. Coarser resolution can always be selected.</p></td>
391</tr>
392<tr class="row-odd"><td><p>DATE_CHUNK</p></td>
393<td><p>Integer</p></td>
394<td><p>depends on resolution</p></td>
395<td><p>3</p></td>
396<td><p>Maximum number of days retrieved within one MARS request. </p></td>
397<td><p>This number is limited due to maximum allowed memory and time limit for one MARS request. Be careful in changing this number.  It can be  larger for reanalysis data but may be too large for very high resolution retrievals.</p></td>
398</tr>
399<tr class="row-even"><td><p>BASETIME</p></td>
400<td><p>Integer</p></td>
401<td><p>0; 12</p></td>
402<td><p>None</p></td>
403<td><p>This parameter is intended for half-day retrievals. Only half a day will be retrieved starting from BASETIME going back 12 hours. E.g. 20180510 with a BASETIME = 00 would lead to a data retrieval of 20180509 12h until 20180510 00h.</p></td>
404<td><p>Can be set to 00 or 12 only.</p></td>
405</tr>
406</tbody>
407</table>
408</div>
409<div class="section" id="data-section">
410<span id="ref-control-data"></span><h2>Data Section<a class="headerlink" href="#data-section" title="Permalink to this headline"></a></h2>
411<table class="docutils align-default" id="id4">
412<caption><span class="caption-text">Data parameters in CONTROL file</span><a class="headerlink" href="#id4" title="Permalink to this table"></a></caption>
413<colgroup>
414<col style="width: 13%" />
415<col style="width: 7%" />
416<col style="width: 12%" />
417<col style="width: 6%" />
418<col style="width: 36%" />
419<col style="width: 25%" />
420</colgroup>
421<thead>
422<tr class="row-odd"><th class="head"><p>PARAMETER</p></th>
423<th class="head"><p>Format</p></th>
424<th class="head"><p>Possible value range</p></th>
425<th class="head"><p>Default</p></th>
426<th class="head"><p>Description</p></th>
427<th class="head"><p>Information / Conditions</p></th>
428</tr>
429</thead>
430<tbody>
431<tr class="row-even"><td><p>CLASS</p></td>
432<td><p>String [xx]</p></td>
433<td><p>EI, E4, EA, EP, OD </p></td>
434<td><p>None</p></td>
435<td><p>ECMWF data classification identifier for data sets.</p></td>
436<td><p>EI: ERA-Interim; E4: ERA-40; EA: ERA5; EP: CERA-20C; OD: operational; </p></td>
437</tr>
438<tr class="row-odd"><td><p>DATASET</p></td>
439<td><p>String</p></td>
440<td><p>CERA20C, INTERIM, ERA5</p></td>
441<td><p>None</p></td>
442<td><p>This keyword has to be defined as soon as you want to retrieve public data sets. Public data are stored on a different server and are available for everyone after registration at ECMWF (see installation plan). </p></td>
443<td><p>A list of available public dataset can be found here:
444https://software.ecmwf.int/wiki/display/WEBAPI/Available+ECMWF+Public+Datasets</p></td>
445</tr>
446<tr class="row-even"><td><p>STREAM</p></td>
447<td><p>String [xxxx]</p></td>
448<td><p>OPER, ENFO, ENDO</p></td>
449<td><p>None</p></td>
450<td><p>Identifies the forecasting system used to generate the data. </p></td>
451<td><p>Most times the operational data stream OPER is appropriate. Use ENFO for ensemble forecasts and ENDO for CERA data.</p></td>
452</tr>
453<tr class="row-odd"><td><p>EXPVER</p></td>
454<td><p>String</p></td>
455<td><p>1</p></td>
456<td><p>1</p></td>
457<td><p>Experiment number, necessary for R&amp;D experiments, E-suites</p></td>
458<td><p></p></td>
459</tr>
460<tr class="row-even"><td><p>NUMBER</p></td>
461<td><p>Integer or String [i/to/i]</p></td>
462<td><p>depends on availability</p></td>
463<td><p>OFF</p></td>
464<td><p>In most cases this can be set to “OFF” but for access to individual ensemble members of ensemble forecasts it is necessary to select numbers. Note, however, that model level data are not stored in MARS for individual ensemble  members except the control run. They exist only for a few days before they are discarded. </p></td>
465<td><p>For retrieving CERA data, a number has to be selected explicitly. Usually “0” is enough.
466For operational data just one number or a list of number can be selected. You can use the syntax “1/to/9” for example.</p></td>
467</tr>
468<tr class="row-odd"><td><p>FORMAT</p></td>
469<td><p>String</p></td>
470<td><p>[GRIB1, GRIB2]</p></td>
471<td><p>GRIB1</p></td>
472<td><p>Output format (either GRIB1 or GRIB2). Use GRIB2
473only when using FLEXPART versions &gt;9.2 or FLEXPART hast to be adapted for reading GRIB2</p></td>
474<td><p>GRIB2 is only available for 3D model level fields, not for surface fields.</p></td>
475</tr>
476</tbody>
477</table>
478</div>
479<div class="section" id="data-field-section">
480<span id="ref-control-datafield"></span><h2>Data field Section<a class="headerlink" href="#data-field-section" title="Permalink to this headline"></a></h2>
481<table class="docutils align-default" id="id5">
482<caption><span class="caption-text">Data field parameters in CONTROL file</span><a class="headerlink" href="#id5" title="Permalink to this table"></a></caption>
483<colgroup>
484<col style="width: 15%" />
485<col style="width: 8%" />
486<col style="width: 10%" />
487<col style="width: 6%" />
488<col style="width: 24%" />
489<col style="width: 36%" />
490</colgroup>
491<thead>
492<tr class="row-odd"><th class="head"><p>PARAMETER</p></th>
493<th class="head"><p>Format</p></th>
494<th class="head"><p>Possible value range</p></th>
495<th class="head"><p>Default</p></th>
496<th class="head"><p>Description</p></th>
497<th class="head"><p>Information / Conditions</p></th>
498</tr>
499</thead>
500<tbody>
501<tr class="row-even"><td><p>TYPE</p></td>
502<td><p>list of String [xx xx … xx]</p></td>
503<td><p>AN, FC, CV, CF, 4V, PF</p></td>
504<td><p>None</p></td>
505<td><p>A list of field types for each retrieving hour per day. E.g. AN FC FC FC AN FC FC FC  for a day with 3-hourly retrieval DTIME . At 0 and 12 UTC we retrieve analysis fields and at 3, 6, 9, 15, 18 and 21 UTC forecast fields. </p></td>
506<td><p>So far flex_extract is using ANalysis (AN), ForeCast (FC),  Control Forecast (CF), Perturbed Forecast (PF), Calibration/Validation forecast (CV) and 4D Variational analysis (4V). Other types might be also possible but were not tested. The analysis fields are usually (depending on data set) available at 00/06/12/18 UTC. For better  temporal resolution, the time inbetween the AN fields can be filled with forecasts (FC). Additionally, it is recommended to use analysis fields only at 00 and 12 UTC and fill the rest of the times with other field types, such as forecasts. </p></td>
507</tr>
508<tr class="row-odd"><td><p>TIME</p></td>
509<td><p>list of String [xx xx … xx]</p></td>
510<td><p>[00 - 23]</p></td>
511<td><p>None</p></td>
512<td><p>The time of the corresponding field type (TYPE) in hours. It is important to set the correct forecast times. E.g. In Era-Interim data set, to get forecast fields between 1 and 11 hours, forecast times starting at 00 UTC are normally used. To get fields between 13 and 23 hours, forecast times starting at 12 UTC are used.  Mostly there are two forecasts starting per day. </p></td>
513<td><p>Has to have the same amount of values as in TYPE! The start times of forecasts can vary from one data set to another. It is also possible to have just one forecast per day, such as in the CERA data set.</p></td>
514</tr>
515<tr class="row-even"><td><p>STEP</p></td>
516<td><p>list of String [xx xx … xx]</p></td>
517<td><p>[00 - max available STEP in data set]</p></td>
518<td><p>None</p></td>
519<td><p>This is the forecast time step in hours for each corresponding field type (TYPE). Counting of the steps starts from the forecast times.  E.g. In Era-Interim, for forecasts at 3, 6, 9 UTC the STEPS 3,6 and 9 are used and the forecast TIME 00 UTC.</p></td>
520<td><p>Has to have the same amount of values as in TYPE and TIME! For analysis (AN) fields the STEP has to be 00 always!</p></td>
521</tr>
522<tr class="row-odd"><td><p>MAXSTEP</p></td>
523<td><p>Integer</p></td>
524<td><p>&gt; 24</p></td>
525<td><p>None</p></td>
526<td><p>This parameter allows to retrieve data from forecasts longer than 24 hours.
527With MAXSTEP &gt; 24 the forecasts from different days overlap, the naming scheme of the output files changes from &lt;PREFIX&gt;YYMMDD to &lt;PREFIX&gt;YYMMDD.HH.SSS where HH is the hour of the start of the forecast and SSS is the forecast step in hours.</p></td>
528<td><p>Optional parameter.</p></td>
529</tr>
530</tbody>
531</table>
532</div>
533<div class="section" id="flux-data-section">
534<span id="ref-control-fluxdata"></span><h2>Flux data Section<a class="headerlink" href="#flux-data-section" title="Permalink to this headline"></a></h2>
535<table class="docutils align-default" id="id6">
536<caption><span class="caption-text">Flux data parameters in CONTROL file</span><a class="headerlink" href="#id6" title="Permalink to this table"></a></caption>
537<colgroup>
538<col style="width: 15%" />
539<col style="width: 8%" />
540<col style="width: 12%" />
541<col style="width: 7%" />
542<col style="width: 25%" />
543<col style="width: 32%" />
544</colgroup>
545<thead>
546<tr class="row-odd"><th class="head"><p>PARAMETER</p></th>
547<th class="head"><p>Format</p></th>
548<th class="head"><p>Possible value range</p></th>
549<th class="head"><p>Default</p></th>
550<th class="head"><p>Description</p></th>
551<th class="head"><p>Information / Conditions</p></th>
552</tr>
553</thead>
554<tbody>
555<tr class="row-even"><td><p>ACCTYPE</p></td>
556<td><p>String</p></td>
557<td><p>FC, CV, CF, 4V, PF - just one of them</p></td>
558<td><p>None</p></td>
559<td><p>The type of field for accumulated data retrieval. The accumulated data fields are only available from forecast fields. Therefore it is seperated from the normal TYPE parameter to allow, for example, retrievment solely of hourly analysis fields in the Era5 data set. </p></td>
560<td><p>For downward compatibility  to older versions: if ACCTYPE is not specified,  the default value is taken form the second position of the original TYPE parameter (TYPE[2]).  NOTE: This is important at the moment the original TYPE parameter is changed from FC to AN for example.</p></td>
561</tr>
562<tr class="row-odd"><td><p>ACCTIME</p></td>
563<td><p>String</p></td>
564<td><p>E.g.:  Operational,  Era-Interim: 00/12            CERA: 18       ERA5 06/18</p></td>
565<td><p>None</p></td>
566<td><p>Start times of accumulated forecast fields (fluxes).  The starting times of forecast fields varies between different datasets. </p></td>
567<td><p>For downward compatibility to older versions: if ACCTIME is not specified,  the default value is 00/12 for ERA-Interim and operational data, 06/18 for ERA5 data and 18 for CERA-20C data.  </p></td>
568</tr>
569<tr class="row-even"><td><p>ACCMAXSTEP</p></td>
570<td><p>Integer</p></td>
571<td><p>12, 24 or larger</p></td>
572<td><p>None</p></td>
573<td><p>This parameter specifies the maximum step in hours for a specific accumulated forecast start time. For daily retrievals with one forecast time the step shouldn’t be greater than 24h. For two forecast times the ACCMAXSTEP should be 12. If the parameter MAXSTEP is specified to retrieve forecasts longer than 24 hours, this parameter must have the same value. </p></td>
574<td><p>For downward compatibility to older versions: if ACCMAXSTEP is not specified,  the default value is set to 12 for ERA5, Era-Interim and operational data or 24 for CERA-20C data, according to one or two forecast times of the data set.</p></td>
575</tr>
576<tr class="row-odd"><td><p>RRINT</p></td>
577<td><p>Integer</p></td>
578<td><p>0;1</p></td>
579<td><p>1</p></td>
580<td><p>Switch to select method of disaggregation for precipitation fields. Old method (0) with a simple linear disaggregation or new method (1) with 2 additional subsequent intervals per time interval.</p></td>
581<td><p>For more information see article:
582Hittmeir, S.; Philipp, A.; Seibert, P. (2017): A conservative interpolation scheme for extensive quantities with application to the Lagrangian particle dispersion model FLEXPART., Geoscientific Model Development. https://doi.org/10.5194/gmd-11-2503-2018</p></td>
583</tr>
584</tbody>
585</table>
586</div>
587<div class="section" id="domain-section">
588<span id="ref-control-domain"></span><h2>Domain Section<a class="headerlink" href="#domain-section" title="Permalink to this headline"></a></h2>
589<table class="colwidths-given docutils align-default" id="id7">
590<caption><span class="caption-text">Domain parameters in CONTROL file</span><a class="headerlink" href="#id7" title="Permalink to this table"></a></caption>
591<colgroup>
592<col style="width: 13%" />
593<col style="width: 13%" />
594<col style="width: 13%" />
595<col style="width: 7%" />
596<col style="width: 27%" />
597<col style="width: 27%" />
598</colgroup>
599<thead>
600<tr class="row-odd"><th class="head"><p>PARAMETER</p></th>
601<th class="head"><p>Format</p></th>
602<th class="head"><p>Possible value range</p></th>
603<th class="head"><p>Default</p></th>
604<th class="head"><p>Description</p></th>
605<th class="head"><p>Information / Conditions</p></th>
606</tr>
607</thead>
608<tbody>
609<tr class="row-even"><td><p>GRID</p></td>
610<td><p>String [i/i]</p></td>
611<td><p>0.1° - appropriate value e.g. 2°</p></td>
612<td><p>None</p></td>
613<td><p>Horizontal resolution of Latitude/Longitude grid. Best possible resolution varies for different data sets. E.g in operational data it’s 0.1° whereas in Era-Interim it is 0.75°.</p></td>
614<td><p>It can be specified in tenth degrees (1°) or thousandth degrees (1000 for 1°).</p></td>
615</tr>
616<tr class="row-odd"><td><p>RESOL</p></td>
617<td><p>String</p></td>
618<td><p>depends on GRID</p></td>
619<td><p>None</p></td>
620<td><p>Horizontal resolution of spectral fields.  Specifies the desired triangular truncation of retrieved data, before carrying out any other selected post-processing.</p></td>
621<td><p></p></td>
622</tr>
623<tr class="row-even"><td><p>SMOOTH</p></td>
624<td><p>Integer</p></td>
625<td><p>approriate number</p></td>
626<td><p>0</p></td>
627<td><p>Spectral truncation of ETADOT after calculation on
628Gaussian grid</p></td>
629<td><p>For more information see: Sardeshmukh and Hoskins, (1984): Spatial Smoothing on the Sphere, Monthly Weather Review, Vol. 112, No.12, P. 2524-2529</p></td>
630</tr>
631<tr class="row-odd"><td><p>UPPER</p></td>
632<td><p>String</p></td>
633<td><p>-90+GRID
634to 90</p></td>
635<td><p>None</p></td>
636<td><p>Latitude of upper right corner of grid area. </p></td>
637<td><p></p></td>
638</tr>
639<tr class="row-even"><td><p>LOWER</p></td>
640<td><p>String</p></td>
641<td><p>-90+GRID
642to 90</p></td>
643<td><p>None</p></td>
644<td><p>Latitude of lower left corner of grid area.</p></td>
645<td><p></p></td>
646</tr>
647<tr class="row-odd"><td><p>LEFT</p></td>
648<td><p>String</p></td>
649<td><p>-180+GRID
650to 180</p></td>
651<td><p>None</p></td>
652<td><p>Longitude of lower left corner of grid area.</p></td>
653<td><p>For cyclic (global) grids, use e.g. LEFT = - 180 + GRID, RIGHT = 180. For noncyclic grids crossing the dateline (180W), RIGHT may be smaller than LEFT.</p></td>
654</tr>
655<tr class="row-even"><td><p>RIGHT</p></td>
656<td><p>String</p></td>
657<td><p>-180+GRID
658to 180</p></td>
659<td><p>None</p></td>
660<td><p>Longitude of upper right corner of grid area.</p></td>
661<td><p>For cyclic (global) grids, use e.g. LEFT = - 180 + GRID, RIGHT = 180. For noncyclic grids crossing the dateline (180W), RIGHT may be smaller than LEFT.</p></td>
662</tr>
663<tr class="row-odd"><td><p>LEVEL</p></td>
664<td><p>String</p></td>
665<td><p>60, 91, 137
666depends on data set</p></td>
667<td><p>None</p></td>
668<td><p>Maximum number of vertical levels.</p></td>
669<td><p>ERA-Interim has 60 levels; ERA5 has 137 levels; CERA-20C has 91 levels; Operational data can have different number of model levels depending on the date. Check upfront in the MARS catalogue. If LEVELIST is set , this parameter is not needed.</p></td>
670</tr>
671<tr class="row-even"><td><p>LEVELIST</p></td>
672<td><p>String [start/to/end]</p></td>
673<td><p>1/to/137</p></td>
674<td><p>None</p></td>
675<td><p>List of vertical levels for MARS request. It can be a subset of levels but it has to include the maximum level (end).</p></td>
676<td><p>If full list of levels is needed and parameter LEVEL is set, the LEVELIST parameter is not needed. “end” has to be the maximum number of possible levels and has to be the same as in LEVEL, if specified.</p></td>
677</tr>
678</tbody>
679</table>
680</div>
681<div class="section" id="vertical-wind-section">
682<span id="ref-control-verticalwind"></span><h2>Vertical wind Section<a class="headerlink" href="#vertical-wind-section" title="Permalink to this headline"></a></h2>
683<table class="docutils align-default" id="id8">
684<caption><span class="caption-text">Vertical wind parameter in CONTROL file</span><a class="headerlink" href="#id8" title="Permalink to this table"></a></caption>
685<colgroup>
686<col style="width: 15%" />
687<col style="width: 9%" />
688<col style="width: 10%" />
689<col style="width: 9%" />
690<col style="width: 29%" />
691<col style="width: 28%" />
692</colgroup>
693<thead>
694<tr class="row-odd"><th class="head"><p>PARAMETER</p></th>
695<th class="head"><p>Format</p></th>
696<th class="head"><p>Possible value range</p></th>
697<th class="head"><p>Default</p></th>
698<th class="head"><p>Description</p></th>
699<th class="head"><p>Information / Conditions</p></th>
700</tr>
701</thead>
702<tbody>
703<tr class="row-even"><td><p>GAUSS</p></td>
704<td><p>Integer</p></td>
705<td><p>0;1</p></td>
706<td><p>0</p></td>
707<td><p>A switch to calculate ETADOT from Lat/Lon grid (0) or from Gaussian grid (1)</p></td>
708<td><p></p></td>
709</tr>
710<tr class="row-odd"><td><p>ACCURACY</p></td>
711<td><p>Integer</p></td>
712<td><p></p></td>
713<td><p>24</p></td>
714<td><p>Specifies the number of bits per value to be used in the generated GRIB coded fields.</p></td>
715<td><p></p></td>
716</tr>
717<tr class="row-even"><td><p>OMEGA</p></td>
718<td><p>Integer</p></td>
719<td><p>0;1</p></td>
720<td><p>0</p></td>
721<td><p>Retrieve Omega from MARS and put it to file
722OMEGAyymmddhh</p></td>
723<td><p>Only useful for debugging reasons.</p></td>
724</tr>
725<tr class="row-odd"><td><p>OMEGADIFF</p></td>
726<td><p>Integer</p></td>
727<td><p>0;1</p></td>
728<td><p>0</p></td>
729<td><p>Calculate Omega and Dps/Dt from continuity
730equation for diagnostic purposes and include it in file OMEGAyymmddhh</p></td>
731<td><p>Only useful for debugging reasons.</p></td>
732</tr>
733<tr class="row-even"><td><p>ETA</p></td>
734<td><p>Integer</p></td>
735<td><p>0;1</p></td>
736<td><p>0</p></td>
737<td><p>Switch to read ETADOT precalculated by ECMWF and multiply it with DPDETA to be compatible with ETADOT calculated from continuity equation.
738ETADOT calculation from continuity equation on either Gaussian or lat/lon grid is disabled unless ETADIFF is set to 1 as well.</p></td>
739<td><p>ETADOT is available in ERA5, CERA-20C and operational data sets. Precalculated ETADOT is operationally available from September 2008 onwards. However, it is not available in the ERA-40 and ERA-Interim data set. If ETA is selected in the last two data sets, flex_extract fails.</p></td>
740</tr>
741<tr class="row-odd"><td><p>ETADIFF</p></td>
742<td><p>Integer</p></td>
743<td><p>0;1</p></td>
744<td><p>0</p></td>
745<td><p>Switch to calculate etadot and Dps/Dt from continuity equation for diagnostic purposes and include it in file ETAyymmddhh. Expensive option, only for debugging purposes.</p></td>
746<td><p></p></td>
747</tr>
748<tr class="row-even"><td><p>DPDETA</p></td>
749<td><p>Integer</p></td>
750<td><p>0;1</p></td>
751<td><p>1</p></td>
752<td><p>Switch to multiply etadot with dpdeta – this is the default. In some future version this may change.</p></td>
753<td><p></p></td>
754</tr>
755<tr class="row-odd"><td><p>ETAPAR</p></td>
756<td><p>Integer</p></td>
757<td><p>77</p></td>
758<td><p>77</p></td>
759<td><p>GRIB parameter number for ETADOT/DPDETA </p></td>
760<td><p></p></td>
761</tr>
762</tbody>
763</table>
764</div>
765<div class="section" id="additional-data-section">
766<span id="ref-control-adddata"></span><h2>Additional data Section<a class="headerlink" href="#additional-data-section" title="Permalink to this headline"></a></h2>
767<table class="docutils align-default" id="id9">
768<caption><span class="caption-text">Additional data parameters in CONTROL file</span><a class="headerlink" href="#id9" title="Permalink to this table"></a></caption>
769<colgroup>
770<col style="width: 16%" />
771<col style="width: 9%" />
772<col style="width: 12%" />
773<col style="width: 11%" />
774<col style="width: 14%" />
775<col style="width: 36%" />
776</colgroup>
777<thead>
778<tr class="row-odd"><th class="head"><p>PARAMETER</p></th>
779<th class="head"><p>Format</p></th>
780<th class="head"><p>Possible value range</p></th>
781<th class="head"><p>Default</p></th>
782<th class="head"><p>Description</p></th>
783<th class="head"><p>Information / Conditions</p></th>
784</tr>
785</thead>
786<tbody>
787<tr class="row-even"><td><p>CWC</p></td>
788<td><p>Integer</p></td>
789<td><p>0;1</p></td>
790<td><p>0</p></td>
791<td><p>Switch to retrieve cloud water content (sum of cloud liquid water and cloud ice) (1) or not (0).</p></td>
792<td><p></p></td>
793</tr>
794<tr class="row-odd"><td><p>DOUBLEELDA</p></td>
795<td><p>Integer</p></td>
796<td><p>0;1</p></td>
797<td><p>0</p></td>
798<td><p>Switch to select the calculation of extra ensemble members for the ELDA stream. It doubles the amount of retrieved ensemble members.</p></td>
799<td><p>Each ensemble member is used to create a new synthesized ensemble member by subtracting 2 * ( current time step value - last time step value ) from the current time step value</p></td>
800</tr>
801<tr class="row-even"><td><p>ADDPAR</p></td>
802<td><p>String [p1/p2/../pn]</p></td>
803<td><p></p></td>
804<td><p>None</p></td>
805<td><p>Additional optional surface parameters (2D fields, non-accumulated)
806Mostly: 27/28/173/186/187/188/235/139/39</p></td>
807<td><p>Parameters can be specified as the Integer IDs or with the short names.</p></td>
808</tr>
809</tbody>
810</table>
811<div class="toctree-wrapper compound">
812</div>
813</div>
814</div>
815
816
817           </div>
818           
819          </div>
820          <footer>
821 
822    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
823     
824        <a href="examples.html" class="btn btn-neutral float-right" title="CONTROL file examples" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
825     
826     
827        <a href="control.html" class="btn btn-neutral float-left" title="The CONTROL file" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
828     
829    </div>
830 
831
832  <hr/>
833
834  <div role="contentinfo">
835    <p>
836        &copy; Copyright 2020, Anne Philipp, Leopold Haimberger and Petra Seibert
837
838    </p>
839  </div>
840  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
841
842</footer>
843
844        </div>
845      </div>
846
847    </section>
848
849  </div>
850 
851
852
853  <script type="text/javascript">
854      jQuery(function () {
855          SphinxRtdTheme.Navigation.enable(true);
856      });
857  </script>
858
859 
860 
861   
862   
863
864</body>
865</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG