[0b00607] | 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 alpha 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 type="text/javascript" src="../../_static/jquery.js"></script> |
---|
| 25 | <script type="text/javascript" src="../../_static/underscore.js"></script> |
---|
| 26 | <script type="text/javascript" src="../../_static/doctools.js"></script> |
---|
| 27 | <script type="text/javascript" src="../../_static/language_data.js"></script> |
---|
| 28 | <script async="async" type="text/javascript" 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 Jobscript 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 |
---|
| 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="../../installation.html">Installation</a></li> |
---|
| 93 | <li class="toctree-l1"><a class="reference internal" href="../../quick_start.html">Quick Start</a></li> |
---|
| 94 | <li class="toctree-l1"><a class="reference internal" href="../../ecmwf_data.html">ECMWF Data</a></li> |
---|
| 95 | <li class="toctree-l1 current"><a class="reference internal" href="../../documentation.html">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 Jobscript <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 - <code class="docutils literal notranslate"><span class="pre">CONVERT2</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 Jobscript <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 Coordinate</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">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 <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> needs to decide on dataset specifications, |
---|
| 200 | handling of the retrieved data and general bahaviour. The naming convention is usually (but not necessary):</p> |
---|
| 201 | <blockquote> |
---|
| 202 | <div><code class="docutils literal notranslate"><span class="pre">CONTROL_<Dataset>[.optionalIndications]</span></code></div></blockquote> |
---|
| 203 | <p>The tested datasets are the operational dataset and the re-analysis datasets CERA-20C, ERA5 and ERA-Interim. |
---|
| 204 | The optional extra indications for the re-analysis datasets mark the files for <em>public users</em> |
---|
| 205 | and <em>global</em> domain. For the operational datasets (<em>OD</em>) the file names contain also information of |
---|
| 206 | the stream, the field type for forecasts, the method for extracting the vertical coordinate and other things like time or horizontal resolution.</p> |
---|
| 207 | <div class="section" id="format-of-control-files"> |
---|
| 208 | <h2>Format of CONTROL files<a class="headerlink" href="#format-of-control-files" title="Permalink to this headline">¶</a></h2> |
---|
| 209 | <p>The first string of each line is the parameter name, the following string(s) (separated by spaces) is (are) the parameter values. |
---|
| 210 | The parameters can be sorted in any order with one parameter per line. |
---|
| 211 | Comments are started with a ‘#’ - sign. Some of these parameters can be overruled by the command line |
---|
| 212 | parameters given to the <code class="docutils literal notranslate"><span class="pre">submit.py</span></code> script. |
---|
| 213 | All parameters have default values. Only those parameters which have to be changed |
---|
| 214 | must be listed in the <code class="docutils literal notranslate"><span class="pre">CONTROL</span></code> files.</p> |
---|
| 215 | </div> |
---|
| 216 | <div class="section" id="example-control-files"> |
---|
| 217 | <h2>Example CONTROL files<a class="headerlink" href="#example-control-files" title="Permalink to this headline">¶</a></h2> |
---|
| 218 | <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>. |
---|
| 219 | They can be used as a template for adaptations and understand what’s possible to |
---|
| 220 | retrieve from ECMWF’s archive. |
---|
| 221 | For each main dataset there is an example and additionally some variances in resolution, type of field or type of retrieving the vertical coordinate.</p> |
---|
| 222 | </div> |
---|
| 223 | <div class="section" id="control-file"> |
---|
| 224 | <h2>CONTROL file<a class="headerlink" href="#control-file" title="Permalink to this headline">¶</a></h2> |
---|
| 225 | <p>The file <code class="docutils literal notranslate"><span class="pre">CONTROL.documentation</span></code> documents the available parameters |
---|
| 226 | in grouped sections with their default values. In <a class="reference internal" href="control_params.html"><span class="doc">The CONTROL parameters</span></a> you can find a more |
---|
| 227 | detailed description with additional hints, possible values and some useful information about |
---|
| 228 | the setting of these parameters.</p> |
---|
| 229 | <div class="toctree-wrapper compound"> |
---|
| 230 | </div> |
---|
| 231 | </div> |
---|
| 232 | </div> |
---|
| 233 | |
---|
| 234 | |
---|
| 235 | </div> |
---|
| 236 | |
---|
| 237 | </div> |
---|
| 238 | <footer> |
---|
| 239 | |
---|
| 240 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
---|
| 241 | |
---|
| 242 | <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> |
---|
| 243 | |
---|
| 244 | |
---|
| 245 | <a href="jobscript.html" class="btn btn-neutral float-left" title="The Jobscript job.ksh" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
---|
| 246 | |
---|
| 247 | </div> |
---|
| 248 | |
---|
| 249 | |
---|
| 250 | <hr/> |
---|
| 251 | |
---|
| 252 | <div role="contentinfo"> |
---|
| 253 | <p> |
---|
| 254 | © Copyright 2019, Anne Philipp and Leopold Haimberger |
---|
| 255 | |
---|
| 256 | </p> |
---|
| 257 | </div> |
---|
| 258 | 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>. |
---|
| 259 | |
---|
| 260 | </footer> |
---|
| 261 | |
---|
| 262 | </div> |
---|
| 263 | </div> |
---|
| 264 | |
---|
| 265 | </section> |
---|
| 266 | |
---|
| 267 | </div> |
---|
| 268 | |
---|
| 269 | |
---|
| 270 | |
---|
| 271 | <script type="text/javascript"> |
---|
| 272 | jQuery(function () { |
---|
| 273 | SphinxRtdTheme.Navigation.enable(true); |
---|
| 274 | }); |
---|
| 275 | </script> |
---|
| 276 | |
---|
| 277 | |
---|
| 278 | |
---|
| 279 | |
---|
| 280 | |
---|
| 281 | |
---|
| 282 | </body> |
---|
| 283 | </html> |
---|