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 file — 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="The CONTROL parameters" href="control_params.html" /> |
---|
42 | <link rel="prev" title="The job script job.ksh" href="jobscript.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 & 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 current"><a class="current reference internal" href="#">The CONTROL file</a><ul> |
---|
104 | <li class="toctree-l4"><a class="reference internal" href="#format-of-control-files">Format of CONTROL files</a></li> |
---|
105 | <li class="toctree-l4"><a class="reference internal" href="#example-control-files">Example CONTROL files</a></li> |
---|
106 | <li class="toctree-l4"><a class="reference internal" href="#control-file">CONTROL file</a></li> |
---|
107 | </ul> |
---|
108 | </li> |
---|
109 | <li class="toctree-l3"><a class="reference internal" href="control_params.html">The CONTROL parameters</a></li> |
---|
110 | <li class="toctree-l3"><a class="reference internal" href="examples.html">CONTROL file examples</a></li> |
---|
111 | <li class="toctree-l3"><a class="reference internal" href="changes.html">CONTROL file changes</a></li> |
---|
112 | <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> |
---|
113 | <li class="toctree-l3"><a class="reference internal" href="templates.html">Templates</a></li> |
---|
114 | </ul> |
---|
115 | </li> |
---|
116 | <li class="toctree-l2"><a class="reference internal" href="../output.html">Output data</a></li> |
---|
117 | <li class="toctree-l2"><a class="reference internal" href="../disagg.html">Disaggregation of flux data</a></li> |
---|
118 | <li class="toctree-l2"><a class="reference internal" href="../vertco.html">Vertical wind</a></li> |
---|
119 | <li class="toctree-l2"><a class="reference internal" href="../api.html">Auto-generated documentation</a></li> |
---|
120 | </ul> |
---|
121 | </li> |
---|
122 | <li class="toctree-l1"><a class="reference internal" href="../../evaluation.html">Evaluation</a></li> |
---|
123 | <li class="toctree-l1"><a class="reference internal" href="../../dev_guide.html">Developer Guide</a></li> |
---|
124 | <li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changelog</a></li> |
---|
125 | <li class="toctree-l1"><a class="reference internal" href="../../support.html">Support</a></li> |
---|
126 | <li class="toctree-l1"><a class="reference internal" href="../../Support/faq.html">FAQ - Frequently asked questions</a></li> |
---|
127 | <li class="toctree-l1"><a class="reference internal" href="../../authors.html">Developer Team</a></li> |
---|
128 | </ul> |
---|
129 | |
---|
130 | |
---|
131 | |
---|
132 | </div> |
---|
133 | </div> |
---|
134 | </nav> |
---|
135 | |
---|
136 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
---|
137 | |
---|
138 | |
---|
139 | <nav class="wy-nav-top" aria-label="top navigation"> |
---|
140 | |
---|
141 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
---|
142 | <a href="../../index.html">flex_extract</a> |
---|
143 | |
---|
144 | </nav> |
---|
145 | |
---|
146 | |
---|
147 | <div class="wy-nav-content"> |
---|
148 | |
---|
149 | <div class="rst-content"> |
---|
150 | |
---|
151 | |
---|
152 | |
---|
153 | |
---|
154 | |
---|
155 | |
---|
156 | |
---|
157 | |
---|
158 | |
---|
159 | |
---|
160 | |
---|
161 | |
---|
162 | |
---|
163 | |
---|
164 | |
---|
165 | |
---|
166 | |
---|
167 | <div role="navigation" aria-label="breadcrumbs navigation"> |
---|
168 | |
---|
169 | <ul class="wy-breadcrumbs"> |
---|
170 | |
---|
171 | <li><a href="../../index.html">Docs</a> »</li> |
---|
172 | |
---|
173 | <li><a href="../../documentation.html">Code-Level Documentation</a> »</li> |
---|
174 | |
---|
175 | <li><a href="../input.html">Control & input data</a> »</li> |
---|
176 | |
---|
177 | <li>The CONTROL file</li> |
---|
178 | |
---|
179 | |
---|
180 | <li class="wy-breadcrumbs-aside"> |
---|
181 | |
---|
182 | |
---|
183 | <a href="../../_sources/Documentation/Input/control.rst.txt" rel="nofollow"> View page source</a> |
---|
184 | |
---|
185 | |
---|
186 | </li> |
---|
187 | |
---|
188 | </ul> |
---|
189 | |
---|
190 | |
---|
191 | <hr/> |
---|
192 | </div> |
---|
193 | <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
---|
194 | <div itemprop="articleBody"> |
---|
195 | |
---|
196 | <div class="section" id="the-control-file"> |
---|
197 | <h1>The CONTROL file<a class="headerlink" href="#the-control-file" title="Permalink to this headline">¶</a></h1> |
---|
198 | <p>This file is an input file for <code class="docutils literal notranslate"><span class="pre">flex_extract's</span></code> main script <code class="docutils literal notranslate"><span class="pre">submit.py</span></code>. |
---|
199 | It contains the controlling parameters which <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> needs to decide on data set specifications, |
---|
200 | handling of the data retrieved, and general behaviour. The naming convention is usually (but not necessarily):</p> |
---|
201 | <blockquote> |
---|
202 | <div><p><code class="docutils literal notranslate"><span class="pre">CONTROL_<Dataset>[.optionalIndications]</span></code></p> |
---|
203 | </div></blockquote> |
---|
204 | <p>There are a number of data sets for which the procedures have been tested, the operational data and the re-analysis datasets CERA-20C, ERA5, and ERA-Interim. |
---|
205 | The optional indications for the re-analysis data sets mark the files for <em>public users</em> |
---|
206 | and <em>global</em> domain. For the operational data sets (<em>OD</em>), the file names contain also information of |
---|
207 | the stream, the field type for forecasts, the method for extracting the vertical wind, and other information such as temporal or horizontal resolution.</p> |
---|
208 | <div class="section" id="format-of-control-files"> |
---|
209 | <h2>Format of CONTROL files<a class="headerlink" href="#format-of-control-files" title="Permalink to this headline">¶</a></h2> |
---|
210 | <p>The first string of each line is the parameter name, the following string(s) (separated by spaces) is (are) the parameter values. |
---|
211 | The parameters can be listed in any order with one parameter per line. |
---|
212 | Comments are started with a ‘#’ - sign. Some of these parameters can be overruled by the command line |
---|
213 | parameters given to the <code class="docutils literal notranslate"><span class="pre">submit.py</span></code> script. |
---|
214 | All parameters have default values; only those parameters which deviate from default |
---|
215 | have be listed in the <code class="docutils literal notranslate"><span class="pre">CONTROL</span></code> files.</p> |
---|
216 | </div> |
---|
217 | <div class="section" id="example-control-files"> |
---|
218 | <h2>Example CONTROL files<a class="headerlink" href="#example-control-files" title="Permalink to this headline">¶</a></h2> |
---|
219 | <p>A number of example files can be found in the directory <code class="docutils literal notranslate"><span class="pre">flex_extract_vX.X/Run/Control/</span></code>. |
---|
220 | They can be used as a template for adaptation, and to understand what can be |
---|
221 | retrievee from ECMWF’s archives. |
---|
222 | There is an example for each main data set, and in addition, some more varied with respect to resolution, type of field, or way of retrieving the vertical wind.</p> |
---|
223 | </div> |
---|
224 | <div class="section" id="control-file"> |
---|
225 | <h2>CONTROL file<a class="headerlink" href="#control-file" title="Permalink to this headline">¶</a></h2> |
---|
226 | <p>The file <code class="docutils literal notranslate"><span class="pre">CONTROL.documentation</span></code> documents the available parameters |
---|
227 | in grouped sections together with their default values. |
---|
228 | In <a class="reference internal" href="control_params.html"><span class="doc">The CONTROL parameters</span></a>, you can find a more |
---|
229 | detailed description with additional hints, possible values, and further information about |
---|
230 | the setting of these parameters.</p> |
---|
231 | <div class="literal-block-wrapper docutils container" id="id1"> |
---|
232 | <div class="code-block-caption"><span class="caption-text">CONTROL.documentation</span><a class="headerlink" href="#id1" title="Permalink to this code">¶</a></div> |
---|
233 | <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1">################################################################################</span> |
---|
234 | <span class="c1"># Comprehensive list of relevant CONTROL file parameters with</span> |
---|
235 | <span class="c1"># short descriptions and default values. </span> |
---|
236 | <span class="c1">#</span> |
---|
237 | <span class="c1"># For more details on how to select and define parameters </span> |
---|
238 | <span class="c1"># please see Table of CONTROLparameters. </span> |
---|
239 | <span class="c1">#</span> |
---|
240 | <span class="c1"># AUTHOR: Anne Philipp</span> |
---|
241 | <span class="c1"># DATE: 05. February 2019</span> |
---|
242 | <span class="c1">################################################################################</span> |
---|
243 | |
---|
244 | <span class="c1">#===============================================================================</span> |
---|
245 | <span class="c1"># USER SECTION:</span> |
---|
246 | <span class="c1"># User specific information for ECMWF server.</span> |
---|
247 | <span class="c1"># Information are needed for storage or data transfer to local gateway server.</span> |
---|
248 | <span class="c1"># (OPTIONAL: INFORMATION ARE KNOWN THROUGH EXTRA FILE AFTER INSTALLATION)</span> |
---|
249 | <span class="c1">#-------------------------------------------------------------------------------</span> |
---|
250 | ECUID None |
---|
251 | ECGID None |
---|
252 | DESTINATION None |
---|
253 | GATEWAY None |
---|
254 | |
---|
255 | <span class="c1">#===============================================================================</span> |
---|
256 | <span class="c1"># GENERAL SECTION:</span> |
---|
257 | <span class="c1"># Specific storage, notification and data transfer settings.</span> |
---|
258 | <span class="c1"># Selection of ECMWF access interface and extra output options. </span> |
---|
259 | <span class="c1">#-------------------------------------------------------------------------------</span> |
---|
260 | DEBUG <span class="m">0</span> |
---|
261 | REQUEST <span class="m">0</span> |
---|
262 | PUBLIC <span class="m">0</span> |
---|
263 | OPER <span class="m">0</span> |
---|
264 | ECSTORAGE <span class="m">0</span> |
---|
265 | ECTRANS <span class="m">0</span> |
---|
266 | PREFIX <span class="s1">'EN'</span> |
---|
267 | ECFSDIR <span class="s1">'ectmp:/${USER}/econdemand/'</span> |
---|
268 | MAILFAIL <span class="o">[</span><span class="s1">'${USER}'</span><span class="o">]</span> |
---|
269 | MAILOPS <span class="o">[</span><span class="s1">'${USER}'</span><span class="o">]</span> |
---|
270 | |
---|
271 | <span class="c1">#===============================================================================</span> |
---|
272 | <span class="c1"># TIME SECTION:</span> |
---|
273 | <span class="c1"># Selection of time period and temporal resolution for extraction period.</span> |
---|
274 | <span class="c1">#-------------------------------------------------------------------------------</span> |
---|
275 | START_DATE |
---|
276 | END_DATE |
---|
277 | DATE_CHUNK <span class="m">3</span> |
---|
278 | DTIME None |
---|
279 | BASETIME None |
---|
280 | |
---|
281 | <span class="c1">#===============================================================================</span> |
---|
282 | <span class="c1"># DATA SECTION:</span> |
---|
283 | <span class="c1"># General description of data set.</span> |
---|
284 | <span class="c1">#-------------------------------------------------------------------------------</span> |
---|
285 | CLASS None |
---|
286 | DATASET None |
---|
287 | STREAM None |
---|
288 | NUMBER <span class="s1">'OFF'</span> |
---|
289 | EXPVER <span class="s1">'1'</span> |
---|
290 | FORMAT <span class="s1">'GRIB1'</span> |
---|
291 | |
---|
292 | <span class="c1">#===============================================================================</span> |
---|
293 | <span class="c1"># DATA FIELDS SECTION:</span> |
---|
294 | <span class="c1"># Specific selection of field composition regarding type, analysis or forecast </span> |
---|
295 | <span class="c1"># time and the forecast time step.</span> |
---|
296 | <span class="c1">#-------------------------------------------------------------------------------</span> |
---|
297 | TYPE None |
---|
298 | TIME None |
---|
299 | STEP None |
---|
300 | MAXSTEP None |
---|
301 | |
---|
302 | <span class="c1">#===============================================================================</span> |
---|
303 | <span class="c1"># FLUX DATA FIELDS SECTION:</span> |
---|
304 | <span class="c1"># Specific selection of flux field composition regarding forecast field type</span> |
---|
305 | <span class="c1"># the forecast start times and the maximum forecast step per start time.</span> |
---|
306 | <span class="c1"># Specification of disaggregation method of precipitation data.</span> |
---|
307 | <span class="c1">#-------------------------------------------------------------------------------</span> |
---|
308 | ACCTYPE None |
---|
309 | ACCTIME None |
---|
310 | ACCMAXSTEP None |
---|
311 | RRINT <span class="m">0</span> |
---|
312 | |
---|
313 | <span class="c1">#===============================================================================</span> |
---|
314 | <span class="c1"># DOMAIN SECTION: </span> |
---|
315 | <span class="c1"># Definition of horizontal area, spatial resolution and vertical levels. </span> |
---|
316 | <span class="c1">#-------------------------------------------------------------------------------</span> |
---|
317 | GRID None |
---|
318 | RESOL None |
---|
319 | SMOOTH <span class="m">0</span> |
---|
320 | LEFT None |
---|
321 | LOWER None |
---|
322 | UPPER None |
---|
323 | RIGHT None |
---|
324 | LEVEL None |
---|
325 | LEVELIST None |
---|
326 | |
---|
327 | <span class="c1">#===============================================================================</span> |
---|
328 | <span class="c1"># VERTICAL WIND SECTION:</span> |
---|
329 | <span class="c1"># Selection of vertical wind calculation method.</span> |
---|
330 | <span class="c1">#-------------------------------------------------------------------------------</span> |
---|
331 | GAUSS <span class="m">0</span> |
---|
332 | ACCURACY <span class="m">24</span> |
---|
333 | OMEGA <span class="m">0</span> |
---|
334 | OMEGADIFF <span class="m">0</span> |
---|
335 | ETA <span class="m">0</span> |
---|
336 | ETADIFF <span class="m">0</span> |
---|
337 | DPDETA <span class="m">1</span> |
---|
338 | ETAPAR <span class="m">77</span> |
---|
339 | |
---|
340 | <span class="c1">#===============================================================================</span> |
---|
341 | <span class="c1"># ADDITIONAL DATA SECTION:</span> |
---|
342 | <span class="c1"># Specification of extra data fields to be extracted.</span> |
---|
343 | <span class="c1">#-------------------------------------------------------------------------------</span> |
---|
344 | CWC <span class="m">0</span> |
---|
345 | WRF <span class="m">0</span> |
---|
346 | DOUBLEELDA <span class="m">0</span> |
---|
347 | ADDPAR None |
---|
348 | </pre></div> |
---|
349 | </div> |
---|
350 | </div> |
---|
351 | <div class="toctree-wrapper compound"> |
---|
352 | </div> |
---|
353 | </div> |
---|
354 | </div> |
---|
355 | |
---|
356 | |
---|
357 | </div> |
---|
358 | |
---|
359 | </div> |
---|
360 | <footer> |
---|
361 | |
---|
362 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
---|
363 | |
---|
364 | <a href="control_params.html" class="btn btn-neutral float-right" title="The CONTROL parameters" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
---|
365 | |
---|
366 | |
---|
367 | <a href="jobscript.html" class="btn btn-neutral float-left" title="The job script job.ksh" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
---|
368 | |
---|
369 | </div> |
---|
370 | |
---|
371 | |
---|
372 | <hr/> |
---|
373 | |
---|
374 | <div role="contentinfo"> |
---|
375 | <p> |
---|
376 | © Copyright 2020, Anne Philipp, Leopold Haimberger and Petra Seibert |
---|
377 | |
---|
378 | </p> |
---|
379 | </div> |
---|
380 | 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>. |
---|
381 | |
---|
382 | </footer> |
---|
383 | |
---|
384 | </div> |
---|
385 | </div> |
---|
386 | |
---|
387 | </section> |
---|
388 | |
---|
389 | </div> |
---|
390 | |
---|
391 | |
---|
392 | |
---|
393 | <script type="text/javascript"> |
---|
394 | jQuery(function () { |
---|
395 | SphinxRtdTheme.Navigation.enable(true); |
---|
396 | }); |
---|
397 | </script> |
---|
398 | |
---|
399 | |
---|
400 | |
---|
401 | |
---|
402 | |
---|
403 | |
---|
404 | </body> |
---|
405 | </html> |
---|