[708c667] | 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>Auto Generated Documentation — flex_extract 7.1 alpha documentation</title> |
---|
| 12 | |
---|
| 13 | |
---|
| 14 | |
---|
| 15 | |
---|
| 16 | |
---|
| 17 | |
---|
| 18 | |
---|
| 19 | |
---|
| 20 | |
---|
| 21 | |
---|
| 22 | |
---|
| 23 | |
---|
| 24 | |
---|
| 25 | |
---|
| 26 | |
---|
| 27 | <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
---|
| 28 | <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
---|
| 29 | <link rel="index" title="Index" href="genindex.html" /> |
---|
| 30 | <link rel="search" title="Search" href="search.html" /> |
---|
| 31 | <link rel="next" title="Support" href="support.html" /> |
---|
[274f9ef] | 32 | <link rel="prev" title="CONTROL-file templates" href="user_guide/control_templates.html" /> |
---|
[708c667] | 33 | |
---|
| 34 | |
---|
| 35 | <script src="_static/js/modernizr.min.js"></script> |
---|
| 36 | |
---|
| 37 | </head> |
---|
| 38 | |
---|
| 39 | <body class="wy-body-for-nav"> |
---|
| 40 | |
---|
| 41 | |
---|
| 42 | <div class="wy-grid-for-nav"> |
---|
| 43 | |
---|
| 44 | |
---|
| 45 | <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
---|
| 46 | <div class="wy-side-scroll"> |
---|
| 47 | <div class="wy-side-nav-search"> |
---|
| 48 | |
---|
| 49 | |
---|
| 50 | |
---|
| 51 | <a href="index.html" class="icon icon-home"> flex_extract |
---|
| 52 | |
---|
| 53 | |
---|
| 54 | |
---|
| 55 | </a> |
---|
| 56 | |
---|
| 57 | |
---|
| 58 | |
---|
| 59 | |
---|
| 60 | <div class="version"> |
---|
| 61 | 7.1 |
---|
| 62 | </div> |
---|
| 63 | |
---|
| 64 | |
---|
| 65 | |
---|
| 66 | |
---|
| 67 | <div role="search"> |
---|
| 68 | <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
---|
| 69 | <input type="text" name="q" placeholder="Search docs" /> |
---|
| 70 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 71 | <input type="hidden" name="area" value="default" /> |
---|
| 72 | </form> |
---|
| 73 | </div> |
---|
| 74 | |
---|
| 75 | |
---|
| 76 | </div> |
---|
| 77 | |
---|
| 78 | <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
---|
| 79 | |
---|
| 80 | |
---|
| 81 | |
---|
| 82 | |
---|
| 83 | |
---|
| 84 | |
---|
| 85 | <p class="caption"><span class="caption-text">Table of Contents:</span></p> |
---|
| 86 | <ul class="current"> |
---|
| 87 | <li class="toctree-l1"><a class="reference internal" href="downloads.html">Downloads</a></li> |
---|
| 88 | <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li> |
---|
| 89 | <li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li> |
---|
| 90 | <li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li> |
---|
[274f9ef] | 91 | <li class="toctree-l1 current"><a class="current reference internal" href="#">Auto Generated Documentation</a><ul> |
---|
| 92 | <li class="toctree-l2"><a class="reference internal" href="#porgrams">Porgrams</a><ul> |
---|
| 93 | <li class="toctree-l3"><a class="reference internal" href="#module-install">install</a></li> |
---|
| 94 | <li class="toctree-l3"><a class="reference internal" href="#module-submit">submit</a></li> |
---|
| 95 | </ul> |
---|
| 96 | </li> |
---|
| 97 | <li class="toctree-l2"><a class="reference internal" href="#classes">Classes</a><ul> |
---|
| 98 | <li class="toctree-l3"><a class="reference internal" href="#module-ControlFile">ControlFile</a></li> |
---|
| 99 | <li class="toctree-l3"><a class="reference internal" href="#module-EcFlexpart">EcFlexpart</a></li> |
---|
[2625ca8] | 100 | <li class="toctree-l3"><a class="reference internal" href="#module-GribUtil">GribUtil</a></li> |
---|
[274f9ef] | 101 | <li class="toctree-l3"><a class="reference internal" href="#module-MarsRetrieval">MarsRetrieval</a></li> |
---|
| 102 | <li class="toctree-l3"><a class="reference internal" href="#module-UioFiles">UioFiles</a></li> |
---|
| 103 | </ul> |
---|
| 104 | </li> |
---|
| 105 | <li class="toctree-l2"><a class="reference internal" href="#modules">Modules</a><ul> |
---|
| 106 | <li class="toctree-l3"><a class="reference internal" href="#module-get_mars_data">get_mars_data</a></li> |
---|
| 107 | <li class="toctree-l3"><a class="reference internal" href="#module-prepare_flexpart">prepare_flexpart</a></li> |
---|
| 108 | <li class="toctree-l3"><a class="reference internal" href="#module-tools">tools</a></li> |
---|
| 109 | <li class="toctree-l3"><a class="reference internal" href="#module-disaggregation">disaggregation</a></li> |
---|
| 110 | </ul> |
---|
| 111 | </li> |
---|
| 112 | </ul> |
---|
| 113 | </li> |
---|
[708c667] | 114 | <li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li> |
---|
| 115 | </ul> |
---|
| 116 | |
---|
[274f9ef] | 117 | |
---|
| 118 | |
---|
| 119 | </div> |
---|
| 120 | </div> |
---|
| 121 | </nav> |
---|
| 122 | |
---|
| 123 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
---|
| 124 | |
---|
| 125 | |
---|
| 126 | <nav class="wy-nav-top" aria-label="top navigation"> |
---|
| 127 | |
---|
| 128 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
---|
| 129 | <a href="index.html">flex_extract</a> |
---|
| 130 | |
---|
| 131 | </nav> |
---|
| 132 | |
---|
| 133 | |
---|
| 134 | <div class="wy-nav-content"> |
---|
| 135 | |
---|
| 136 | <div class="rst-content"> |
---|
| 137 | |
---|
| 138 | |
---|
| 139 | |
---|
| 140 | |
---|
| 141 | |
---|
| 142 | |
---|
| 143 | |
---|
| 144 | |
---|
| 145 | |
---|
| 146 | |
---|
| 147 | |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | |
---|
| 151 | |
---|
| 152 | |
---|
| 153 | |
---|
| 154 | <div role="navigation" aria-label="breadcrumbs navigation"> |
---|
| 155 | |
---|
| 156 | <ul class="wy-breadcrumbs"> |
---|
| 157 | |
---|
| 158 | <li><a href="index.html">Docs</a> »</li> |
---|
| 159 | |
---|
| 160 | <li>Auto Generated Documentation</li> |
---|
| 161 | |
---|
| 162 | |
---|
| 163 | <li class="wy-breadcrumbs-aside"> |
---|
| 164 | |
---|
| 165 | |
---|
| 166 | <a href="_sources/api.rst.txt" rel="nofollow"> View page source</a> |
---|
| 167 | |
---|
| 168 | |
---|
| 169 | </li> |
---|
| 170 | |
---|
| 171 | </ul> |
---|
| 172 | |
---|
| 173 | |
---|
| 174 | <hr/> |
---|
| 175 | </div> |
---|
| 176 | <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
---|
| 177 | <div itemprop="articleBody"> |
---|
| 178 | |
---|
| 179 | <div class="section" id="auto-generated-documentation"> |
---|
| 180 | <h1>Auto Generated Documentation<a class="headerlink" href="#auto-generated-documentation" title="Permalink to this headline">¶</a></h1> |
---|
| 181 | <div class="contents local topic" id="contents"> |
---|
| 182 | <ul class="simple"> |
---|
| 183 | <li><a class="reference internal" href="#porgrams" id="id1">Porgrams</a><ul> |
---|
| 184 | <li><a class="reference internal" href="#module-install" id="id2">install</a></li> |
---|
| 185 | <li><a class="reference internal" href="#module-submit" id="id3">submit</a></li> |
---|
| 186 | </ul> |
---|
| 187 | </li> |
---|
| 188 | <li><a class="reference internal" href="#classes" id="id4">Classes</a><ul> |
---|
| 189 | <li><a class="reference internal" href="#module-ControlFile" id="id5">ControlFile</a></li> |
---|
| 190 | <li><a class="reference internal" href="#module-EcFlexpart" id="id6">EcFlexpart</a></li> |
---|
[2625ca8] | 191 | <li><a class="reference internal" href="#module-GribUtil" id="id7">GribUtil</a></li> |
---|
[274f9ef] | 192 | <li><a class="reference internal" href="#module-MarsRetrieval" id="id8">MarsRetrieval</a></li> |
---|
| 193 | <li><a class="reference internal" href="#module-UioFiles" id="id9">UioFiles</a></li> |
---|
| 194 | </ul> |
---|
| 195 | </li> |
---|
| 196 | <li><a class="reference internal" href="#modules" id="id10">Modules</a><ul> |
---|
| 197 | <li><a class="reference internal" href="#module-get_mars_data" id="id11">get_mars_data</a></li> |
---|
| 198 | <li><a class="reference internal" href="#module-prepare_flexpart" id="id12">prepare_flexpart</a></li> |
---|
| 199 | <li><a class="reference internal" href="#module-tools" id="id13">tools</a></li> |
---|
| 200 | <li><a class="reference internal" href="#module-disaggregation" id="id14">disaggregation</a></li> |
---|
| 201 | </ul> |
---|
| 202 | </li> |
---|
| 203 | </ul> |
---|
| 204 | </div> |
---|
| 205 | <div class="section" id="porgrams"> |
---|
| 206 | <h2><a class="toc-backref" href="#id1">Porgrams</a><a class="headerlink" href="#porgrams" title="Permalink to this headline">¶</a></h2> |
---|
| 207 | <div class="section" id="module-install"> |
---|
| 208 | <span id="install"></span><h3><a class="toc-backref" href="#id2">install</a><a class="headerlink" href="#module-install" title="Permalink to this headline">¶</a></h3> |
---|
[2625ca8] | 209 | <p>This script installs the flex_extract program.</p> |
---|
| 210 | <p>Depending on the selected installation environment (locally or on the |
---|
| 211 | ECMWF server ecgate or cca) the program extracts the commandline |
---|
| 212 | arguments and the CONTROL file parameter and prepares the corresponding |
---|
| 213 | environment. |
---|
| 214 | The necessary files are collected in a tar-ball and placed |
---|
| 215 | at the target location. There its untared, the environment variables will |
---|
| 216 | be set and the Fortran code will be compiled. |
---|
| 217 | If the ECMWF environment is selected a job script is prepared and submitted |
---|
| 218 | for the remaining configurations after putting the tar-ball to the |
---|
| 219 | target ECMWF server.</p> |
---|
| 220 | <p>Type: install.py –help |
---|
| 221 | to get information about command line parameters. |
---|
| 222 | Read the documentation for usage instructions.</p> |
---|
[274f9ef] | 223 | <dl class="function"> |
---|
[2625ca8] | 224 | <dt id="install.check_install_conditions"> |
---|
| 225 | <code class="descclassname">install.</code><code class="descname">check_install_conditions</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#check_install_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.check_install_conditions" title="Permalink to this definition">¶</a></dt> |
---|
| 226 | <dd><p>Checks a couple of necessary attributes and conditions |
---|
| 227 | for the installation such as if they exist and contain values. |
---|
| 228 | Otherwise set default values.</p> |
---|
| 229 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 230 | <col class="field-name" /> |
---|
| 231 | <col class="field-body" /> |
---|
| 232 | <tbody valign="top"> |
---|
| 233 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
| 234 | command line.</td> |
---|
| 235 | </tr> |
---|
| 236 | </tbody> |
---|
| 237 | </table> |
---|
| 238 | </dd></dl> |
---|
| 239 | |
---|
| 240 | <dl class="function"> |
---|
| 241 | <dt id="install.del_convert_build"> |
---|
| 242 | <code class="descclassname">install.</code><code class="descname">del_convert_build</code><span class="sig-paren">(</span><em>src_path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#del_convert_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.del_convert_build" title="Permalink to this definition">¶</a></dt> |
---|
[274f9ef] | 243 | <dd><p>Clean up the Fortran source directory and remove all |
---|
| 244 | build files (e.g. *.o, *.mod and CONVERT2)</p> |
---|
| 245 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 246 | <col class="field-name" /> |
---|
| 247 | <col class="field-body" /> |
---|
| 248 | <tbody valign="top"> |
---|
[2625ca8] | 249 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>src_path</strong> (<em>str</em>) – Path to the fortran source directory.</td> |
---|
[274f9ef] | 250 | </tr> |
---|
| 251 | </tbody> |
---|
| 252 | </table> |
---|
| 253 | </dd></dl> |
---|
| 254 | |
---|
| 255 | <dl class="function"> |
---|
[2625ca8] | 256 | <dt id="install.get_install_cmdline_args"> |
---|
| 257 | <code class="descclassname">install.</code><code class="descname">get_install_cmdline_args</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#get_install_cmdline_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.get_install_cmdline_args" title="Permalink to this definition">¶</a></dt> |
---|
[274f9ef] | 258 | <dd><p>Decomposes the command line arguments and assigns them to variables. |
---|
| 259 | Apply default values for non mentioned arguments.</p> |
---|
| 260 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 261 | <col class="field-name" /> |
---|
| 262 | <col class="field-body" /> |
---|
| 263 | <tbody valign="top"> |
---|
| 264 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>args</strong> – Contains the commandline arguments from script/program call.</td> |
---|
| 265 | </tr> |
---|
[2625ca8] | 266 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Namespace</td> |
---|
[274f9ef] | 267 | </tr> |
---|
| 268 | </tbody> |
---|
| 269 | </table> |
---|
| 270 | </dd></dl> |
---|
| 271 | |
---|
| 272 | <dl class="function"> |
---|
| 273 | <dt id="install.install_via_gateway"> |
---|
| 274 | <code class="descclassname">install.</code><code class="descname">install_via_gateway</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#install_via_gateway"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.install_via_gateway" title="Permalink to this definition">¶</a></dt> |
---|
| 275 | <dd><p>Perform the actual installation on local machine or prepare data |
---|
| 276 | transfer to remote gate and submit a job script which will |
---|
| 277 | install everything on the remote gate.</p> |
---|
| 278 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 279 | <col class="field-name" /> |
---|
| 280 | <col class="field-body" /> |
---|
| 281 | <tbody valign="top"> |
---|
[2625ca8] | 282 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
[274f9ef] | 283 | command line.</td> |
---|
| 284 | </tr> |
---|
| 285 | </tbody> |
---|
| 286 | </table> |
---|
| 287 | </dd></dl> |
---|
| 288 | |
---|
| 289 | <dl class="function"> |
---|
| 290 | <dt id="install.main"> |
---|
| 291 | <code class="descclassname">install.</code><code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.main" title="Permalink to this definition">¶</a></dt> |
---|
| 292 | <dd><p>Controls the installation process. Calls the installation function |
---|
| 293 | if target is specified.</p> |
---|
| 294 | </dd></dl> |
---|
| 295 | |
---|
| 296 | <dl class="function"> |
---|
[2625ca8] | 297 | <dt id="install.mk_compilejob"> |
---|
| 298 | <code class="descclassname">install.</code><code class="descname">mk_compilejob</code><span class="sig-paren">(</span><em>makefile</em>, <em>target</em>, <em>ecuid</em>, <em>ecgid</em>, <em>fp_root</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#mk_compilejob"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_compilejob" title="Permalink to this definition">¶</a></dt> |
---|
| 299 | <dd><p>Modifies the original job template file so that it is specified |
---|
| 300 | for the user and the environment were it will be applied. Result |
---|
| 301 | is stored in a new file “job.temp” in the python directory.</p> |
---|
[274f9ef] | 302 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 303 | <col class="field-name" /> |
---|
| 304 | <col class="field-body" /> |
---|
| 305 | <tbody valign="top"> |
---|
| 306 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[2625ca8] | 307 | <li><strong>makefile</strong> (<em>str</em>) – Name of the makefile which should be used to compile FORTRAN |
---|
| 308 | CONVERT2 program.</li> |
---|
| 309 | <li><strong>target</strong> (<em>str</em>) – The target where the installation should be done, e.g. the queue.</li> |
---|
| 310 | <li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li> |
---|
| 311 | <li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li> |
---|
| 312 | <li><strong>fp_root</strong> (<em>str</em>) – Path to the root directory of FLEXPART environment or flex_extract |
---|
| 313 | environment.</li> |
---|
[274f9ef] | 314 | </ul> |
---|
| 315 | </td> |
---|
| 316 | </tr> |
---|
| 317 | </tbody> |
---|
| 318 | </table> |
---|
| 319 | </dd></dl> |
---|
| 320 | |
---|
| 321 | <dl class="function"> |
---|
[2625ca8] | 322 | <dt id="install.mk_convert_build"> |
---|
| 323 | <code class="descclassname">install.</code><code class="descname">mk_convert_build</code><span class="sig-paren">(</span><em>src_path</em>, <em>makefile</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#mk_convert_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_convert_build" title="Permalink to this definition">¶</a></dt> |
---|
| 324 | <dd><p>Compiles the Fortran code and generates the executable.</p> |
---|
[274f9ef] | 325 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 326 | <col class="field-name" /> |
---|
| 327 | <col class="field-body" /> |
---|
| 328 | <tbody valign="top"> |
---|
| 329 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[2625ca8] | 330 | <li><strong>src_path</strong> (<em>str</em>) – Path to the fortran source directory.</li> |
---|
| 331 | <li><strong>makefile</strong> (<em>str</em>) – The name of the makefile which should be used.</li> |
---|
[274f9ef] | 332 | </ul> |
---|
| 333 | </td> |
---|
| 334 | </tr> |
---|
| 335 | </tbody> |
---|
| 336 | </table> |
---|
| 337 | </dd></dl> |
---|
| 338 | |
---|
| 339 | <dl class="function"> |
---|
| 340 | <dt id="install.mk_env_vars"> |
---|
| 341 | <code class="descclassname">install.</code><code class="descname">mk_env_vars</code><span class="sig-paren">(</span><em>ecuid</em>, <em>ecgid</em>, <em>gateway</em>, <em>destination</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#mk_env_vars"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_env_vars" title="Permalink to this definition">¶</a></dt> |
---|
| 342 | <dd><p>Creates a file named ECMWF_ENV which contains the |
---|
| 343 | necessary environmental variables at ECMWF servers. |
---|
| 344 | It is based on the template ECMWF_ENV.template.</p> |
---|
| 345 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 346 | <col class="field-name" /> |
---|
| 347 | <col class="field-body" /> |
---|
| 348 | <tbody valign="top"> |
---|
| 349 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[2625ca8] | 350 | <li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li> |
---|
| 351 | <li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li> |
---|
| 352 | <li><strong>gateway</strong> (<em>str</em>) – The gateway server the user is using.</li> |
---|
| 353 | <li><strong>destination</strong> (<em>str</em>) – The remote destination which is used to transfer files |
---|
[274f9ef] | 354 | from ECMWF server to local gateway server.</li> |
---|
| 355 | </ul> |
---|
| 356 | </td> |
---|
| 357 | </tr> |
---|
| 358 | </tbody> |
---|
| 359 | </table> |
---|
| 360 | </dd></dl> |
---|
| 361 | |
---|
| 362 | <dl class="function"> |
---|
| 363 | <dt id="install.mk_job_template"> |
---|
| 364 | <code class="descclassname">install.</code><code class="descname">mk_job_template</code><span class="sig-paren">(</span><em>ecuid</em>, <em>ecgid</em>, <em>gateway</em>, <em>destination</em>, <em>fp_root</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#mk_job_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_job_template" title="Permalink to this definition">¶</a></dt> |
---|
| 365 | <dd><p>Modifies the original job template file so that it is specified |
---|
| 366 | for the user and the environment were it will be applied. Result |
---|
| 367 | is stored in a new file.</p> |
---|
| 368 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 369 | <col class="field-name" /> |
---|
| 370 | <col class="field-body" /> |
---|
| 371 | <tbody valign="top"> |
---|
| 372 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[2625ca8] | 373 | <li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li> |
---|
| 374 | <li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li> |
---|
| 375 | <li><strong>gateway</strong> (<em>str</em>) – The gateway server the user is using.</li> |
---|
| 376 | <li><strong>destination</strong> (<em>str</em>) – The remote destination which is used to transfer files |
---|
[274f9ef] | 377 | from ECMWF server to local gateway server.</li> |
---|
[2625ca8] | 378 | <li><strong>fp_root</strong> (<em>str</em>) – Path to the root directory of FLEXPART environment or flex_extract |
---|
[274f9ef] | 379 | environment.</li> |
---|
| 380 | </ul> |
---|
| 381 | </td> |
---|
| 382 | </tr> |
---|
| 383 | </tbody> |
---|
| 384 | </table> |
---|
| 385 | </dd></dl> |
---|
| 386 | |
---|
| 387 | <dl class="function"> |
---|
| 388 | <dt id="install.mk_tarball"> |
---|
| 389 | <code class="descclassname">install.</code><code class="descname">mk_tarball</code><span class="sig-paren">(</span><em>tarball_path</em>, <em>target</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#mk_tarball"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_tarball" title="Permalink to this definition">¶</a></dt> |
---|
| 390 | <dd><p>Creates a tarball with all necessary files which need to be sent to the |
---|
| 391 | installation directory. |
---|
| 392 | It does not matter if this is local or remote. |
---|
| 393 | Collects all python files, the Fortran source and makefiles, |
---|
| 394 | the ECMWF_ENV file, the CONTROL files as well as the |
---|
| 395 | template files.</p> |
---|
| 396 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 397 | <col class="field-name" /> |
---|
| 398 | <col class="field-body" /> |
---|
| 399 | <tbody valign="top"> |
---|
| 400 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[2625ca8] | 401 | <li><strong>tarball_path</strong> (<em>str</em>) – The complete path to the tar file which will contain all |
---|
[274f9ef] | 402 | relevant data for flex_extract.</li> |
---|
[2625ca8] | 403 | <li><strong>target</strong> (<em>str</em>) – The queue where the job is submitted to.</li> |
---|
[274f9ef] | 404 | </ul> |
---|
| 405 | </td> |
---|
| 406 | </tr> |
---|
| 407 | </tbody> |
---|
| 408 | </table> |
---|
| 409 | </dd></dl> |
---|
| 410 | |
---|
| 411 | <dl class="function"> |
---|
| 412 | <dt id="install.un_tarball"> |
---|
| 413 | <code class="descclassname">install.</code><code class="descname">un_tarball</code><span class="sig-paren">(</span><em>tarball_path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/install.html#un_tarball"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.un_tarball" title="Permalink to this definition">¶</a></dt> |
---|
| 414 | <dd><p>Extracts the given tarball into current directory.</p> |
---|
| 415 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 416 | <col class="field-name" /> |
---|
| 417 | <col class="field-body" /> |
---|
| 418 | <tbody valign="top"> |
---|
[2625ca8] | 419 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tarball_path</strong> (<em>str</em>) – The complete path to the tar file which will contain all |
---|
[274f9ef] | 420 | relevant data for flex_extract.</td> |
---|
| 421 | </tr> |
---|
| 422 | </tbody> |
---|
| 423 | </table> |
---|
| 424 | </dd></dl> |
---|
| 425 | |
---|
| 426 | </div> |
---|
| 427 | <div class="section" id="module-submit"> |
---|
| 428 | <span id="submit"></span><h3><a class="toc-backref" href="#id3">submit</a><a class="headerlink" href="#module-submit" title="Permalink to this headline">¶</a></h3> |
---|
[2625ca8] | 429 | <p>This script allows the user to extract meteorological fields from the ECMWF.</p> |
---|
| 430 | <p>It prepares the settings for retrieving the data from ECMWF servers and |
---|
| 431 | process the resulting files to prepare them for the use with FLEXPART or |
---|
| 432 | FLEXTRA.</p> |
---|
| 433 | <p>If it is supposed to work locally then it works through the necessary |
---|
| 434 | functions get_mars_data and prepare_flexpart. Otherwise it prepares |
---|
| 435 | a job script (korn shell) which will do the necessary work on the |
---|
| 436 | ECMWF server. This script will de submitted via the ecaccess command |
---|
| 437 | ecaccess-job-submit.</p> |
---|
| 438 | <p>This file can also be imported as a module which then contains the following |
---|
| 439 | functions:</p> |
---|
| 440 | <blockquote> |
---|
| 441 | <div><ul class="simple"> |
---|
| 442 | <li>main - the main function of the script</li> |
---|
| 443 | <li>submit - calls mk_jobscript depending on operation mode and submits its</li> |
---|
| 444 | <li>mk_jobscript - creates the job script from a template</li> |
---|
| 445 | </ul> |
---|
| 446 | </div></blockquote> |
---|
| 447 | <p>Type: submit.py –help |
---|
| 448 | to get information about command line parameters. |
---|
| 449 | Read the documentation for usage instructions.</p> |
---|
[274f9ef] | 450 | <dl class="function"> |
---|
| 451 | <dt id="submit.main"> |
---|
| 452 | <code class="descclassname">submit.</code><code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/submit.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#submit.main" title="Permalink to this definition">¶</a></dt> |
---|
| 453 | <dd><p>Get the arguments from script call and from CONTROL file. |
---|
| 454 | Decides from the argument “queue” if the local version |
---|
| 455 | is done “queue=None” or the gateway version with “queue=ecgate” |
---|
| 456 | or “queue=cca”.</p> |
---|
| 457 | </dd></dl> |
---|
| 458 | |
---|
| 459 | <dl class="function"> |
---|
[2625ca8] | 460 | <dt id="submit.mk_jobscript"> |
---|
| 461 | <code class="descclassname">submit.</code><code class="descname">mk_jobscript</code><span class="sig-paren">(</span><em>jtemplate</em>, <em>job_file</em>, <em>clist</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/submit.html#mk_jobscript"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#submit.mk_jobscript" title="Permalink to this definition">¶</a></dt> |
---|
| 462 | <dd><p>Creates the job script from template.</p> |
---|
| 463 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 464 | <col class="field-name" /> |
---|
| 465 | <col class="field-body" /> |
---|
| 466 | <tbody valign="top"> |
---|
| 467 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 468 | <li><strong>jtemplate</strong> (<em>str</em>) – Job template file from sub-directory “_templates” for |
---|
| 469 | submission to ECMWF. It contains all necessary |
---|
| 470 | module and variable settings for the ECMWF environment as well as |
---|
| 471 | the job call and mail report instructions. |
---|
| 472 | Default is “job.temp”.</li> |
---|
| 473 | <li><strong>job_file</strong> (<em>str</em>) – Path to the job script file.</li> |
---|
| 474 | <li><strong>clist</strong> (<em>list of str</em>) – Contains all necessary parameters for ECMWF CONTROL file.</li> |
---|
| 475 | </ul> |
---|
| 476 | </td> |
---|
| 477 | </tr> |
---|
| 478 | </tbody> |
---|
| 479 | </table> |
---|
| 480 | </dd></dl> |
---|
| 481 | |
---|
| 482 | <dl class="function"> |
---|
[274f9ef] | 483 | <dt id="submit.submit"> |
---|
| 484 | <code class="descclassname">submit.</code><code class="descname">submit</code><span class="sig-paren">(</span><em>jtemplate</em>, <em>c</em>, <em>queue</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/submit.html#submit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#submit.submit" title="Permalink to this definition">¶</a></dt> |
---|
[2625ca8] | 485 | <dd><p>Prepares the job script and submits it to the specified queue.</p> |
---|
[274f9ef] | 486 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 487 | <col class="field-name" /> |
---|
| 488 | <col class="field-body" /> |
---|
| 489 | <tbody valign="top"> |
---|
| 490 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[2625ca8] | 491 | <li><strong>jtemplate</strong> (<em>str</em>) – Job template file from sub-directory “_templates” for |
---|
[274f9ef] | 492 | submission to ECMWF. It contains all necessary |
---|
| 493 | module and variable settings for the ECMWF environment as well as |
---|
| 494 | the job call and mail report instructions. |
---|
| 495 | Default is “job.temp”.</li> |
---|
[2625ca8] | 496 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
[274f9ef] | 497 | command line.</li> |
---|
[2625ca8] | 498 | <li><strong>queue</strong> (<em>str</em>) – Name of queue for submission to ECMWF (e.g. ecgate or cca )</li> |
---|
[274f9ef] | 499 | </ul> |
---|
| 500 | </td> |
---|
| 501 | </tr> |
---|
| 502 | </tbody> |
---|
| 503 | </table> |
---|
| 504 | </dd></dl> |
---|
| 505 | |
---|
| 506 | </div> |
---|
| 507 | </div> |
---|
| 508 | <div class="section" id="classes"> |
---|
| 509 | <h2><a class="toc-backref" href="#id4">Classes</a><a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2> |
---|
| 510 | <div class="section" id="module-ControlFile"> |
---|
| 511 | <span id="controlfile"></span><h3><a class="toc-backref" href="#id5">ControlFile</a><a class="headerlink" href="#module-ControlFile" title="Permalink to this headline">¶</a></h3> |
---|
| 512 | <dl class="class"> |
---|
| 513 | <dt id="ControlFile.ControlFile"> |
---|
| 514 | <em class="property">class </em><code class="descclassname">ControlFile.</code><code class="descname">ControlFile</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ControlFile.html#ControlFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile" title="Permalink to this definition">¶</a></dt> |
---|
| 515 | <dd><p>Contains the information which are stored in the CONTROL files.</p> |
---|
[2625ca8] | 516 | <p>The CONTROL file is the steering part of the FLEXPART extraction |
---|
| 517 | software. All necessary parameters needed to retrieve the data fields |
---|
| 518 | from the MARS archive for driving FLEXPART are set in a CONTROL file. |
---|
| 519 | Some specific parameters like the start and end dates can be overwritten |
---|
| 520 | by the command line parameters, but in generel all parameters needed |
---|
| 521 | for a complete set of fields for FLEXPART can be set in the CONTROL file.</p> |
---|
| 522 | <dl class="attribute"> |
---|
| 523 | <dt id="ControlFile.ControlFile.controlfile"> |
---|
| 524 | <code class="descname">controlfile</code><a class="headerlink" href="#ControlFile.ControlFile.controlfile" title="Permalink to this definition">¶</a></dt> |
---|
| 525 | <dd><p>The name of the control file to be processed. Default value is the |
---|
| 526 | filename passed to the init function when initialised.</p> |
---|
[274f9ef] | 527 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 528 | <col class="field-name" /> |
---|
| 529 | <col class="field-body" /> |
---|
| 530 | <tbody valign="top"> |
---|
[2625ca8] | 531 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
[274f9ef] | 532 | </tr> |
---|
| 533 | </tbody> |
---|
| 534 | </table> |
---|
| 535 | </dd></dl> |
---|
| 536 | |
---|
[2625ca8] | 537 | <dl class="attribute"> |
---|
| 538 | <dt id="ControlFile.ControlFile.start_date"> |
---|
| 539 | <code class="descname">start_date</code><a class="headerlink" href="#ControlFile.ControlFile.start_date" title="Permalink to this definition">¶</a></dt> |
---|
| 540 | <dd><p>The first day of the retrieval period. Default value is None.</p> |
---|
[274f9ef] | 541 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 542 | <col class="field-name" /> |
---|
| 543 | <col class="field-body" /> |
---|
| 544 | <tbody valign="top"> |
---|
[2625ca8] | 545 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
[274f9ef] | 546 | </tr> |
---|
| 547 | </tbody> |
---|
| 548 | </table> |
---|
| 549 | </dd></dl> |
---|
| 550 | |
---|
[2625ca8] | 551 | <dl class="attribute"> |
---|
| 552 | <dt id="ControlFile.ControlFile.end_date"> |
---|
| 553 | <code class="descname">end_date</code><a class="headerlink" href="#ControlFile.ControlFile.end_date" title="Permalink to this definition">¶</a></dt> |
---|
| 554 | <dd><p>The last day of the retrieval period. Default value is None.</p> |
---|
[274f9ef] | 555 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 556 | <col class="field-name" /> |
---|
| 557 | <col class="field-body" /> |
---|
| 558 | <tbody valign="top"> |
---|
[2625ca8] | 559 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
[274f9ef] | 560 | </tr> |
---|
| 561 | </tbody> |
---|
| 562 | </table> |
---|
| 563 | </dd></dl> |
---|
| 564 | |
---|
[2625ca8] | 565 | <dl class="attribute"> |
---|
| 566 | <dt id="ControlFile.ControlFile.date_chunk"> |
---|
| 567 | <code class="descname">date_chunk</code><a class="headerlink" href="#ControlFile.ControlFile.date_chunk" title="Permalink to this definition">¶</a></dt> |
---|
| 568 | <dd><p>Length of period for a single mars retrieval. Default value is 3.</p> |
---|
| 569 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 570 | <col class="field-name" /> |
---|
| 571 | <col class="field-body" /> |
---|
| 572 | <tbody valign="top"> |
---|
| 573 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 574 | </tr> |
---|
| 575 | </tbody> |
---|
| 576 | </table> |
---|
[274f9ef] | 577 | </dd></dl> |
---|
| 578 | |
---|
[2625ca8] | 579 | <dl class="attribute"> |
---|
| 580 | <dt id="ControlFile.ControlFile.dtime"> |
---|
| 581 | <code class="descname">dtime</code><a class="headerlink" href="#ControlFile.ControlFile.dtime" title="Permalink to this definition">¶</a></dt> |
---|
| 582 | <dd><p>The time step in hours. Default value is None.</p> |
---|
[274f9ef] | 583 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 584 | <col class="field-name" /> |
---|
| 585 | <col class="field-body" /> |
---|
| 586 | <tbody valign="top"> |
---|
[2625ca8] | 587 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
[274f9ef] | 588 | </tr> |
---|
[2625ca8] | 589 | </tbody> |
---|
| 590 | </table> |
---|
| 591 | </dd></dl> |
---|
| 592 | |
---|
| 593 | <dl class="attribute"> |
---|
| 594 | <dt id="ControlFile.ControlFile.basetime"> |
---|
| 595 | <code class="descname">basetime</code><a class="headerlink" href="#ControlFile.ControlFile.basetime" title="Permalink to this definition">¶</a></dt> |
---|
| 596 | <dd><p>The time for a half day retrieval. The 12 hours upfront are to be |
---|
| 597 | retrieved. 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> |
---|
[274f9ef] | 603 | </tr> |
---|
| 604 | </tbody> |
---|
| 605 | </table> |
---|
| 606 | </dd></dl> |
---|
| 607 | |
---|
[2625ca8] | 608 | <dl class="attribute"> |
---|
| 609 | <dt id="ControlFile.ControlFile.maxstep"> |
---|
| 610 | <code class="descname">maxstep</code><a class="headerlink" href="#ControlFile.ControlFile.maxstep" title="Permalink to this definition">¶</a></dt> |
---|
| 611 | <dd><p>The maximum forecast step for non flux data. Default value is None.</p> |
---|
| 612 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 613 | <col class="field-name" /> |
---|
| 614 | <col class="field-body" /> |
---|
| 615 | <tbody valign="top"> |
---|
| 616 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 617 | </tr> |
---|
| 618 | </tbody> |
---|
| 619 | </table> |
---|
[274f9ef] | 620 | </dd></dl> |
---|
| 621 | |
---|
[2625ca8] | 622 | <dl class="attribute"> |
---|
| 623 | <dt id="ControlFile.ControlFile.type"> |
---|
| 624 | <code class="descname">type</code><a class="headerlink" href="#ControlFile.ControlFile.type" title="Permalink to this definition">¶</a></dt> |
---|
| 625 | <dd><p>List of field type per retrieving hour. Default value is None.</p> |
---|
[274f9ef] | 626 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 627 | <col class="field-name" /> |
---|
| 628 | <col class="field-body" /> |
---|
| 629 | <tbody valign="top"> |
---|
[2625ca8] | 630 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
[274f9ef] | 631 | </tr> |
---|
| 632 | </tbody> |
---|
| 633 | </table> |
---|
| 634 | </dd></dl> |
---|
| 635 | |
---|
[2625ca8] | 636 | <dl class="attribute"> |
---|
| 637 | <dt id="ControlFile.ControlFile.time"> |
---|
| 638 | <code class="descname">time</code><a class="headerlink" href="#ControlFile.ControlFile.time" title="Permalink to this definition">¶</a></dt> |
---|
| 639 | <dd><p>List of retrieving times in hours. Default valuer is None.</p> |
---|
[274f9ef] | 640 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 641 | <col class="field-name" /> |
---|
| 642 | <col class="field-body" /> |
---|
| 643 | <tbody valign="top"> |
---|
[2625ca8] | 644 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
[274f9ef] | 645 | </tr> |
---|
| 646 | </tbody> |
---|
| 647 | </table> |
---|
| 648 | </dd></dl> |
---|
| 649 | |
---|
[2625ca8] | 650 | <dl class="attribute"> |
---|
| 651 | <dt id="ControlFile.ControlFile.step"> |
---|
| 652 | <code class="descname">step</code><a class="headerlink" href="#ControlFile.ControlFile.step" title="Permalink to this definition">¶</a></dt> |
---|
| 653 | <dd><p>List of forecast time steps in hours for non flux data. |
---|
| 654 | Default value is None.</p> |
---|
[274f9ef] | 655 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 656 | <col class="field-name" /> |
---|
| 657 | <col class="field-body" /> |
---|
| 658 | <tbody valign="top"> |
---|
[2625ca8] | 659 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str or str</td> |
---|
[274f9ef] | 660 | </tr> |
---|
| 661 | </tbody> |
---|
| 662 | </table> |
---|
| 663 | </dd></dl> |
---|
| 664 | |
---|
[2625ca8] | 665 | <dl class="attribute"> |
---|
| 666 | <dt id="ControlFile.ControlFile.acctype"> |
---|
| 667 | <code class="descname">acctype</code><a class="headerlink" href="#ControlFile.ControlFile.acctype" title="Permalink to this definition">¶</a></dt> |
---|
| 668 | <dd><p>The field type for the accumulated forecast fields. |
---|
| 669 | Default value is None.</p> |
---|
[274f9ef] | 670 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 671 | <col class="field-name" /> |
---|
| 672 | <col class="field-body" /> |
---|
| 673 | <tbody valign="top"> |
---|
[2625ca8] | 674 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
[274f9ef] | 675 | </tr> |
---|
| 676 | </tbody> |
---|
| 677 | </table> |
---|
| 678 | </dd></dl> |
---|
| 679 | |
---|
[2625ca8] | 680 | <dl class="attribute"> |
---|
| 681 | <dt id="ControlFile.ControlFile.acctime"> |
---|
| 682 | <code class="descname">acctime</code><a class="headerlink" href="#ControlFile.ControlFile.acctime" title="Permalink to this definition">¶</a></dt> |
---|
| 683 | <dd><p>The starting time of the accumulated forecasts. Default value is None.</p> |
---|
[274f9ef] | 684 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 685 | <col class="field-name" /> |
---|
| 686 | <col class="field-body" /> |
---|
| 687 | <tbody valign="top"> |
---|
[2625ca8] | 688 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
[274f9ef] | 689 | </tr> |
---|
| 690 | </tbody> |
---|
| 691 | </table> |
---|
| 692 | </dd></dl> |
---|
| 693 | |
---|
[2625ca8] | 694 | <dl class="attribute"> |
---|
| 695 | <dt id="ControlFile.ControlFile.accmaxstep"> |
---|
| 696 | <code class="descname">accmaxstep</code><a class="headerlink" href="#ControlFile.ControlFile.accmaxstep" title="Permalink to this definition">¶</a></dt> |
---|
| 697 | <dd><p>The maximum forecast step for the accumulated forecast fields |
---|
| 698 | (flux data). Default value is None.</p> |
---|
| 699 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 700 | <col class="field-name" /> |
---|
| 701 | <col class="field-body" /> |
---|
| 702 | <tbody valign="top"> |
---|
| 703 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 704 | </tr> |
---|
| 705 | </tbody> |
---|
| 706 | </table> |
---|
| 707 | </dd></dl> |
---|
| 708 | |
---|
| 709 | <dl class="attribute"> |
---|
| 710 | <dt id="ControlFile.ControlFile.marsclass"> |
---|
| 711 | <code class="descname">marsclass</code><a class="headerlink" href="#ControlFile.ControlFile.marsclass" title="Permalink to this definition">¶</a></dt> |
---|
| 712 | <dd><p>Characterisation of dataset. Default value is None.</p> |
---|
| 713 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 714 | <col class="field-name" /> |
---|
| 715 | <col class="field-body" /> |
---|
| 716 | <tbody valign="top"> |
---|
| 717 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 718 | </tr> |
---|
| 719 | </tbody> |
---|
| 720 | </table> |
---|
| 721 | </dd></dl> |
---|
| 722 | |
---|
| 723 | <dl class="attribute"> |
---|
| 724 | <dt id="ControlFile.ControlFile.dataset"> |
---|
| 725 | <code class="descname">dataset</code><a class="headerlink" href="#ControlFile.ControlFile.dataset" title="Permalink to this definition">¶</a></dt> |
---|
| 726 | <dd><p>For public datasets there is the specific naming and parameter |
---|
| 727 | dataset which has to be used to characterize the type of |
---|
| 728 | data. Default value is None.</p> |
---|
| 729 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 730 | <col class="field-name" /> |
---|
| 731 | <col class="field-body" /> |
---|
| 732 | <tbody valign="top"> |
---|
| 733 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 734 | </tr> |
---|
| 735 | </tbody> |
---|
| 736 | </table> |
---|
| 737 | </dd></dl> |
---|
| 738 | |
---|
| 739 | <dl class="attribute"> |
---|
| 740 | <dt id="ControlFile.ControlFile.stream"> |
---|
| 741 | <code class="descname">stream</code><a class="headerlink" href="#ControlFile.ControlFile.stream" title="Permalink to this definition">¶</a></dt> |
---|
| 742 | <dd><p>Identifies the forecasting system used to generate the data. |
---|
| 743 | Default value is None.</p> |
---|
| 744 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 745 | <col class="field-name" /> |
---|
| 746 | <col class="field-body" /> |
---|
| 747 | <tbody valign="top"> |
---|
| 748 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 749 | </tr> |
---|
| 750 | </tbody> |
---|
| 751 | </table> |
---|
| 752 | </dd></dl> |
---|
| 753 | |
---|
| 754 | <dl class="attribute"> |
---|
| 755 | <dt id="ControlFile.ControlFile.number"> |
---|
| 756 | <code class="descname">number</code><a class="headerlink" href="#ControlFile.ControlFile.number" title="Permalink to this definition">¶</a></dt> |
---|
| 757 | <dd><p>Selects the member in ensemble forecast run. Default value is ‘OFF’.</p> |
---|
| 758 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 759 | <col class="field-name" /> |
---|
| 760 | <col class="field-body" /> |
---|
| 761 | <tbody valign="top"> |
---|
| 762 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 763 | </tr> |
---|
| 764 | </tbody> |
---|
| 765 | </table> |
---|
| 766 | </dd></dl> |
---|
| 767 | |
---|
| 768 | <dl class="attribute"> |
---|
| 769 | <dt id="ControlFile.ControlFile.expver"> |
---|
| 770 | <code class="descname">expver</code><a class="headerlink" href="#ControlFile.ControlFile.expver" title="Permalink to this definition">¶</a></dt> |
---|
| 771 | <dd><p>The version number of the dataset. Default value is ‘1’.</p> |
---|
| 772 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 773 | <col class="field-name" /> |
---|
| 774 | <col class="field-body" /> |
---|
| 775 | <tbody valign="top"> |
---|
| 776 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 777 | </tr> |
---|
| 778 | </tbody> |
---|
| 779 | </table> |
---|
| 780 | </dd></dl> |
---|
| 781 | |
---|
| 782 | <dl class="attribute"> |
---|
| 783 | <dt id="ControlFile.ControlFile.gaussian"> |
---|
| 784 | <code class="descname">gaussian</code><a class="headerlink" href="#ControlFile.ControlFile.gaussian" title="Permalink to this definition">¶</a></dt> |
---|
| 785 | <dd><p>This parameter is deprecated and should no longer be used. |
---|
| 786 | Specifies the desired type of Gaussian grid for the output. |
---|
| 787 | Default value is an empty string ‘’.</p> |
---|
| 788 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 789 | <col class="field-name" /> |
---|
| 790 | <col class="field-body" /> |
---|
| 791 | <tbody valign="top"> |
---|
| 792 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 793 | </tr> |
---|
| 794 | </tbody> |
---|
| 795 | </table> |
---|
| 796 | </dd></dl> |
---|
| 797 | |
---|
| 798 | <dl class="attribute"> |
---|
| 799 | <dt id="ControlFile.ControlFile.grid"> |
---|
| 800 | <code class="descname">grid</code><a class="headerlink" href="#ControlFile.ControlFile.grid" title="Permalink to this definition">¶</a></dt> |
---|
| 801 | <dd><p>Specifies the output grid which can be either a Gaussian grid |
---|
| 802 | or a Latitude/Longitude grid. Default value is None.</p> |
---|
| 803 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 804 | <col class="field-name" /> |
---|
| 805 | <col class="field-body" /> |
---|
| 806 | <tbody valign="top"> |
---|
| 807 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 808 | </tr> |
---|
| 809 | </tbody> |
---|
| 810 | </table> |
---|
| 811 | </dd></dl> |
---|
| 812 | |
---|
| 813 | <dl class="attribute"> |
---|
| 814 | <dt id="ControlFile.ControlFile.area"> |
---|
| 815 | <code class="descname">area</code><a class="headerlink" href="#ControlFile.ControlFile.area" title="Permalink to this definition">¶</a></dt> |
---|
| 816 | <dd><p>Specifies the desired sub-area of data to be extracted. |
---|
| 817 | Default value is None.</p> |
---|
| 818 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 819 | <col class="field-name" /> |
---|
| 820 | <col class="field-body" /> |
---|
| 821 | <tbody valign="top"> |
---|
| 822 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 823 | </tr> |
---|
| 824 | </tbody> |
---|
| 825 | </table> |
---|
| 826 | </dd></dl> |
---|
| 827 | |
---|
| 828 | <dl class="attribute"> |
---|
| 829 | <dt id="ControlFile.ControlFile.left"> |
---|
| 830 | <code class="descname">left</code><a class="headerlink" href="#ControlFile.ControlFile.left" title="Permalink to this definition">¶</a></dt> |
---|
| 831 | <dd><p>The western most longitude of the area to be extracted. |
---|
| 832 | Default value is None.</p> |
---|
| 833 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 834 | <col class="field-name" /> |
---|
| 835 | <col class="field-body" /> |
---|
| 836 | <tbody valign="top"> |
---|
| 837 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 838 | </tr> |
---|
| 839 | </tbody> |
---|
| 840 | </table> |
---|
| 841 | </dd></dl> |
---|
| 842 | |
---|
| 843 | <dl class="attribute"> |
---|
| 844 | <dt id="ControlFile.ControlFile.lower"> |
---|
| 845 | <code class="descname">lower</code><a class="headerlink" href="#ControlFile.ControlFile.lower" title="Permalink to this definition">¶</a></dt> |
---|
| 846 | <dd><p>The southern most latitude of the area to be extracted. |
---|
| 847 | Default value is None.</p> |
---|
| 848 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 849 | <col class="field-name" /> |
---|
| 850 | <col class="field-body" /> |
---|
| 851 | <tbody valign="top"> |
---|
| 852 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 853 | </tr> |
---|
| 854 | </tbody> |
---|
| 855 | </table> |
---|
| 856 | </dd></dl> |
---|
| 857 | |
---|
| 858 | <dl class="attribute"> |
---|
| 859 | <dt id="ControlFile.ControlFile.upper"> |
---|
| 860 | <code class="descname">upper</code><a class="headerlink" href="#ControlFile.ControlFile.upper" title="Permalink to this definition">¶</a></dt> |
---|
| 861 | <dd><p>The northern most latitued of the area to be extracted. |
---|
| 862 | Default value is None.</p> |
---|
| 863 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 864 | <col class="field-name" /> |
---|
| 865 | <col class="field-body" /> |
---|
| 866 | <tbody valign="top"> |
---|
| 867 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 868 | </tr> |
---|
| 869 | </tbody> |
---|
| 870 | </table> |
---|
| 871 | </dd></dl> |
---|
| 872 | |
---|
| 873 | <dl class="attribute"> |
---|
| 874 | <dt id="ControlFile.ControlFile.right"> |
---|
| 875 | <code class="descname">right</code><a class="headerlink" href="#ControlFile.ControlFile.right" title="Permalink to this definition">¶</a></dt> |
---|
| 876 | <dd><p>The eastern most longitude of the area to be extracted. |
---|
| 877 | Default value is None.</p> |
---|
| 878 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 879 | <col class="field-name" /> |
---|
| 880 | <col class="field-body" /> |
---|
| 881 | <tbody valign="top"> |
---|
| 882 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 883 | </tr> |
---|
| 884 | </tbody> |
---|
| 885 | </table> |
---|
| 886 | </dd></dl> |
---|
| 887 | |
---|
| 888 | <dl class="attribute"> |
---|
| 889 | <dt id="ControlFile.ControlFile.level"> |
---|
| 890 | <code class="descname">level</code><a class="headerlink" href="#ControlFile.ControlFile.level" title="Permalink to this definition">¶</a></dt> |
---|
| 891 | <dd><p>Specifies the maximum level. Default value is None.</p> |
---|
| 892 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 893 | <col class="field-name" /> |
---|
| 894 | <col class="field-body" /> |
---|
| 895 | <tbody valign="top"> |
---|
| 896 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 897 | </tr> |
---|
| 898 | </tbody> |
---|
| 899 | </table> |
---|
| 900 | </dd></dl> |
---|
| 901 | |
---|
| 902 | <dl class="attribute"> |
---|
| 903 | <dt id="ControlFile.ControlFile.levelist"> |
---|
| 904 | <code class="descname">levelist</code><a class="headerlink" href="#ControlFile.ControlFile.levelist" title="Permalink to this definition">¶</a></dt> |
---|
| 905 | <dd><p>Specifies the required level list. Default value is None.</p> |
---|
| 906 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 907 | <col class="field-name" /> |
---|
| 908 | <col class="field-body" /> |
---|
| 909 | <tbody valign="top"> |
---|
| 910 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 911 | </tr> |
---|
| 912 | </tbody> |
---|
| 913 | </table> |
---|
| 914 | </dd></dl> |
---|
| 915 | |
---|
| 916 | <dl class="attribute"> |
---|
| 917 | <dt id="ControlFile.ControlFile.resol"> |
---|
| 918 | <code class="descname">resol</code><a class="headerlink" href="#ControlFile.ControlFile.resol" title="Permalink to this definition">¶</a></dt> |
---|
| 919 | <dd><p>Specifies the desired triangular truncation of retrieved data, |
---|
| 920 | before carrying out any other selected post-processing. |
---|
| 921 | Default value is None.</p> |
---|
| 922 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 923 | <col class="field-name" /> |
---|
| 924 | <col class="field-body" /> |
---|
| 925 | <tbody valign="top"> |
---|
| 926 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 927 | </tr> |
---|
| 928 | </tbody> |
---|
| 929 | </table> |
---|
| 930 | </dd></dl> |
---|
| 931 | |
---|
| 932 | <dl class="attribute"> |
---|
| 933 | <dt id="ControlFile.ControlFile.gauss"> |
---|
| 934 | <code class="descname">gauss</code><a class="headerlink" href="#ControlFile.ControlFile.gauss" title="Permalink to this definition">¶</a></dt> |
---|
| 935 | <dd><p>Switch to select gaussian fields (1) or regular lat/lon (0). |
---|
| 936 | Default value is 0.</p> |
---|
| 937 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 938 | <col class="field-name" /> |
---|
| 939 | <col class="field-body" /> |
---|
| 940 | <tbody valign="top"> |
---|
| 941 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 942 | </tr> |
---|
| 943 | </tbody> |
---|
| 944 | </table> |
---|
| 945 | </dd></dl> |
---|
| 946 | |
---|
| 947 | <dl class="attribute"> |
---|
| 948 | <dt id="ControlFile.ControlFile.accuracy"> |
---|
| 949 | <code class="descname">accuracy</code><a class="headerlink" href="#ControlFile.ControlFile.accuracy" title="Permalink to this definition">¶</a></dt> |
---|
| 950 | <dd><p>Specifies the number of bits per value to be used in the |
---|
| 951 | generated GRIB coded fields. Default value is 24.</p> |
---|
| 952 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 953 | <col class="field-name" /> |
---|
| 954 | <col class="field-body" /> |
---|
| 955 | <tbody valign="top"> |
---|
| 956 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 957 | </tr> |
---|
| 958 | </tbody> |
---|
| 959 | </table> |
---|
| 960 | </dd></dl> |
---|
| 961 | |
---|
| 962 | <dl class="attribute"> |
---|
| 963 | <dt id="ControlFile.ControlFile.omega"> |
---|
| 964 | <code class="descname">omega</code><a class="headerlink" href="#ControlFile.ControlFile.omega" title="Permalink to this definition">¶</a></dt> |
---|
| 965 | <dd><p>Switch to select omega retrieval (1) or not (0). Default value is 0.</p> |
---|
| 966 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 967 | <col class="field-name" /> |
---|
| 968 | <col class="field-body" /> |
---|
| 969 | <tbody valign="top"> |
---|
| 970 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 971 | </tr> |
---|
| 972 | </tbody> |
---|
| 973 | </table> |
---|
| 974 | </dd></dl> |
---|
| 975 | |
---|
| 976 | <dl class="attribute"> |
---|
| 977 | <dt id="ControlFile.ControlFile.omegadiff"> |
---|
| 978 | <code class="descname">omegadiff</code><a class="headerlink" href="#ControlFile.ControlFile.omegadiff" title="Permalink to this definition">¶</a></dt> |
---|
| 979 | <dd><p>Switch to decide to calculate Omega and Dps/Dt from continuity |
---|
| 980 | equation for diagnostic purposes (1) or not (0). Default value is 0.</p> |
---|
| 981 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 982 | <col class="field-name" /> |
---|
| 983 | <col class="field-body" /> |
---|
| 984 | <tbody valign="top"> |
---|
| 985 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 986 | </tr> |
---|
| 987 | </tbody> |
---|
| 988 | </table> |
---|
| 989 | </dd></dl> |
---|
| 990 | |
---|
| 991 | <dl class="attribute"> |
---|
| 992 | <dt id="ControlFile.ControlFile.eta"> |
---|
| 993 | <code class="descname">eta</code><a class="headerlink" href="#ControlFile.ControlFile.eta" title="Permalink to this definition">¶</a></dt> |
---|
| 994 | <dd><p>Switch to select direct retrieval of etadot from MARS (1) or |
---|
| 995 | wether it has to be calculated (0). Then Default value is 0.</p> |
---|
| 996 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 997 | <col class="field-name" /> |
---|
| 998 | <col class="field-body" /> |
---|
| 999 | <tbody valign="top"> |
---|
| 1000 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1001 | </tr> |
---|
| 1002 | </tbody> |
---|
| 1003 | </table> |
---|
| 1004 | </dd></dl> |
---|
| 1005 | |
---|
| 1006 | <dl class="attribute"> |
---|
| 1007 | <dt id="ControlFile.ControlFile.etadiff"> |
---|
| 1008 | <code class="descname">etadiff</code><a class="headerlink" href="#ControlFile.ControlFile.etadiff" title="Permalink to this definition">¶</a></dt> |
---|
| 1009 | <dd><p>Switch to select calculation of etadot and Dps/Dt from continuity |
---|
| 1010 | equation for diagnostic purposes (1) or not (0). Default value is 0.</p> |
---|
| 1011 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1012 | <col class="field-name" /> |
---|
| 1013 | <col class="field-body" /> |
---|
| 1014 | <tbody valign="top"> |
---|
| 1015 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1016 | </tr> |
---|
| 1017 | </tbody> |
---|
| 1018 | </table> |
---|
| 1019 | </dd></dl> |
---|
| 1020 | |
---|
| 1021 | <dl class="attribute"> |
---|
| 1022 | <dt id="ControlFile.ControlFile.etapar"> |
---|
| 1023 | <code class="descname">etapar</code><a class="headerlink" href="#ControlFile.ControlFile.etapar" title="Permalink to this definition">¶</a></dt> |
---|
| 1024 | <dd><p>GRIB parameter Id for etadot fields. Default value is 77.</p> |
---|
| 1025 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1026 | <col class="field-name" /> |
---|
| 1027 | <col class="field-body" /> |
---|
| 1028 | <tbody valign="top"> |
---|
| 1029 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1030 | </tr> |
---|
| 1031 | </tbody> |
---|
| 1032 | </table> |
---|
| 1033 | </dd></dl> |
---|
| 1034 | |
---|
| 1035 | <dl class="attribute"> |
---|
| 1036 | <dt id="ControlFile.ControlFile.dpdeta"> |
---|
| 1037 | <code class="descname">dpdeta</code><a class="headerlink" href="#ControlFile.ControlFile.dpdeta" title="Permalink to this definition">¶</a></dt> |
---|
| 1038 | <dd><p>Switch to select multiplication of etadot with dpdeta. |
---|
| 1039 | Default value is 1.</p> |
---|
| 1040 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1041 | <col class="field-name" /> |
---|
| 1042 | <col class="field-body" /> |
---|
| 1043 | <tbody valign="top"> |
---|
| 1044 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1045 | </tr> |
---|
| 1046 | </tbody> |
---|
| 1047 | </table> |
---|
| 1048 | </dd></dl> |
---|
| 1049 | |
---|
| 1050 | <dl class="attribute"> |
---|
| 1051 | <dt id="ControlFile.ControlFile.smooth"> |
---|
| 1052 | <code class="descname">smooth</code><a class="headerlink" href="#ControlFile.ControlFile.smooth" title="Permalink to this definition">¶</a></dt> |
---|
| 1053 | <dd><p>Spectral truncation of ETADOT after calculation on Gaussian grid. |
---|
| 1054 | Default value is 0.</p> |
---|
| 1055 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1056 | <col class="field-name" /> |
---|
| 1057 | <col class="field-body" /> |
---|
| 1058 | <tbody valign="top"> |
---|
| 1059 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1060 | </tr> |
---|
| 1061 | </tbody> |
---|
| 1062 | </table> |
---|
| 1063 | </dd></dl> |
---|
| 1064 | |
---|
| 1065 | <dl class="attribute"> |
---|
| 1066 | <dt id="ControlFile.ControlFile.format"> |
---|
| 1067 | <code class="descname">format</code><a class="headerlink" href="#ControlFile.ControlFile.format" title="Permalink to this definition">¶</a></dt> |
---|
| 1068 | <dd><p>The format of the GRIB data. Default value is ‘GRIB1’.</p> |
---|
| 1069 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1070 | <col class="field-name" /> |
---|
| 1071 | <col class="field-body" /> |
---|
| 1072 | <tbody valign="top"> |
---|
| 1073 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1074 | </tr> |
---|
| 1075 | </tbody> |
---|
| 1076 | </table> |
---|
| 1077 | </dd></dl> |
---|
| 1078 | |
---|
| 1079 | <dl class="attribute"> |
---|
| 1080 | <dt id="ControlFile.ControlFile.addpar"> |
---|
| 1081 | <code class="descname">addpar</code><a class="headerlink" href="#ControlFile.ControlFile.addpar" title="Permalink to this definition">¶</a></dt> |
---|
| 1082 | <dd><p>List of additional surface level ECMWF parameter to be retrieved. |
---|
| 1083 | Default value is None.</p> |
---|
| 1084 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1085 | <col class="field-name" /> |
---|
| 1086 | <col class="field-body" /> |
---|
| 1087 | <tbody valign="top"> |
---|
| 1088 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1089 | </tr> |
---|
| 1090 | </tbody> |
---|
| 1091 | </table> |
---|
| 1092 | </dd></dl> |
---|
| 1093 | |
---|
| 1094 | <dl class="attribute"> |
---|
| 1095 | <dt id="ControlFile.ControlFile.prefix"> |
---|
| 1096 | <code class="descname">prefix</code><a class="headerlink" href="#ControlFile.ControlFile.prefix" title="Permalink to this definition">¶</a></dt> |
---|
| 1097 | <dd><p>Prefix string for the final FLEXPART/FLEXTRA ready input files. |
---|
| 1098 | Default value is ‘EN’.</p> |
---|
| 1099 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1100 | <col class="field-name" /> |
---|
| 1101 | <col class="field-body" /> |
---|
| 1102 | <tbody valign="top"> |
---|
| 1103 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1104 | </tr> |
---|
| 1105 | </tbody> |
---|
| 1106 | </table> |
---|
| 1107 | </dd></dl> |
---|
| 1108 | |
---|
| 1109 | <dl class="attribute"> |
---|
| 1110 | <dt id="ControlFile.ControlFile.cwc"> |
---|
| 1111 | <code class="descname">cwc</code><a class="headerlink" href="#ControlFile.ControlFile.cwc" title="Permalink to this definition">¶</a></dt> |
---|
| 1112 | <dd><p>Switch to select wether the sum of cloud liquid water content and |
---|
| 1113 | cloud ice water content should be retrieved. Default value is 0.</p> |
---|
| 1114 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1115 | <col class="field-name" /> |
---|
| 1116 | <col class="field-body" /> |
---|
| 1117 | <tbody valign="top"> |
---|
| 1118 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1119 | </tr> |
---|
| 1120 | </tbody> |
---|
| 1121 | </table> |
---|
| 1122 | </dd></dl> |
---|
| 1123 | |
---|
| 1124 | <dl class="attribute"> |
---|
| 1125 | <dt id="ControlFile.ControlFile.wrf"> |
---|
| 1126 | <code class="descname">wrf</code><a class="headerlink" href="#ControlFile.ControlFile.wrf" title="Permalink to this definition">¶</a></dt> |
---|
| 1127 | <dd><p>Switch to select further parameters for retrievment to support |
---|
| 1128 | WRF simulations. Default value is 0.</p> |
---|
| 1129 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1130 | <col class="field-name" /> |
---|
| 1131 | <col class="field-body" /> |
---|
| 1132 | <tbody valign="top"> |
---|
| 1133 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1134 | </tr> |
---|
| 1135 | </tbody> |
---|
| 1136 | </table> |
---|
| 1137 | </dd></dl> |
---|
| 1138 | |
---|
| 1139 | <dl class="attribute"> |
---|
| 1140 | <dt id="ControlFile.ControlFile.ecfsdir"> |
---|
| 1141 | <code class="descname">ecfsdir</code><a class="headerlink" href="#ControlFile.ControlFile.ecfsdir" title="Permalink to this definition">¶</a></dt> |
---|
| 1142 | <dd><p>Path to the ECMWF storage ‘ectmp:/${USER}/econdemand/’</p> |
---|
| 1143 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1144 | <col class="field-name" /> |
---|
| 1145 | <col class="field-body" /> |
---|
| 1146 | <tbody valign="top"> |
---|
| 1147 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1148 | </tr> |
---|
| 1149 | </tbody> |
---|
| 1150 | </table> |
---|
| 1151 | </dd></dl> |
---|
| 1152 | |
---|
| 1153 | <dl class="attribute"> |
---|
| 1154 | <dt id="ControlFile.ControlFile.mailfail"> |
---|
| 1155 | <code class="descname">mailfail</code><a class="headerlink" href="#ControlFile.ControlFile.mailfail" title="Permalink to this definition">¶</a></dt> |
---|
| 1156 | <dd><p>Email list for sending error log files from ECMWF servers. |
---|
| 1157 | The email addresses should be seperated by a comma. |
---|
| 1158 | Default value is [‘${USER}’].</p> |
---|
| 1159 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1160 | <col class="field-name" /> |
---|
| 1161 | <col class="field-body" /> |
---|
| 1162 | <tbody valign="top"> |
---|
| 1163 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
| 1164 | </tr> |
---|
| 1165 | </tbody> |
---|
| 1166 | </table> |
---|
| 1167 | </dd></dl> |
---|
| 1168 | |
---|
| 1169 | <dl class="attribute"> |
---|
| 1170 | <dt id="ControlFile.ControlFile.mailops"> |
---|
| 1171 | <code class="descname">mailops</code><a class="headerlink" href="#ControlFile.ControlFile.mailops" title="Permalink to this definition">¶</a></dt> |
---|
| 1172 | <dd><p>Email list for sending operational log files from ECMWF servers. |
---|
| 1173 | The email addresses should be seperated by a comma. |
---|
| 1174 | Default value is [‘${USER}’].</p> |
---|
| 1175 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1176 | <col class="field-name" /> |
---|
| 1177 | <col class="field-body" /> |
---|
| 1178 | <tbody valign="top"> |
---|
| 1179 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
| 1180 | </tr> |
---|
| 1181 | </tbody> |
---|
| 1182 | </table> |
---|
| 1183 | </dd></dl> |
---|
| 1184 | |
---|
| 1185 | <dl class="attribute"> |
---|
| 1186 | <dt id="ControlFile.ControlFile.grib2flexpart"> |
---|
| 1187 | <code class="descname">grib2flexpart</code><a class="headerlink" href="#ControlFile.ControlFile.grib2flexpart" title="Permalink to this definition">¶</a></dt> |
---|
| 1188 | <dd><p>Switch to select generation of preprocessed FLEXPART files “.fp”. |
---|
| 1189 | If it is selected, the program grib2flexpart will try |
---|
| 1190 | to convert the flex_extract output files into “.fp” format.</p> |
---|
| 1191 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1192 | <col class="field-name" /> |
---|
| 1193 | <col class="field-body" /> |
---|
| 1194 | <tbody valign="top"> |
---|
| 1195 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int 0</td> |
---|
| 1196 | </tr> |
---|
| 1197 | </tbody> |
---|
| 1198 | </table> |
---|
| 1199 | </dd></dl> |
---|
| 1200 | |
---|
| 1201 | <dl class="attribute"> |
---|
| 1202 | <dt id="ControlFile.ControlFile.ecstorage"> |
---|
| 1203 | <code class="descname">ecstorage</code><a class="headerlink" href="#ControlFile.ControlFile.ecstorage" title="Permalink to this definition">¶</a></dt> |
---|
| 1204 | <dd><p>Switch to select storage of FLEXPART ready output files |
---|
| 1205 | in the ECFS file system. Default value is 0.</p> |
---|
| 1206 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1207 | <col class="field-name" /> |
---|
| 1208 | <col class="field-body" /> |
---|
| 1209 | <tbody valign="top"> |
---|
| 1210 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1211 | </tr> |
---|
| 1212 | </tbody> |
---|
| 1213 | </table> |
---|
| 1214 | </dd></dl> |
---|
| 1215 | |
---|
| 1216 | <dl class="attribute"> |
---|
| 1217 | <dt id="ControlFile.ControlFile.ectrans"> |
---|
| 1218 | <code class="descname">ectrans</code><a class="headerlink" href="#ControlFile.ControlFile.ectrans" title="Permalink to this definition">¶</a></dt> |
---|
| 1219 | <dd><p>Switch to select the transfer of FLEXPART ready output files |
---|
| 1220 | to the gateway server. Default value is 0.</p> |
---|
| 1221 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1222 | <col class="field-name" /> |
---|
| 1223 | <col class="field-body" /> |
---|
| 1224 | <tbody valign="top"> |
---|
| 1225 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1226 | </tr> |
---|
| 1227 | </tbody> |
---|
| 1228 | </table> |
---|
| 1229 | </dd></dl> |
---|
| 1230 | |
---|
| 1231 | <dl class="attribute"> |
---|
| 1232 | <dt id="ControlFile.ControlFile.inputdir"> |
---|
| 1233 | <code class="descname">inputdir</code><a class="headerlink" href="#ControlFile.ControlFile.inputdir" title="Permalink to this definition">¶</a></dt> |
---|
| 1234 | <dd><p>Path to the temporary directory for the retrieval grib files and |
---|
| 1235 | other processing files. Default value is _config.PATH_INPUT_DIR.</p> |
---|
| 1236 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1237 | <col class="field-name" /> |
---|
| 1238 | <col class="field-body" /> |
---|
| 1239 | <tbody valign="top"> |
---|
| 1240 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1241 | </tr> |
---|
| 1242 | </tbody> |
---|
| 1243 | </table> |
---|
| 1244 | </dd></dl> |
---|
| 1245 | |
---|
| 1246 | <dl class="attribute"> |
---|
| 1247 | <dt id="ControlFile.ControlFile.outputdir"> |
---|
| 1248 | <code class="descname">outputdir</code><a class="headerlink" href="#ControlFile.ControlFile.outputdir" title="Permalink to this definition">¶</a></dt> |
---|
| 1249 | <dd><p>Path to the final directory where the final FLEXPART ready input |
---|
| 1250 | files are stored. Default value is None.</p> |
---|
| 1251 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1252 | <col class="field-name" /> |
---|
| 1253 | <col class="field-body" /> |
---|
| 1254 | <tbody valign="top"> |
---|
| 1255 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1256 | </tr> |
---|
| 1257 | </tbody> |
---|
| 1258 | </table> |
---|
| 1259 | </dd></dl> |
---|
| 1260 | |
---|
| 1261 | <dl class="attribute"> |
---|
| 1262 | <dt id="ControlFile.ControlFile.flexextractdir"> |
---|
| 1263 | <code class="descname">flexextractdir</code><a class="headerlink" href="#ControlFile.ControlFile.flexextractdir" title="Permalink to this definition">¶</a></dt> |
---|
| 1264 | <dd><p>Path to the flex_extract root directory. Default value is |
---|
| 1265 | _config.PATH_FLEXEXTRACT_DIR.</p> |
---|
| 1266 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1267 | <col class="field-name" /> |
---|
| 1268 | <col class="field-body" /> |
---|
| 1269 | <tbody valign="top"> |
---|
| 1270 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1271 | </tr> |
---|
| 1272 | </tbody> |
---|
| 1273 | </table> |
---|
| 1274 | </dd></dl> |
---|
| 1275 | |
---|
| 1276 | <dl class="attribute"> |
---|
| 1277 | <dt id="ControlFile.ControlFile.exedir"> |
---|
| 1278 | <code class="descname">exedir</code><a class="headerlink" href="#ControlFile.ControlFile.exedir" title="Permalink to this definition">¶</a></dt> |
---|
| 1279 | <dd><p>Path to the FORTRAN executable file. Default value is |
---|
| 1280 | _config.PATH_FORTRAN_SRC.</p> |
---|
| 1281 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1282 | <col class="field-name" /> |
---|
| 1283 | <col class="field-body" /> |
---|
| 1284 | <tbody valign="top"> |
---|
| 1285 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1286 | </tr> |
---|
| 1287 | </tbody> |
---|
| 1288 | </table> |
---|
| 1289 | </dd></dl> |
---|
| 1290 | |
---|
| 1291 | <dl class="attribute"> |
---|
| 1292 | <dt id="ControlFile.ControlFile.flexpartdir"> |
---|
| 1293 | <code class="descname">flexpartdir</code><a class="headerlink" href="#ControlFile.ControlFile.flexpartdir" title="Permalink to this definition">¶</a></dt> |
---|
| 1294 | <dd><p>Path to a FLEXPART root directory. Default value is None.</p> |
---|
| 1295 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1296 | <col class="field-name" /> |
---|
| 1297 | <col class="field-body" /> |
---|
| 1298 | <tbody valign="top"> |
---|
| 1299 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1300 | </tr> |
---|
| 1301 | </tbody> |
---|
| 1302 | </table> |
---|
| 1303 | </dd></dl> |
---|
| 1304 | |
---|
| 1305 | <dl class="attribute"> |
---|
| 1306 | <dt id="ControlFile.ControlFile.makefile"> |
---|
| 1307 | <code class="descname">makefile</code><a class="headerlink" href="#ControlFile.ControlFile.makefile" title="Permalink to this definition">¶</a></dt> |
---|
| 1308 | <dd><p>Name of the makefile to be used for the Fortran program. |
---|
| 1309 | Default value is ‘Makefile.gfortran’.</p> |
---|
| 1310 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1311 | <col class="field-name" /> |
---|
| 1312 | <col class="field-body" /> |
---|
| 1313 | <tbody valign="top"> |
---|
| 1314 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1315 | </tr> |
---|
| 1316 | </tbody> |
---|
| 1317 | </table> |
---|
| 1318 | </dd></dl> |
---|
| 1319 | |
---|
| 1320 | <dl class="attribute"> |
---|
| 1321 | <dt id="ControlFile.ControlFile.destination"> |
---|
| 1322 | <code class="descname">destination</code><a class="headerlink" href="#ControlFile.ControlFile.destination" title="Permalink to this definition">¶</a></dt> |
---|
| 1323 | <dd><p>The remote destination which is used to transfer files |
---|
| 1324 | from ECMWF server to local gateway server. Default value is None.</p> |
---|
| 1325 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1326 | <col class="field-name" /> |
---|
| 1327 | <col class="field-body" /> |
---|
| 1328 | <tbody valign="top"> |
---|
| 1329 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1330 | </tr> |
---|
| 1331 | </tbody> |
---|
| 1332 | </table> |
---|
| 1333 | </dd></dl> |
---|
| 1334 | |
---|
| 1335 | <dl class="attribute"> |
---|
| 1336 | <dt id="ControlFile.ControlFile.gateway"> |
---|
| 1337 | <code class="descname">gateway</code><a class="headerlink" href="#ControlFile.ControlFile.gateway" title="Permalink to this definition">¶</a></dt> |
---|
| 1338 | <dd><p>The gateway server the user is using. Default value is None.</p> |
---|
| 1339 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1340 | <col class="field-name" /> |
---|
| 1341 | <col class="field-body" /> |
---|
| 1342 | <tbody valign="top"> |
---|
| 1343 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1344 | </tr> |
---|
| 1345 | </tbody> |
---|
| 1346 | </table> |
---|
| 1347 | </dd></dl> |
---|
| 1348 | |
---|
| 1349 | <dl class="attribute"> |
---|
| 1350 | <dt id="ControlFile.ControlFile.ecuid"> |
---|
| 1351 | <code class="descname">ecuid</code><a class="headerlink" href="#ControlFile.ControlFile.ecuid" title="Permalink to this definition">¶</a></dt> |
---|
| 1352 | <dd><p>The user id on ECMWF server. Default value is None.</p> |
---|
| 1353 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1354 | <col class="field-name" /> |
---|
| 1355 | <col class="field-body" /> |
---|
| 1356 | <tbody valign="top"> |
---|
| 1357 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1358 | </tr> |
---|
| 1359 | </tbody> |
---|
| 1360 | </table> |
---|
| 1361 | </dd></dl> |
---|
| 1362 | |
---|
| 1363 | <dl class="attribute"> |
---|
| 1364 | <dt id="ControlFile.ControlFile.ecgid"> |
---|
| 1365 | <code class="descname">ecgid</code><a class="headerlink" href="#ControlFile.ControlFile.ecgid" title="Permalink to this definition">¶</a></dt> |
---|
| 1366 | <dd><p>The group id on ECMWF server. Default value is None.</p> |
---|
| 1367 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1368 | <col class="field-name" /> |
---|
| 1369 | <col class="field-body" /> |
---|
| 1370 | <tbody valign="top"> |
---|
| 1371 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1372 | </tr> |
---|
| 1373 | </tbody> |
---|
| 1374 | </table> |
---|
| 1375 | </dd></dl> |
---|
| 1376 | |
---|
| 1377 | <dl class="attribute"> |
---|
| 1378 | <dt id="ControlFile.ControlFile.install_target"> |
---|
| 1379 | <code class="descname">install_target</code><a class="headerlink" href="#ControlFile.ControlFile.install_target" title="Permalink to this definition">¶</a></dt> |
---|
| 1380 | <dd><p>Defines the location where the installation is to be done. |
---|
| 1381 | Default value is None.</p> |
---|
| 1382 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1383 | <col class="field-name" /> |
---|
| 1384 | <col class="field-body" /> |
---|
| 1385 | <tbody valign="top"> |
---|
| 1386 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1387 | </tr> |
---|
| 1388 | </tbody> |
---|
| 1389 | </table> |
---|
| 1390 | </dd></dl> |
---|
| 1391 | |
---|
| 1392 | <dl class="attribute"> |
---|
| 1393 | <dt id="ControlFile.ControlFile.debug"> |
---|
| 1394 | <code class="descname">debug</code><a class="headerlink" href="#ControlFile.ControlFile.debug" title="Permalink to this definition">¶</a></dt> |
---|
| 1395 | <dd><p>Switch to keep temporary files at the end of postprocessing (1) or |
---|
| 1396 | to delete all temporary files except the final output files (0). |
---|
| 1397 | Default value is 0.</p> |
---|
| 1398 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1399 | <col class="field-name" /> |
---|
| 1400 | <col class="field-body" /> |
---|
| 1401 | <tbody valign="top"> |
---|
| 1402 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1403 | </tr> |
---|
| 1404 | </tbody> |
---|
| 1405 | </table> |
---|
| 1406 | </dd></dl> |
---|
| 1407 | |
---|
| 1408 | <dl class="attribute"> |
---|
| 1409 | <dt id="ControlFile.ControlFile.request"> |
---|
| 1410 | <code class="descname">request</code><a class="headerlink" href="#ControlFile.ControlFile.request" title="Permalink to this definition">¶</a></dt> |
---|
| 1411 | <dd><p>Switch to select between just retrieving the data (0), writing the mars |
---|
| 1412 | parameter values to a csv file (1) or doing both (2). |
---|
| 1413 | Default value is 0.</p> |
---|
| 1414 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1415 | <col class="field-name" /> |
---|
| 1416 | <col class="field-body" /> |
---|
| 1417 | <tbody valign="top"> |
---|
| 1418 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1419 | </tr> |
---|
| 1420 | </tbody> |
---|
| 1421 | </table> |
---|
| 1422 | </dd></dl> |
---|
| 1423 | |
---|
| 1424 | <dl class="attribute"> |
---|
| 1425 | <dt id="ControlFile.ControlFile.public"> |
---|
| 1426 | <code class="descname">public</code><a class="headerlink" href="#ControlFile.ControlFile.public" title="Permalink to this definition">¶</a></dt> |
---|
| 1427 | <dd><p>Switch to select kind of ECMWF Web Api access and the |
---|
| 1428 | possible data sets. Public data sets (1) and Memberstate data sets (0). |
---|
| 1429 | Default 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. |
---|
| 1444 | Default value is None.</p> |
---|
| 1445 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1446 | <col class="field-name" /> |
---|
| 1447 | <col class="field-body" /> |
---|
| 1448 | <tbody valign="top"> |
---|
| 1449 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> |
---|
| 1450 | </tr> |
---|
| 1451 | </tbody> |
---|
| 1452 | </table> |
---|
| 1453 | </dd></dl> |
---|
| 1454 | |
---|
| 1455 | <dl class="attribute"> |
---|
| 1456 | <dt id="ControlFile.ControlFile.purefc"> |
---|
| 1457 | <code class="descname">purefc</code><a class="headerlink" href="#ControlFile.ControlFile.purefc" title="Permalink to this definition">¶</a></dt> |
---|
| 1458 | <dd><p>Switch to decide wether the job is a pure forecast retrieval or |
---|
| 1459 | coupled with analysis data. Default value is 0.</p> |
---|
| 1460 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1461 | <col class="field-name" /> |
---|
| 1462 | <col class="field-body" /> |
---|
| 1463 | <tbody valign="top"> |
---|
| 1464 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1465 | </tr> |
---|
| 1466 | </tbody> |
---|
| 1467 | </table> |
---|
| 1468 | </dd></dl> |
---|
| 1469 | |
---|
| 1470 | <dl class="attribute"> |
---|
| 1471 | <dt id="ControlFile.ControlFile.rrint"> |
---|
| 1472 | <code class="descname">rrint</code><a class="headerlink" href="#ControlFile.ControlFile.rrint" title="Permalink to this definition">¶</a></dt> |
---|
| 1473 | <dd><p>Switch to select between old precipitation disaggregation method (0) |
---|
| 1474 | or the new IA3 disaggegration method (1). Default value is 0.</p> |
---|
| 1475 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1476 | <col class="field-name" /> |
---|
| 1477 | <col class="field-body" /> |
---|
| 1478 | <tbody valign="top"> |
---|
| 1479 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1480 | </tr> |
---|
| 1481 | </tbody> |
---|
| 1482 | </table> |
---|
| 1483 | </dd></dl> |
---|
| 1484 | |
---|
| 1485 | <dl class="attribute"> |
---|
| 1486 | <dt id="ControlFile.ControlFile.logicals"> |
---|
| 1487 | <code class="descname">logicals</code><a class="headerlink" href="#ControlFile.ControlFile.logicals" title="Permalink to this definition">¶</a></dt> |
---|
| 1488 | <dd><p>List of the names of logical switches which controls the flow |
---|
| 1489 | of the program. Default list is [‘gauss’, ‘omega’, ‘omegadiff’, ‘eta’, |
---|
| 1490 | ‘etadiff’, ‘dpdeta’, ‘cwc’, ‘wrf’, ‘grib2flexpart’, ‘ecstorage’, |
---|
| 1491 | ‘ectrans’, ‘debug’, ‘request’, ‘public’, ‘purefc’, ‘rrint’]</p> |
---|
| 1492 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1493 | <col class="field-name" /> |
---|
| 1494 | <col class="field-body" /> |
---|
| 1495 | <tbody valign="top"> |
---|
| 1496 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
| 1497 | </tr> |
---|
| 1498 | </tbody> |
---|
| 1499 | </table> |
---|
| 1500 | </dd></dl> |
---|
| 1501 | |
---|
| 1502 | <dl class="method"> |
---|
| 1503 | <dt id="ControlFile.ControlFile.assign_args_to_control"> |
---|
| 1504 | <code class="descname">assign_args_to_control</code><span class="sig-paren">(</span><em>args</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ControlFile.html#ControlFile.assign_args_to_control"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.assign_args_to_control" title="Permalink to this definition">¶</a></dt> |
---|
| 1505 | <dd><p>Overwrites the existing ControlFile instance attributes with |
---|
| 1506 | the command line arguments.</p> |
---|
| 1507 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1508 | <col class="field-name" /> |
---|
| 1509 | <col class="field-body" /> |
---|
| 1510 | <tbody valign="top"> |
---|
| 1511 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>args</strong> (<em>Namespace</em>) – Contains the commandline arguments from script/program call.</td> |
---|
| 1512 | </tr> |
---|
| 1513 | </tbody> |
---|
| 1514 | </table> |
---|
| 1515 | </dd></dl> |
---|
| 1516 | |
---|
| 1517 | <dl class="method"> |
---|
| 1518 | <dt id="ControlFile.ControlFile.assign_envs_to_control"> |
---|
| 1519 | <code class="descname">assign_envs_to_control</code><span class="sig-paren">(</span><em>envs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ControlFile.html#ControlFile.assign_envs_to_control"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.assign_envs_to_control" title="Permalink to this definition">¶</a></dt> |
---|
| 1520 | <dd><p>Assigns the ECMWF environment parameter.</p> |
---|
| 1521 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1522 | <col class="field-name" /> |
---|
| 1523 | <col class="field-body" /> |
---|
| 1524 | <tbody valign="top"> |
---|
| 1525 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>envs</strong> (<em>dict of str</em>) – Contains the ECMWF environment parameternames “ECUID”, “ECGID”, |
---|
| 1526 | “DESTINATION” and “GATEWAY” with its corresponding values. |
---|
| 1527 | They were read from the file “ECMWF_ENV”.</td> |
---|
| 1528 | </tr> |
---|
| 1529 | </tbody> |
---|
| 1530 | </table> |
---|
| 1531 | </dd></dl> |
---|
| 1532 | |
---|
| 1533 | <dl class="method"> |
---|
| 1534 | <dt id="ControlFile.ControlFile.check_conditions"> |
---|
| 1535 | <code class="descname">check_conditions</code><span class="sig-paren">(</span><em>queue</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ControlFile.html#ControlFile.check_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.check_conditions" title="Permalink to this definition">¶</a></dt> |
---|
| 1536 | <dd><p>Checks a couple of necessary attributes and conditions, |
---|
| 1537 | such as if they exist and contain values. |
---|
| 1538 | Otherwise set default values.</p> |
---|
| 1539 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1540 | <col class="field-name" /> |
---|
| 1541 | <col class="field-body" /> |
---|
| 1542 | <tbody valign="top"> |
---|
| 1543 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>queue</strong> (<em>str</em>) – Name of the queue if submitted to the ECMWF servers. |
---|
| 1544 | Used to check if ecuid, ecgid, gateway and destination |
---|
| 1545 | are set correctly and are not empty.</td> |
---|
| 1546 | </tr> |
---|
| 1547 | </tbody> |
---|
| 1548 | </table> |
---|
| 1549 | </dd></dl> |
---|
| 1550 | |
---|
| 1551 | <dl class="method"> |
---|
| 1552 | <dt id="ControlFile.ControlFile.to_list"> |
---|
| 1553 | <code class="descname">to_list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ControlFile.html#ControlFile.to_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.to_list" title="Permalink to this definition">¶</a></dt> |
---|
| 1554 | <dd><p>Just generates a list of strings containing the attributes and |
---|
| 1555 | assigned values except the attributes “_expanded”, “exedir”, |
---|
| 1556 | “flexextractdir” and “flexpartdir”.</p> |
---|
| 1557 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1558 | <col class="field-name" /> |
---|
| 1559 | <col class="field-body" /> |
---|
| 1560 | <tbody valign="top"> |
---|
| 1561 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>l</strong> – A sorted list of the all ControlFile class attributes with |
---|
| 1562 | their values except the attributes “_expanded”, “exedir”, |
---|
| 1563 | “flexextractdir” and “flexpartdir”.</td> |
---|
| 1564 | </tr> |
---|
| 1565 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of *</td> |
---|
| 1566 | </tr> |
---|
| 1567 | </tbody> |
---|
| 1568 | </table> |
---|
| 1569 | </dd></dl> |
---|
| 1570 | |
---|
| 1571 | </dd></dl> |
---|
| 1572 | |
---|
| 1573 | </div> |
---|
| 1574 | <div class="section" id="module-EcFlexpart"> |
---|
| 1575 | <span id="ecflexpart"></span><h3><a class="toc-backref" href="#id6">EcFlexpart</a><a class="headerlink" href="#module-EcFlexpart" title="Permalink to this headline">¶</a></h3> |
---|
| 1576 | <dl class="class"> |
---|
| 1577 | <dt id="EcFlexpart.EcFlexpart"> |
---|
| 1578 | <em class="property">class </em><code class="descclassname">EcFlexpart.</code><code class="descname">EcFlexpart</code><span class="sig-paren">(</span><em>c</em>, <em>fluxes=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart" title="Permalink to this definition">¶</a></dt> |
---|
| 1579 | <dd><p>Class to represent FLEXPART specific ECMWF data.</p> |
---|
| 1580 | <p>FLEXPART needs grib files in a specifc format. All necessary data fields |
---|
| 1581 | for one time step are stored in a single file. The class represents an |
---|
| 1582 | instance with all the parameter and settings necessary for retrieving |
---|
| 1583 | MARS data and modifing them so they are fitting FLEXPART needs. The class |
---|
| 1584 | is able to disaggregate the fluxes and convert grid types to the one needed |
---|
| 1585 | by FLEXPART, therefore using the FORTRAN program.</p> |
---|
| 1586 | <dl class="attribute"> |
---|
| 1587 | <dt id="EcFlexpart.EcFlexpart.mreq_count"> |
---|
| 1588 | <code class="descname">mreq_count</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.mreq_count" title="Permalink to this definition">¶</a></dt> |
---|
| 1589 | <dd><p>Counter for the number of generated mars requests.</p> |
---|
| 1590 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1591 | <col class="field-name" /> |
---|
| 1592 | <col class="field-body" /> |
---|
| 1593 | <tbody valign="top"> |
---|
| 1594 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1595 | </tr> |
---|
| 1596 | </tbody> |
---|
| 1597 | </table> |
---|
| 1598 | </dd></dl> |
---|
| 1599 | |
---|
| 1600 | <dl class="attribute"> |
---|
| 1601 | <dt id="EcFlexpart.EcFlexpart.inputdir"> |
---|
| 1602 | <code class="descname">inputdir</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.inputdir" title="Permalink to this definition">¶</a></dt> |
---|
| 1603 | <dd><p>Path to the directory where the retrieved data is stored.</p> |
---|
| 1604 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1605 | <col class="field-name" /> |
---|
| 1606 | <col class="field-body" /> |
---|
| 1607 | <tbody valign="top"> |
---|
| 1608 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1609 | </tr> |
---|
| 1610 | </tbody> |
---|
| 1611 | </table> |
---|
| 1612 | </dd></dl> |
---|
| 1613 | |
---|
| 1614 | <dl class="attribute"> |
---|
| 1615 | <dt id="EcFlexpart.EcFlexpart.dataset"> |
---|
| 1616 | <code class="descname">dataset</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.dataset" title="Permalink to this definition">¶</a></dt> |
---|
| 1617 | <dd><p>For public datasets there is the specific naming and parameter |
---|
| 1618 | dataset which has to be used to characterize the type of |
---|
| 1619 | data.</p> |
---|
| 1620 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1621 | <col class="field-name" /> |
---|
| 1622 | <col class="field-body" /> |
---|
| 1623 | <tbody valign="top"> |
---|
| 1624 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1625 | </tr> |
---|
| 1626 | </tbody> |
---|
| 1627 | </table> |
---|
| 1628 | </dd></dl> |
---|
| 1629 | |
---|
| 1630 | <dl class="attribute"> |
---|
| 1631 | <dt id="EcFlexpart.EcFlexpart.basetime"> |
---|
| 1632 | <code class="descname">basetime</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.basetime" title="Permalink to this definition">¶</a></dt> |
---|
| 1633 | <dd><p>The time for a half day retrieval. The 12 hours upfront are to be |
---|
| 1634 | retrieved.</p> |
---|
| 1635 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1636 | <col class="field-name" /> |
---|
| 1637 | <col class="field-body" /> |
---|
| 1638 | <tbody valign="top"> |
---|
| 1639 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1640 | </tr> |
---|
| 1641 | </tbody> |
---|
| 1642 | </table> |
---|
| 1643 | </dd></dl> |
---|
| 1644 | |
---|
| 1645 | <dl class="attribute"> |
---|
| 1646 | <dt id="EcFlexpart.EcFlexpart.dtime"> |
---|
| 1647 | <code class="descname">dtime</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.dtime" title="Permalink to this definition">¶</a></dt> |
---|
| 1648 | <dd><p>Time step in hours.</p> |
---|
| 1649 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1650 | <col class="field-name" /> |
---|
| 1651 | <col class="field-body" /> |
---|
| 1652 | <tbody valign="top"> |
---|
| 1653 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1654 | </tr> |
---|
| 1655 | </tbody> |
---|
| 1656 | </table> |
---|
| 1657 | </dd></dl> |
---|
| 1658 | |
---|
| 1659 | <dl class="attribute"> |
---|
| 1660 | <dt id="EcFlexpart.EcFlexpart.acctype"> |
---|
| 1661 | <code class="descname">acctype</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.acctype" title="Permalink to this definition">¶</a></dt> |
---|
| 1662 | <dd><p>The field type for the accumulated forecast fields.</p> |
---|
| 1663 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1664 | <col class="field-name" /> |
---|
| 1665 | <col class="field-body" /> |
---|
| 1666 | <tbody valign="top"> |
---|
| 1667 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1668 | </tr> |
---|
| 1669 | </tbody> |
---|
| 1670 | </table> |
---|
| 1671 | </dd></dl> |
---|
| 1672 | |
---|
| 1673 | <dl class="attribute"> |
---|
| 1674 | <dt id="EcFlexpart.EcFlexpart.acctime"> |
---|
| 1675 | <code class="descname">acctime</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.acctime" title="Permalink to this definition">¶</a></dt> |
---|
| 1676 | <dd><p>The starting time from the accumulated forecasts.</p> |
---|
| 1677 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1678 | <col class="field-name" /> |
---|
| 1679 | <col class="field-body" /> |
---|
| 1680 | <tbody valign="top"> |
---|
| 1681 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1682 | </tr> |
---|
| 1683 | </tbody> |
---|
| 1684 | </table> |
---|
| 1685 | </dd></dl> |
---|
| 1686 | |
---|
| 1687 | <dl class="attribute"> |
---|
| 1688 | <dt id="EcFlexpart.EcFlexpart.accmaxstep"> |
---|
| 1689 | <code class="descname">accmaxstep</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.accmaxstep" title="Permalink to this definition">¶</a></dt> |
---|
| 1690 | <dd><p>The maximum forecast step for the accumulated forecast fields.</p> |
---|
| 1691 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1692 | <col class="field-name" /> |
---|
| 1693 | <col class="field-body" /> |
---|
| 1694 | <tbody valign="top"> |
---|
| 1695 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1696 | </tr> |
---|
| 1697 | </tbody> |
---|
| 1698 | </table> |
---|
| 1699 | </dd></dl> |
---|
| 1700 | |
---|
| 1701 | <dl class="attribute"> |
---|
| 1702 | <dt id="EcFlexpart.EcFlexpart.marsclass"> |
---|
| 1703 | <code class="descname">marsclass</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.marsclass" title="Permalink to this definition">¶</a></dt> |
---|
| 1704 | <dd><p>Characterisation of dataset.</p> |
---|
| 1705 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1706 | <col class="field-name" /> |
---|
| 1707 | <col class="field-body" /> |
---|
| 1708 | <tbody valign="top"> |
---|
| 1709 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1710 | </tr> |
---|
| 1711 | </tbody> |
---|
| 1712 | </table> |
---|
| 1713 | </dd></dl> |
---|
| 1714 | |
---|
| 1715 | <dl class="attribute"> |
---|
| 1716 | <dt id="EcFlexpart.EcFlexpart.stream"> |
---|
| 1717 | <code class="descname">stream</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.stream" title="Permalink to this definition">¶</a></dt> |
---|
| 1718 | <dd><p>Identifies the forecasting system used to generate the data.</p> |
---|
| 1719 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1720 | <col class="field-name" /> |
---|
| 1721 | <col class="field-body" /> |
---|
| 1722 | <tbody valign="top"> |
---|
| 1723 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1724 | </tr> |
---|
| 1725 | </tbody> |
---|
| 1726 | </table> |
---|
| 1727 | </dd></dl> |
---|
| 1728 | |
---|
| 1729 | <dl class="attribute"> |
---|
| 1730 | <dt id="EcFlexpart.EcFlexpart.number"> |
---|
| 1731 | <code class="descname">number</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.number" title="Permalink to this definition">¶</a></dt> |
---|
| 1732 | <dd><p>Selects the member in ensemble forecast run.</p> |
---|
| 1733 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1734 | <col class="field-name" /> |
---|
| 1735 | <col class="field-body" /> |
---|
| 1736 | <tbody valign="top"> |
---|
| 1737 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1738 | </tr> |
---|
| 1739 | </tbody> |
---|
| 1740 | </table> |
---|
| 1741 | </dd></dl> |
---|
| 1742 | |
---|
| 1743 | <dl class="attribute"> |
---|
| 1744 | <dt id="EcFlexpart.EcFlexpart.resol"> |
---|
| 1745 | <code class="descname">resol</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.resol" title="Permalink to this definition">¶</a></dt> |
---|
| 1746 | <dd><p>Specifies the desired triangular truncation of retrieved data, |
---|
| 1747 | before carrying out any other selected post-processing.</p> |
---|
| 1748 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1749 | <col class="field-name" /> |
---|
| 1750 | <col class="field-body" /> |
---|
| 1751 | <tbody valign="top"> |
---|
| 1752 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1753 | </tr> |
---|
| 1754 | </tbody> |
---|
| 1755 | </table> |
---|
| 1756 | </dd></dl> |
---|
| 1757 | |
---|
| 1758 | <dl class="attribute"> |
---|
| 1759 | <dt id="EcFlexpart.EcFlexpart.accuracy"> |
---|
| 1760 | <code class="descname">accuracy</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.accuracy" title="Permalink to this definition">¶</a></dt> |
---|
| 1761 | <dd><p>Specifies the number of bits per value to be used in the |
---|
| 1762 | generated GRIB coded fields.</p> |
---|
| 1763 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1764 | <col class="field-name" /> |
---|
| 1765 | <col class="field-body" /> |
---|
| 1766 | <tbody valign="top"> |
---|
| 1767 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1768 | </tr> |
---|
| 1769 | </tbody> |
---|
| 1770 | </table> |
---|
| 1771 | </dd></dl> |
---|
| 1772 | |
---|
| 1773 | <dl class="attribute"> |
---|
| 1774 | <dt id="EcFlexpart.EcFlexpart.addpar"> |
---|
| 1775 | <code class="descname">addpar</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.addpar" title="Permalink to this definition">¶</a></dt> |
---|
| 1776 | <dd><p>List of additional parameters to be retrieved.</p> |
---|
| 1777 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1778 | <col class="field-name" /> |
---|
| 1779 | <col class="field-body" /> |
---|
| 1780 | <tbody valign="top"> |
---|
| 1781 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1782 | </tr> |
---|
| 1783 | </tbody> |
---|
| 1784 | </table> |
---|
| 1785 | </dd></dl> |
---|
| 1786 | |
---|
| 1787 | <dl class="attribute"> |
---|
| 1788 | <dt id="EcFlexpart.EcFlexpart.level"> |
---|
| 1789 | <code class="descname">level</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.level" title="Permalink to this definition">¶</a></dt> |
---|
| 1790 | <dd><p>Specifies the maximum level.</p> |
---|
| 1791 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1792 | <col class="field-name" /> |
---|
| 1793 | <col class="field-body" /> |
---|
| 1794 | <tbody valign="top"> |
---|
| 1795 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1796 | </tr> |
---|
| 1797 | </tbody> |
---|
| 1798 | </table> |
---|
| 1799 | </dd></dl> |
---|
| 1800 | |
---|
| 1801 | <dl class="attribute"> |
---|
| 1802 | <dt id="EcFlexpart.EcFlexpart.expver"> |
---|
| 1803 | <code class="descname">expver</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.expver" title="Permalink to this definition">¶</a></dt> |
---|
| 1804 | <dd><p>The version of the dataset.</p> |
---|
| 1805 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1806 | <col class="field-name" /> |
---|
| 1807 | <col class="field-body" /> |
---|
| 1808 | <tbody valign="top"> |
---|
| 1809 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1810 | </tr> |
---|
| 1811 | </tbody> |
---|
| 1812 | </table> |
---|
| 1813 | </dd></dl> |
---|
| 1814 | |
---|
| 1815 | <dl class="attribute"> |
---|
| 1816 | <dt id="EcFlexpart.EcFlexpart.levelist"> |
---|
| 1817 | <code class="descname">levelist</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.levelist" title="Permalink to this definition">¶</a></dt> |
---|
| 1818 | <dd><p>Specifies the required levels.</p> |
---|
| 1819 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1820 | <col class="field-name" /> |
---|
| 1821 | <col class="field-body" /> |
---|
| 1822 | <tbody valign="top"> |
---|
| 1823 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1824 | </tr> |
---|
| 1825 | </tbody> |
---|
| 1826 | </table> |
---|
| 1827 | </dd></dl> |
---|
| 1828 | |
---|
| 1829 | <dl class="attribute"> |
---|
| 1830 | <dt id="EcFlexpart.EcFlexpart.glevelist"> |
---|
| 1831 | <code class="descname">glevelist</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.glevelist" title="Permalink to this definition">¶</a></dt> |
---|
| 1832 | <dd><p>Specifies the required levels for gaussian grids.</p> |
---|
| 1833 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1834 | <col class="field-name" /> |
---|
| 1835 | <col class="field-body" /> |
---|
| 1836 | <tbody valign="top"> |
---|
| 1837 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1838 | </tr> |
---|
| 1839 | </tbody> |
---|
| 1840 | </table> |
---|
| 1841 | </dd></dl> |
---|
| 1842 | |
---|
| 1843 | <dl class="attribute"> |
---|
| 1844 | <dt id="EcFlexpart.EcFlexpart.gaussian"> |
---|
| 1845 | <code class="descname">gaussian</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.gaussian" title="Permalink to this definition">¶</a></dt> |
---|
| 1846 | <dd><p>This parameter is deprecated and should no longer be used. |
---|
| 1847 | Specifies the desired type of Gaussian grid for the output.</p> |
---|
| 1848 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1849 | <col class="field-name" /> |
---|
| 1850 | <col class="field-body" /> |
---|
| 1851 | <tbody valign="top"> |
---|
| 1852 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1853 | </tr> |
---|
| 1854 | </tbody> |
---|
| 1855 | </table> |
---|
| 1856 | </dd></dl> |
---|
| 1857 | |
---|
| 1858 | <dl class="attribute"> |
---|
| 1859 | <dt id="EcFlexpart.EcFlexpart.grid"> |
---|
| 1860 | <code class="descname">grid</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.grid" title="Permalink to this definition">¶</a></dt> |
---|
| 1861 | <dd><p>Specifies the output grid which can be either a Gaussian grid |
---|
| 1862 | or a Latitude/Longitude grid.</p> |
---|
| 1863 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1864 | <col class="field-name" /> |
---|
| 1865 | <col class="field-body" /> |
---|
| 1866 | <tbody valign="top"> |
---|
| 1867 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1868 | </tr> |
---|
| 1869 | </tbody> |
---|
| 1870 | </table> |
---|
| 1871 | </dd></dl> |
---|
| 1872 | |
---|
| 1873 | <dl class="attribute"> |
---|
| 1874 | <dt id="EcFlexpart.EcFlexpart.area"> |
---|
| 1875 | <code class="descname">area</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.area" title="Permalink to this definition">¶</a></dt> |
---|
| 1876 | <dd><p>Specifies the desired sub-area of data to be extracted.</p> |
---|
| 1877 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1878 | <col class="field-name" /> |
---|
| 1879 | <col class="field-body" /> |
---|
| 1880 | <tbody valign="top"> |
---|
| 1881 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1882 | </tr> |
---|
| 1883 | </tbody> |
---|
| 1884 | </table> |
---|
| 1885 | </dd></dl> |
---|
| 1886 | |
---|
| 1887 | <dl class="attribute"> |
---|
| 1888 | <dt id="EcFlexpart.EcFlexpart.purefc"> |
---|
| 1889 | <code class="descname">purefc</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.purefc" title="Permalink to this definition">¶</a></dt> |
---|
| 1890 | <dd><p>Switch for definition of pure forecast mode or not.</p> |
---|
| 1891 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1892 | <col class="field-name" /> |
---|
| 1893 | <col class="field-body" /> |
---|
| 1894 | <tbody valign="top"> |
---|
| 1895 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1896 | </tr> |
---|
| 1897 | </tbody> |
---|
| 1898 | </table> |
---|
| 1899 | </dd></dl> |
---|
| 1900 | |
---|
| 1901 | <dl class="attribute"> |
---|
| 1902 | <dt id="EcFlexpart.EcFlexpart.outputfilelist"> |
---|
| 1903 | <code class="descname">outputfilelist</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.outputfilelist" title="Permalink to this definition">¶</a></dt> |
---|
| 1904 | <dd><p>The final list of FLEXPART ready input files.</p> |
---|
| 1905 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1906 | <col class="field-name" /> |
---|
| 1907 | <col class="field-body" /> |
---|
| 1908 | <tbody valign="top"> |
---|
| 1909 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
| 1910 | </tr> |
---|
| 1911 | </tbody> |
---|
| 1912 | </table> |
---|
| 1913 | </dd></dl> |
---|
| 1914 | |
---|
| 1915 | <dl class="attribute"> |
---|
| 1916 | <dt id="EcFlexpart.EcFlexpart.types"> |
---|
| 1917 | <code class="descname">types</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.types" title="Permalink to this definition">¶</a></dt> |
---|
| 1918 | <dd><p>Determines the combination of type of fields, time and forecast step |
---|
| 1919 | to be retrieved.</p> |
---|
| 1920 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1921 | <col class="field-name" /> |
---|
| 1922 | <col class="field-body" /> |
---|
| 1923 | <tbody valign="top"> |
---|
| 1924 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">dictionary</td> |
---|
| 1925 | </tr> |
---|
| 1926 | </tbody> |
---|
| 1927 | </table> |
---|
| 1928 | </dd></dl> |
---|
| 1929 | |
---|
| 1930 | <dl class="attribute"> |
---|
| 1931 | <dt id="EcFlexpart.EcFlexpart.params"> |
---|
| 1932 | <code class="descname">params</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.params" title="Permalink to this definition">¶</a></dt> |
---|
| 1933 | <dd><p>Collection of grid types and their corresponding parameters, |
---|
| 1934 | levels, level types and the grid definition.</p> |
---|
| 1935 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1936 | <col class="field-name" /> |
---|
| 1937 | <col class="field-body" /> |
---|
| 1938 | <tbody valign="top"> |
---|
| 1939 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">dictionary</td> |
---|
| 1940 | </tr> |
---|
| 1941 | </tbody> |
---|
| 1942 | </table> |
---|
| 1943 | </dd></dl> |
---|
| 1944 | |
---|
| 1945 | <dl class="attribute"> |
---|
| 1946 | <dt id="EcFlexpart.EcFlexpart.server"> |
---|
| 1947 | <code class="descname">server</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.server" title="Permalink to this definition">¶</a></dt> |
---|
| 1948 | <dd><p>This is the connection to the ECMWF data servers.</p> |
---|
| 1949 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1950 | <col class="field-name" /> |
---|
| 1951 | <col class="field-body" /> |
---|
| 1952 | <tbody valign="top"> |
---|
| 1953 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">ECMWFService or ECMWFDataServer</td> |
---|
| 1954 | </tr> |
---|
| 1955 | </tbody> |
---|
| 1956 | </table> |
---|
| 1957 | </dd></dl> |
---|
| 1958 | |
---|
| 1959 | <dl class="attribute"> |
---|
| 1960 | <dt id="EcFlexpart.EcFlexpart.public"> |
---|
| 1961 | <code class="descname">public</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.public" title="Permalink to this definition">¶</a></dt> |
---|
| 1962 | <dd><p>Decides which Web API Server version is used.</p> |
---|
| 1963 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1964 | <col class="field-name" /> |
---|
| 1965 | <col class="field-body" /> |
---|
| 1966 | <tbody valign="top"> |
---|
| 1967 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 1968 | </tr> |
---|
| 1969 | </tbody> |
---|
| 1970 | </table> |
---|
| 1971 | </dd></dl> |
---|
| 1972 | |
---|
| 1973 | <dl class="attribute"> |
---|
| 1974 | <dt id="EcFlexpart.EcFlexpart.dates"> |
---|
| 1975 | <code class="descname">dates</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.dates" title="Permalink to this definition">¶</a></dt> |
---|
| 1976 | <dd><p>Contains start and end date of the retrieval in the format |
---|
| 1977 | “YYYYMMDD/to/YYYYMMDD”</p> |
---|
| 1978 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 1979 | <col class="field-name" /> |
---|
| 1980 | <col class="field-body" /> |
---|
| 1981 | <tbody valign="top"> |
---|
| 1982 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 1983 | </tr> |
---|
| 1984 | </tbody> |
---|
| 1985 | </table> |
---|
| 1986 | </dd></dl> |
---|
| 1987 | |
---|
| 1988 | <dl class="method"> |
---|
| 1989 | <dt id="EcFlexpart.EcFlexpart.create"> |
---|
| 1990 | <code class="descname">create</code><span class="sig-paren">(</span><em>inputfiles</em>, <em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.create" title="Permalink to this definition">¶</a></dt> |
---|
| 1991 | <dd><p>An index file will be created which depends on the combination |
---|
| 1992 | of “date”, “time” and “stepRange” values. This is used to iterate |
---|
| 1993 | over all messages in each grib file which were passed through the |
---|
| 1994 | parameter “inputfiles” to seperate specific parameters into fort.* |
---|
| 1995 | files. Afterwards the FORTRAN program is called to convert |
---|
| 1996 | the data fields all to the same grid and put them in one file |
---|
| 1997 | per unique time step (combination of “date”, “time” and |
---|
| 1998 | “stepRange”).</p> |
---|
| 1999 | <div class="admonition note"> |
---|
| 2000 | <p class="first admonition-title">Note</p> |
---|
| 2001 | <p class="last">This method is based on the ECMWF example index.py |
---|
| 2002 | <a class="reference external" href="https://software.ecmwf.int/wiki/display/GRIB/index.py">https://software.ecmwf.int/wiki/display/GRIB/index.py</a></p> |
---|
| 2003 | </div> |
---|
| 2004 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2005 | <col class="field-name" /> |
---|
| 2006 | <col class="field-body" /> |
---|
| 2007 | <tbody valign="top"> |
---|
| 2008 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 2009 | <li><strong>inputfiles</strong> (<a class="reference internal" href="#UioFiles.UioFiles" title="UioFiles.UioFiles"><em>UioFiles</em></a>) – Contains a list of files.</li> |
---|
| 2010 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
| 2011 | command line.</li> |
---|
| 2012 | </ul> |
---|
| 2013 | </td> |
---|
| 2014 | </tr> |
---|
| 2015 | </tbody> |
---|
| 2016 | </table> |
---|
| 2017 | </dd></dl> |
---|
| 2018 | |
---|
| 2019 | <dl class="method"> |
---|
| 2020 | <dt id="EcFlexpart.EcFlexpart.deacc_fluxes"> |
---|
| 2021 | <code class="descname">deacc_fluxes</code><span class="sig-paren">(</span><em>inputfiles</em>, <em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.deacc_fluxes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.deacc_fluxes" title="Permalink to this definition">¶</a></dt> |
---|
| 2022 | <dd><p>De-accumulate and disaggregate flux data.</p> |
---|
| 2023 | <p>Goes through all flux fields in ordered time and de-accumulate |
---|
| 2024 | the fields. Afterwards the fields are disaggregated in time. |
---|
| 2025 | Different versions of disaggregation is provided for rainfall |
---|
| 2026 | data (darain, modified linear) and the surface fluxes and |
---|
| 2027 | stress data (dapoly, cubic polynomial).</p> |
---|
| 2028 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2029 | <col class="field-name" /> |
---|
| 2030 | <col class="field-body" /> |
---|
| 2031 | <tbody valign="top"> |
---|
| 2032 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 2033 | <li><strong>inputfiles</strong> (<a class="reference internal" href="#UioFiles.UioFiles" title="UioFiles.UioFiles"><em>UioFiles</em></a>) – Contains the list of files that contain flux data.</li> |
---|
| 2034 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
| 2035 | command line.</li> |
---|
| 2036 | </ul> |
---|
| 2037 | </td> |
---|
| 2038 | </tr> |
---|
| 2039 | </tbody> |
---|
| 2040 | </table> |
---|
| 2041 | </dd></dl> |
---|
| 2042 | |
---|
| 2043 | <dl class="method"> |
---|
| 2044 | <dt id="EcFlexpart.EcFlexpart.prepare_fp_files"> |
---|
| 2045 | <code class="descname">prepare_fp_files</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.prepare_fp_files"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.prepare_fp_files" title="Permalink to this definition">¶</a></dt> |
---|
| 2046 | <dd><p>Conversion of GRIB files to FLEXPART binary format.</p> |
---|
| 2047 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2048 | <col class="field-name" /> |
---|
| 2049 | <col class="field-body" /> |
---|
| 2050 | <tbody valign="top"> |
---|
| 2051 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
| 2052 | command line.</td> |
---|
| 2053 | </tr> |
---|
| 2054 | </tbody> |
---|
| 2055 | </table> |
---|
| 2056 | </dd></dl> |
---|
| 2057 | |
---|
| 2058 | <dl class="method"> |
---|
| 2059 | <dt id="EcFlexpart.EcFlexpart.process_output"> |
---|
| 2060 | <code class="descname">process_output</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.process_output"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.process_output" title="Permalink to this definition">¶</a></dt> |
---|
| 2061 | <dd><p>Postprocessing of FLEXPART input files.</p> |
---|
| 2062 | <p>The grib files are postprocessed depending on the selection in |
---|
| 2063 | CONTROL file. The resulting files are moved to the output |
---|
| 2064 | directory if its not equal to the input directory. |
---|
| 2065 | The following modifications might be done if |
---|
| 2066 | properly switched in CONTROL file: |
---|
| 2067 | GRIB2 - Conversion to GRIB2 |
---|
| 2068 | ECTRANS - Transfer of files to gateway server |
---|
| 2069 | ECSTORAGE - Storage at ECMWF server</p> |
---|
| 2070 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2071 | <col class="field-name" /> |
---|
| 2072 | <col class="field-body" /> |
---|
| 2073 | <tbody valign="top"> |
---|
| 2074 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
| 2075 | command line.</td> |
---|
| 2076 | </tr> |
---|
| 2077 | </tbody> |
---|
| 2078 | </table> |
---|
| 2079 | </dd></dl> |
---|
| 2080 | |
---|
| 2081 | <dl class="method"> |
---|
| 2082 | <dt id="EcFlexpart.EcFlexpart.retrieve"> |
---|
| 2083 | <code class="descname">retrieve</code><span class="sig-paren">(</span><em>server</em>, <em>dates</em>, <em>public</em>, <em>request</em>, <em>inputdir='.'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.retrieve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.retrieve" title="Permalink to this definition">¶</a></dt> |
---|
| 2084 | <dd><p>Finalizing the retrieval information by setting final details |
---|
| 2085 | depending on grid type. |
---|
| 2086 | Prepares MARS retrievals per grid type and submits them.</p> |
---|
| 2087 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2088 | <col class="field-name" /> |
---|
| 2089 | <col class="field-body" /> |
---|
| 2090 | <tbody valign="top"> |
---|
| 2091 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 2092 | <li><strong>server</strong> (<em>ECMWFService</em><em> or </em><em>ECMWFDataServer</em>) – The connection to the ECMWF server. This is different |
---|
| 2093 | for member state users which have full access and non |
---|
| 2094 | member state users which have only access to the public |
---|
| 2095 | data sets. The decision is made from command line argument |
---|
| 2096 | “public”; for public access its True (ECMWFDataServer) |
---|
| 2097 | for member state users its False (ECMWFService)</li> |
---|
| 2098 | <li><strong>dates</strong> (<em>str</em>) – Contains start and end date of the retrieval in the format |
---|
| 2099 | “YYYYMMDD/to/YYYYMMDD”</li> |
---|
| 2100 | <li><strong>request</strong> (<em>int</em>) – Selects the mode of retrieval. |
---|
| 2101 | 0: Retrieves the data from ECMWF. |
---|
| 2102 | 1: Prints the mars requests to an output file. |
---|
| 2103 | 2: Retrieves the data and prints the mars request.</li> |
---|
| 2104 | <li><strong>inputdir</strong> (<em>str</em><em>, </em><em>optional</em>) – Path to the directory where the retrieved data is about |
---|
| 2105 | to be stored. The default is the current directory (‘.’).</li> |
---|
| 2106 | </ul> |
---|
| 2107 | </td> |
---|
| 2108 | </tr> |
---|
| 2109 | </tbody> |
---|
| 2110 | </table> |
---|
| 2111 | </dd></dl> |
---|
| 2112 | |
---|
| 2113 | <dl class="method"> |
---|
| 2114 | <dt id="EcFlexpart.EcFlexpart.write_namelist"> |
---|
| 2115 | <code class="descname">write_namelist</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/EcFlexpart.html#EcFlexpart.write_namelist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.write_namelist" title="Permalink to this definition">¶</a></dt> |
---|
| 2116 | <dd><p>Creates a namelist file in the temporary directory and writes |
---|
| 2117 | the following values to it: maxl, maxb, mlevel, |
---|
| 2118 | mlevelist, mnauf, metapar, rlo0, rlo1, rla0, rla1, |
---|
| 2119 | momega, momegadiff, mgauss, msmooth, meta, metadiff, mdpdeta</p> |
---|
| 2120 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2121 | <col class="field-name" /> |
---|
| 2122 | <col class="field-body" /> |
---|
| 2123 | <tbody valign="top"> |
---|
| 2124 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 2125 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
| 2126 | command line.</li> |
---|
| 2127 | <li><strong>filename</strong> (<em>str</em>) – Name of the namelist file.</li> |
---|
| 2128 | </ul> |
---|
| 2129 | </td> |
---|
| 2130 | </tr> |
---|
| 2131 | </tbody> |
---|
| 2132 | </table> |
---|
| 2133 | </dd></dl> |
---|
| 2134 | |
---|
| 2135 | </dd></dl> |
---|
| 2136 | |
---|
| 2137 | </div> |
---|
| 2138 | <div class="section" id="module-GribUtil"> |
---|
| 2139 | <span id="gributil"></span><h3><a class="toc-backref" href="#id7">GribUtil</a><a class="headerlink" href="#module-GribUtil" title="Permalink to this headline">¶</a></h3> |
---|
| 2140 | <dl class="class"> |
---|
| 2141 | <dt id="GribUtil.GribUtil"> |
---|
| 2142 | <em class="property">class </em><code class="descclassname">GribUtil.</code><code class="descname">GribUtil</code><span class="sig-paren">(</span><em>filenames</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribUtil.html#GribUtil"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil" title="Permalink to this definition">¶</a></dt> |
---|
| 2143 | <dd><p>Class for GRIB utilities (new methods) based on GRIB API</p> |
---|
| 2144 | <dl class="method"> |
---|
| 2145 | <dt id="GribUtil.GribUtil.copy_dummy_msg"> |
---|
| 2146 | <code class="descname">copy_dummy_msg</code><span class="sig-paren">(</span><em>filename_in</em>, <em>selectWhere=True</em>, <em>keynames=[]</em>, <em>keyvalues=[]</em>, <em>filemode='w'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribUtil.html#GribUtil.copy_dummy_msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.copy_dummy_msg" title="Permalink to this definition">¶</a></dt> |
---|
| 2147 | <dd><p>Add the content of another input grib file to the objects file but |
---|
| 2148 | only messages corresponding to keys/values passed to the function. |
---|
| 2149 | The selectWhere switch decides if to copy the keys equal to (True) or |
---|
| 2150 | different to (False) the keynames/keyvalues list passed to the function.</p> |
---|
| 2151 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2152 | <col class="field-name" /> |
---|
| 2153 | <col class="field-body" /> |
---|
| 2154 | <tbody valign="top"> |
---|
| 2155 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 2156 | <li><strong>filename_in</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Filename of the input file to read the grib messages from.</li> |
---|
| 2157 | <li><strong>selectWhere</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">boolean</span></code>, optional) – Decides if to copy the keynames and values equal to (True) or |
---|
| 2158 | different to (False) the keynames/keyvalues list passed to the |
---|
| 2159 | function. Default is True.</li> |
---|
| 2160 | <li><strong>keynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – List of keynames. Default is an empty list.</li> |
---|
| 2161 | <li><strong>keyvalues</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – List of keyvalues. Default is an empty list.</li> |
---|
| 2162 | <li><strong>filemode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Sets the mode for the output file. Default is “w”.</li> |
---|
| 2163 | </ul> |
---|
| 2164 | </td> |
---|
| 2165 | </tr> |
---|
| 2166 | </tbody> |
---|
| 2167 | </table> |
---|
| 2168 | </dd></dl> |
---|
| 2169 | |
---|
| 2170 | <dl class="method"> |
---|
| 2171 | <dt id="GribUtil.GribUtil.get_keys"> |
---|
| 2172 | <code class="descname">get_keys</code><span class="sig-paren">(</span><em>keynames</em>, <em>wherekeynames=[]</em>, <em>wherekeyvalues=[]</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribUtil.html#GribUtil.get_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.get_keys" title="Permalink to this definition">¶</a></dt> |
---|
| 2173 | <dd><p>Get keyvalues for a given list of keynames a where statement |
---|
| 2174 | can be given (list of key and list of values)</p> |
---|
| 2175 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2176 | <col class="field-name" /> |
---|
| 2177 | <col class="field-body" /> |
---|
| 2178 | <tbody valign="top"> |
---|
| 2179 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
| 2180 | <li><strong>keynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of keynames.</li> |
---|
| 2181 | <li><strong>wherekeynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Default value is an empty list.</li> |
---|
| 2182 | <li><strong>wherekeyvalues</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Default value is an empty list.</li> |
---|
| 2183 | </ul> |
---|
| 2184 | </td> |
---|
| 2185 | </tr> |
---|
| 2186 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>return_list</strong> – List of keyvalues for given keynames.</p> |
---|
| 2187 | </td> |
---|
| 2188 | </tr> |
---|
| 2189 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code></p> |
---|
| 2190 | </td> |
---|
| 2191 | </tr> |
---|
| 2192 | </tbody> |
---|
| 2193 | </table> |
---|
| 2194 | </dd></dl> |
---|
| 2195 | |
---|
| 2196 | <dl class="method"> |
---|
| 2197 | <dt id="GribUtil.GribUtil.index"> |
---|
| 2198 | <code class="descname">index</code><span class="sig-paren">(</span><em>index_keys=['mars'], index_file='my.idx'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribUtil.html#GribUtil.index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.index" title="Permalink to this definition">¶</a></dt> |
---|
| 2199 | <dd><p>Create index file from a list of files if it does not exist or |
---|
| 2200 | read an index file.</p> |
---|
| 2201 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2202 | <col class="field-name" /> |
---|
| 2203 | <col class="field-body" /> |
---|
| 2204 | <tbody valign="top"> |
---|
| 2205 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
| 2206 | <li><strong>index_keys</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Contains the list of key parameter names from |
---|
| 2207 | which the index is to be created. |
---|
| 2208 | Default is a list with a single entry string “mars”.</li> |
---|
| 2209 | <li><strong>index_file</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Filename where the indices are stored. |
---|
| 2210 | Default is “my.idx”.</li> |
---|
| 2211 | </ul> |
---|
| 2212 | </td> |
---|
| 2213 | </tr> |
---|
| 2214 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>iid</strong> – Grib index id.</p> |
---|
| 2215 | </td> |
---|
| 2216 | </tr> |
---|
| 2217 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">integer</span></code></p> |
---|
| 2218 | </td> |
---|
| 2219 | </tr> |
---|
| 2220 | </tbody> |
---|
| 2221 | </table> |
---|
| 2222 | </dd></dl> |
---|
| 2223 | |
---|
| 2224 | <dl class="method"> |
---|
| 2225 | <dt id="GribUtil.GribUtil.set_keys"> |
---|
| 2226 | <code class="descname">set_keys</code><span class="sig-paren">(</span><em>fromfile</em>, <em>keynames</em>, <em>keyvalues</em>, <em>wherekeynames=[]</em>, <em>wherekeyvalues=[]</em>, <em>strict=False</em>, <em>filemode='w'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/GribUtil.html#GribUtil.set_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.set_keys" title="Permalink to this definition">¶</a></dt> |
---|
| 2227 | <dd><p>Opens the file to read the grib messages and then write |
---|
| 2228 | the selected messages (with wherekeys) to a new output file. |
---|
| 2229 | Also, the keyvalues of the passed list of keynames are set.</p> |
---|
| 2230 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2231 | <col class="field-name" /> |
---|
| 2232 | <col class="field-body" /> |
---|
| 2233 | <tbody valign="top"> |
---|
| 2234 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 2235 | <li><strong>fromfile</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Filename of the input file to read the grib messages from.</li> |
---|
| 2236 | <li><strong>keynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of keynames to set in the selected messages. |
---|
| 2237 | Default is an empty list.</li> |
---|
| 2238 | <li><strong>keyvalues</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of keyvalues to set in the selected messages. |
---|
| 2239 | Default is an empty list.</li> |
---|
| 2240 | <li><strong>wherekeynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – List of keynames to select correct message. |
---|
| 2241 | Default value is an empty list.</li> |
---|
| 2242 | <li><strong>wherekeyvalues</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – List of keyvalues for keynames to select correct message. |
---|
| 2243 | Default value is an empty list.</li> |
---|
| 2244 | <li><strong>strict</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">boolean</span></code>, optional) – Decides if everything from keynames and keyvalues |
---|
| 2245 | is written out the grib file (False) or only those |
---|
| 2246 | meeting the where statement (True). Default is False.</li> |
---|
| 2247 | <li><strong>filemode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Sets the mode for the output file. Default is “w”.</li> |
---|
| 2248 | </ul> |
---|
| 2249 | </td> |
---|
| 2250 | </tr> |
---|
| 2251 | </tbody> |
---|
| 2252 | </table> |
---|
| 2253 | </dd></dl> |
---|
| 2254 | |
---|
| 2255 | </dd></dl> |
---|
| 2256 | |
---|
| 2257 | </div> |
---|
| 2258 | <div class="section" id="module-MarsRetrieval"> |
---|
| 2259 | <span id="marsretrieval"></span><h3><a class="toc-backref" href="#id8">MarsRetrieval</a><a class="headerlink" href="#module-MarsRetrieval" title="Permalink to this headline">¶</a></h3> |
---|
| 2260 | <dl class="class"> |
---|
| 2261 | <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> |
---|
| 2263 | <dd><p>Specific syntax and content for submission of MARS retrievals.</p> |
---|
| 2264 | <p>A MARS revtrieval has a specific syntax with a selection of keywords and |
---|
| 2265 | their corresponding values. This class provides the necessary functions |
---|
| 2266 | by displaying the selected parameters and their values and the actual |
---|
| 2267 | retrievement of the data through a mars request or a Python web api |
---|
| 2268 | interface. The initialization already expects all the keyword values.</p> |
---|
| 2269 | <p>A description of MARS keywords/arguments and examples of their |
---|
| 2270 | values can be found here: |
---|
| 2271 | <a class="reference external" href="https://software.ecmwf.int/wiki/display/UDOC/">https://software.ecmwf.int/wiki/display/UDOC/</a> Identification+keywords#Identificationkeywords-class</p> |
---|
| 2272 | <dl class="attribute"> |
---|
| 2273 | <dt id="MarsRetrieval.MarsRetrieval.server"> |
---|
| 2274 | <code class="descname">server</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.server" title="Permalink to this definition">¶</a></dt> |
---|
| 2275 | <dd><p>This is the connection to the ECMWF data servers.</p> |
---|
| 2276 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2277 | <col class="field-name" /> |
---|
| 2278 | <col class="field-body" /> |
---|
| 2279 | <tbody valign="top"> |
---|
| 2280 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">ECMWFService or ECMWFDataServer</td> |
---|
| 2281 | </tr> |
---|
| 2282 | </tbody> |
---|
| 2283 | </table> |
---|
| 2284 | </dd></dl> |
---|
| 2285 | |
---|
| 2286 | <dl class="attribute"> |
---|
| 2287 | <dt id="MarsRetrieval.MarsRetrieval.public"> |
---|
| 2288 | <code class="descname">public</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.public" title="Permalink to this definition">¶</a></dt> |
---|
| 2289 | <dd><p>Decides which Web API Server version is used.</p> |
---|
| 2290 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2291 | <col class="field-name" /> |
---|
| 2292 | <col class="field-body" /> |
---|
| 2293 | <tbody valign="top"> |
---|
| 2294 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
| 2295 | </tr> |
---|
| 2296 | </tbody> |
---|
| 2297 | </table> |
---|
| 2298 | </dd></dl> |
---|
| 2299 | |
---|
| 2300 | <dl class="attribute"> |
---|
| 2301 | <dt id="MarsRetrieval.MarsRetrieval.marsclass"> |
---|
| 2302 | <code class="descname">marsclass</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.marsclass" title="Permalink to this definition">¶</a></dt> |
---|
| 2303 | <dd><p>Characterisation of dataset.</p> |
---|
| 2304 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2305 | <col class="field-name" /> |
---|
| 2306 | <col class="field-body" /> |
---|
| 2307 | <tbody valign="top"> |
---|
| 2308 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2309 | </tr> |
---|
| 2310 | </tbody> |
---|
| 2311 | </table> |
---|
| 2312 | </dd></dl> |
---|
| 2313 | |
---|
| 2314 | <dl class="attribute"> |
---|
| 2315 | <dt id="MarsRetrieval.MarsRetrieval.dataset"> |
---|
| 2316 | <code class="descname">dataset</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.dataset" title="Permalink to this definition">¶</a></dt> |
---|
| 2317 | <dd><p>For public datasets there is the specific naming and parameter |
---|
| 2318 | dataset which has to be used to characterize the type of |
---|
| 2319 | data.</p> |
---|
| 2320 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2321 | <col class="field-name" /> |
---|
| 2322 | <col class="field-body" /> |
---|
| 2323 | <tbody valign="top"> |
---|
| 2324 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2325 | </tr> |
---|
| 2326 | </tbody> |
---|
| 2327 | </table> |
---|
| 2328 | </dd></dl> |
---|
| 2329 | |
---|
| 2330 | <dl class="attribute"> |
---|
| 2331 | <dt id="MarsRetrieval.MarsRetrieval.type"> |
---|
| 2332 | <code class="descname">type</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.type" title="Permalink to this definition">¶</a></dt> |
---|
| 2333 | <dd><p>Determines the type of fields to be retrieved.</p> |
---|
| 2334 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2335 | <col class="field-name" /> |
---|
| 2336 | <col class="field-body" /> |
---|
| 2337 | <tbody valign="top"> |
---|
| 2338 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2339 | </tr> |
---|
| 2340 | </tbody> |
---|
| 2341 | </table> |
---|
| 2342 | </dd></dl> |
---|
| 2343 | |
---|
| 2344 | <dl class="attribute"> |
---|
| 2345 | <dt id="MarsRetrieval.MarsRetrieval.levtype"> |
---|
| 2346 | <code class="descname">levtype</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.levtype" title="Permalink to this definition">¶</a></dt> |
---|
| 2347 | <dd><p>Denotes type of level.</p> |
---|
| 2348 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2349 | <col class="field-name" /> |
---|
| 2350 | <col class="field-body" /> |
---|
| 2351 | <tbody valign="top"> |
---|
| 2352 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2353 | </tr> |
---|
| 2354 | </tbody> |
---|
| 2355 | </table> |
---|
| 2356 | </dd></dl> |
---|
| 2357 | |
---|
| 2358 | <dl class="attribute"> |
---|
| 2359 | <dt id="MarsRetrieval.MarsRetrieval.levelist"> |
---|
| 2360 | <code class="descname">levelist</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.levelist" title="Permalink to this definition">¶</a></dt> |
---|
| 2361 | <dd><p>Specifies the required levels.</p> |
---|
| 2362 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2363 | <col class="field-name" /> |
---|
| 2364 | <col class="field-body" /> |
---|
| 2365 | <tbody valign="top"> |
---|
| 2366 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2367 | </tr> |
---|
| 2368 | </tbody> |
---|
| 2369 | </table> |
---|
| 2370 | </dd></dl> |
---|
| 2371 | |
---|
| 2372 | <dl class="attribute"> |
---|
| 2373 | <dt id="MarsRetrieval.MarsRetrieval.repres"> |
---|
| 2374 | <code class="descname">repres</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.repres" title="Permalink to this definition">¶</a></dt> |
---|
| 2375 | <dd><p>Selects the representation of the archived data.</p> |
---|
| 2376 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2377 | <col class="field-name" /> |
---|
| 2378 | <col class="field-body" /> |
---|
| 2379 | <tbody valign="top"> |
---|
| 2380 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2381 | </tr> |
---|
| 2382 | </tbody> |
---|
| 2383 | </table> |
---|
| 2384 | </dd></dl> |
---|
| 2385 | |
---|
| 2386 | <dl class="attribute"> |
---|
| 2387 | <dt id="MarsRetrieval.MarsRetrieval.date"> |
---|
| 2388 | <code class="descname">date</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.date" title="Permalink to this definition">¶</a></dt> |
---|
| 2389 | <dd><p>Specifies the Analysis date, the Forecast base date or |
---|
| 2390 | Observations date.</p> |
---|
| 2391 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2392 | <col class="field-name" /> |
---|
| 2393 | <col class="field-body" /> |
---|
| 2394 | <tbody valign="top"> |
---|
| 2395 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2396 | </tr> |
---|
| 2397 | </tbody> |
---|
| 2398 | </table> |
---|
| 2399 | </dd></dl> |
---|
| 2400 | |
---|
| 2401 | <dl class="attribute"> |
---|
| 2402 | <dt id="MarsRetrieval.MarsRetrieval.resol"> |
---|
| 2403 | <code class="descname">resol</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.resol" title="Permalink to this definition">¶</a></dt> |
---|
| 2404 | <dd><p>Specifies the desired triangular truncation of retrieved data, |
---|
| 2405 | before carrying out any other selected post-processing.</p> |
---|
| 2406 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2407 | <col class="field-name" /> |
---|
| 2408 | <col class="field-body" /> |
---|
| 2409 | <tbody valign="top"> |
---|
| 2410 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2411 | </tr> |
---|
| 2412 | </tbody> |
---|
| 2413 | </table> |
---|
| 2414 | </dd></dl> |
---|
| 2415 | |
---|
| 2416 | <dl class="attribute"> |
---|
| 2417 | <dt id="MarsRetrieval.MarsRetrieval.stream"> |
---|
| 2418 | <code class="descname">stream</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.stream" title="Permalink to this definition">¶</a></dt> |
---|
| 2419 | <dd><p>Identifies the forecasting system used to generate the data.</p> |
---|
| 2420 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2421 | <col class="field-name" /> |
---|
| 2422 | <col class="field-body" /> |
---|
| 2423 | <tbody valign="top"> |
---|
| 2424 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2425 | </tr> |
---|
| 2426 | </tbody> |
---|
| 2427 | </table> |
---|
| 2428 | </dd></dl> |
---|
| 2429 | |
---|
| 2430 | <dl class="attribute"> |
---|
| 2431 | <dt id="MarsRetrieval.MarsRetrieval.area"> |
---|
| 2432 | <code class="descname">area</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.area" title="Permalink to this definition">¶</a></dt> |
---|
| 2433 | <dd><p>Specifies the desired sub-area of data to be extracted.</p> |
---|
| 2434 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2435 | <col class="field-name" /> |
---|
| 2436 | <col class="field-body" /> |
---|
| 2437 | <tbody valign="top"> |
---|
| 2438 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2439 | </tr> |
---|
| 2440 | </tbody> |
---|
| 2441 | </table> |
---|
| 2442 | </dd></dl> |
---|
| 2443 | |
---|
| 2444 | <dl class="attribute"> |
---|
| 2445 | <dt id="MarsRetrieval.MarsRetrieval.time"> |
---|
| 2446 | <code class="descname">time</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.time" title="Permalink to this definition">¶</a></dt> |
---|
| 2447 | <dd><p>Specifies the time of the data in hours and minutes.</p> |
---|
| 2448 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2449 | <col class="field-name" /> |
---|
| 2450 | <col class="field-body" /> |
---|
| 2451 | <tbody valign="top"> |
---|
| 2452 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2453 | </tr> |
---|
| 2454 | </tbody> |
---|
| 2455 | </table> |
---|
| 2456 | </dd></dl> |
---|
| 2457 | |
---|
| 2458 | <dl class="attribute"> |
---|
| 2459 | <dt id="MarsRetrieval.MarsRetrieval.step"> |
---|
| 2460 | <code class="descname">step</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.step" title="Permalink to this definition">¶</a></dt> |
---|
| 2461 | <dd><p>Specifies the forecast time step from forecast base time.</p> |
---|
| 2462 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2463 | <col class="field-name" /> |
---|
| 2464 | <col class="field-body" /> |
---|
| 2465 | <tbody valign="top"> |
---|
| 2466 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2467 | </tr> |
---|
| 2468 | </tbody> |
---|
| 2469 | </table> |
---|
| 2470 | </dd></dl> |
---|
| 2471 | |
---|
| 2472 | <dl class="attribute"> |
---|
| 2473 | <dt id="MarsRetrieval.MarsRetrieval.expver"> |
---|
| 2474 | <code class="descname">expver</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.expver" title="Permalink to this definition">¶</a></dt> |
---|
| 2475 | <dd><p>The version of the dataset.</p> |
---|
| 2476 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2477 | <col class="field-name" /> |
---|
| 2478 | <col class="field-body" /> |
---|
| 2479 | <tbody valign="top"> |
---|
| 2480 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2481 | </tr> |
---|
| 2482 | </tbody> |
---|
| 2483 | </table> |
---|
| 2484 | </dd></dl> |
---|
| 2485 | |
---|
| 2486 | <dl class="attribute"> |
---|
| 2487 | <dt id="MarsRetrieval.MarsRetrieval.number"> |
---|
| 2488 | <code class="descname">number</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.number" title="Permalink to this definition">¶</a></dt> |
---|
| 2489 | <dd><p>Selects the member in ensemble forecast run.</p> |
---|
[274f9ef] | 2490 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2491 | <col class="field-name" /> |
---|
| 2492 | <col class="field-body" /> |
---|
| 2493 | <tbody valign="top"> |
---|
[2625ca8] | 2494 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
[274f9ef] | 2495 | </tr> |
---|
| 2496 | </tbody> |
---|
| 2497 | </table> |
---|
| 2498 | </dd></dl> |
---|
| 2499 | |
---|
[2625ca8] | 2500 | <dl class="attribute"> |
---|
| 2501 | <dt id="MarsRetrieval.MarsRetrieval.accuracy"> |
---|
| 2502 | <code class="descname">accuracy</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.accuracy" title="Permalink to this definition">¶</a></dt> |
---|
| 2503 | <dd><p>Specifies the number of bits per value to be used in the |
---|
| 2504 | generated GRIB coded fields.</p> |
---|
[274f9ef] | 2505 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2506 | <col class="field-name" /> |
---|
| 2507 | <col class="field-body" /> |
---|
| 2508 | <tbody valign="top"> |
---|
[2625ca8] | 2509 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
[274f9ef] | 2510 | </tr> |
---|
| 2511 | </tbody> |
---|
| 2512 | </table> |
---|
| 2513 | </dd></dl> |
---|
| 2514 | |
---|
[2625ca8] | 2515 | <dl class="attribute"> |
---|
| 2516 | <dt id="MarsRetrieval.MarsRetrieval.grid"> |
---|
| 2517 | <code class="descname">grid</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.grid" title="Permalink to this definition">¶</a></dt> |
---|
| 2518 | <dd><p>Specifies the output grid which can be either a Gaussian grid |
---|
| 2519 | or a Latitude/Longitude grid.</p> |
---|
[274f9ef] | 2520 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2521 | <col class="field-name" /> |
---|
| 2522 | <col class="field-body" /> |
---|
| 2523 | <tbody valign="top"> |
---|
[2625ca8] | 2524 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
[274f9ef] | 2525 | </tr> |
---|
| 2526 | </tbody> |
---|
| 2527 | </table> |
---|
| 2528 | </dd></dl> |
---|
| 2529 | |
---|
[2625ca8] | 2530 | <dl class="attribute"> |
---|
| 2531 | <dt id="MarsRetrieval.MarsRetrieval.gaussian"> |
---|
| 2532 | <code class="descname">gaussian</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.gaussian" title="Permalink to this definition">¶</a></dt> |
---|
| 2533 | <dd><p>This parameter is deprecated and should no longer be used. |
---|
| 2534 | Specifies the desired type of Gaussian grid for the output.</p> |
---|
[274f9ef] | 2535 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2536 | <col class="field-name" /> |
---|
| 2537 | <col class="field-body" /> |
---|
| 2538 | <tbody valign="top"> |
---|
[2625ca8] | 2539 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
[274f9ef] | 2540 | </tr> |
---|
| 2541 | </tbody> |
---|
| 2542 | </table> |
---|
| 2543 | </dd></dl> |
---|
| 2544 | |
---|
[2625ca8] | 2545 | <dl class="attribute"> |
---|
| 2546 | <dt id="MarsRetrieval.MarsRetrieval.target"> |
---|
| 2547 | <code class="descname">target</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.target" title="Permalink to this definition">¶</a></dt> |
---|
| 2548 | <dd><p>Specifies a file into which data is to be written after |
---|
| 2549 | retrieval or manipulation.</p> |
---|
[274f9ef] | 2550 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2551 | <col class="field-name" /> |
---|
| 2552 | <col class="field-body" /> |
---|
| 2553 | <tbody valign="top"> |
---|
[2625ca8] | 2554 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
[274f9ef] | 2555 | </tr> |
---|
| 2556 | </tbody> |
---|
| 2557 | </table> |
---|
| 2558 | </dd></dl> |
---|
| 2559 | |
---|
[2625ca8] | 2560 | <dl class="attribute"> |
---|
| 2561 | <dt id="MarsRetrieval.MarsRetrieval.param"> |
---|
| 2562 | <code class="descname">param</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.param" title="Permalink to this definition">¶</a></dt> |
---|
| 2563 | <dd><p>Specifies the meteorological parameter.</p> |
---|
| 2564 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2565 | <col class="field-name" /> |
---|
| 2566 | <col class="field-body" /> |
---|
| 2567 | <tbody valign="top"> |
---|
| 2568 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
| 2569 | </tr> |
---|
| 2570 | </tbody> |
---|
| 2571 | </table> |
---|
[274f9ef] | 2572 | </dd></dl> |
---|
| 2573 | |
---|
| 2574 | <dl class="method"> |
---|
| 2575 | <dt id="MarsRetrieval.MarsRetrieval.data_retrieve"> |
---|
| 2576 | <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> |
---|
| 2577 | <dd><p>Submits a MARS retrieval. Depending on the existence of |
---|
| 2578 | ECMWF Web-API it is submitted via Python or a |
---|
| 2579 | subprocess in the Shell. The parameter for the mars retrieval |
---|
| 2580 | are taken from the defined class attributes.</p> |
---|
| 2581 | </dd></dl> |
---|
| 2582 | |
---|
| 2583 | <dl class="method"> |
---|
| 2584 | <dt id="MarsRetrieval.MarsRetrieval.display_info"> |
---|
| 2585 | <code class="descname">display_info</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/MarsRetrieval.html#MarsRetrieval.display_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.display_info" title="Permalink to this definition">¶</a></dt> |
---|
| 2586 | <dd><p>Prints all class attributes and their values to the |
---|
| 2587 | standard output.</p> |
---|
| 2588 | </dd></dl> |
---|
| 2589 | |
---|
| 2590 | <dl class="method"> |
---|
| 2591 | <dt id="MarsRetrieval.MarsRetrieval.print_infodata_csv"> |
---|
| 2592 | <code class="descname">print_infodata_csv</code><span class="sig-paren">(</span><em>inputdir</em>, <em>request_number</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/MarsRetrieval.html#MarsRetrieval.print_infodata_csv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.print_infodata_csv" title="Permalink to this definition">¶</a></dt> |
---|
| 2593 | <dd><p>Write all request parameter in alpabetical order into a “csv” file.</p> |
---|
| 2594 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2595 | <col class="field-name" /> |
---|
| 2596 | <col class="field-body" /> |
---|
| 2597 | <tbody valign="top"> |
---|
| 2598 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[2625ca8] | 2599 | <li><strong>inputdir</strong> (<em>str</em>) – The path where all data from the retrievals are stored.</li> |
---|
| 2600 | <li><strong>request_number</strong> (<em>int</em>) – Number of mars requests for flux and non-flux data.</li> |
---|
[274f9ef] | 2601 | </ul> |
---|
| 2602 | </td> |
---|
| 2603 | </tr> |
---|
| 2604 | </tbody> |
---|
| 2605 | </table> |
---|
| 2606 | </dd></dl> |
---|
| 2607 | |
---|
| 2608 | </dd></dl> |
---|
[708c667] | 2609 | |
---|
[274f9ef] | 2610 | </div> |
---|
| 2611 | <div class="section" id="module-UioFiles"> |
---|
| 2612 | <span id="uiofiles"></span><h3><a class="toc-backref" href="#id9">UioFiles</a><a class="headerlink" href="#module-UioFiles" title="Permalink to this headline">¶</a></h3> |
---|
| 2613 | <dl class="class"> |
---|
| 2614 | <dt id="UioFiles.UioFiles"> |
---|
| 2615 | <em class="property">class </em><code class="descclassname">UioFiles.</code><code class="descname">UioFiles</code><span class="sig-paren">(</span><em>path</em>, <em>pattern</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/UioFiles.html#UioFiles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#UioFiles.UioFiles" title="Permalink to this definition">¶</a></dt> |
---|
[2625ca8] | 2616 | <dd><p>Collection of files matching a specific pattern.</p> |
---|
| 2617 | <p>The pattern can contain regular expressions for the files. |
---|
| 2618 | The files are listed and can be transformed to a single string or |
---|
| 2619 | they can be deleted.</p> |
---|
| 2620 | <dl class="attribute"> |
---|
| 2621 | <dt id="UioFiles.UioFiles.path"> |
---|
| 2622 | <code class="descname">path</code><a class="headerlink" href="#UioFiles.UioFiles.path" title="Permalink to this definition">¶</a></dt> |
---|
| 2623 | <dd><p>Directory where to list the files.</p> |
---|
| 2624 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2625 | <col class="field-name" /> |
---|
| 2626 | <col class="field-body" /> |
---|
| 2627 | <tbody valign="top"> |
---|
| 2628 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 2629 | </tr> |
---|
| 2630 | </tbody> |
---|
| 2631 | </table> |
---|
| 2632 | </dd></dl> |
---|
| 2633 | |
---|
| 2634 | <dl class="attribute"> |
---|
| 2635 | <dt id="UioFiles.UioFiles.pattern"> |
---|
| 2636 | <code class="descname">pattern</code><a class="headerlink" href="#UioFiles.UioFiles.pattern" title="Permalink to this definition">¶</a></dt> |
---|
| 2637 | <dd><p>Regular expression pattern. For example: ‘*.grb’</p> |
---|
| 2638 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2639 | <col class="field-name" /> |
---|
| 2640 | <col class="field-body" /> |
---|
| 2641 | <tbody valign="top"> |
---|
| 2642 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
| 2643 | </tr> |
---|
| 2644 | </tbody> |
---|
| 2645 | </table> |
---|
| 2646 | </dd></dl> |
---|
| 2647 | |
---|
| 2648 | <dl class="attribute"> |
---|
| 2649 | <dt id="UioFiles.UioFiles.files"> |
---|
| 2650 | <code class="descname">files</code><a class="headerlink" href="#UioFiles.UioFiles.files" title="Permalink to this definition">¶</a></dt> |
---|
| 2651 | <dd><p>List of files matching the pattern in the path.</p> |
---|
| 2652 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2653 | <col class="field-name" /> |
---|
| 2654 | <col class="field-body" /> |
---|
| 2655 | <tbody valign="top"> |
---|
| 2656 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
| 2657 | </tr> |
---|
| 2658 | </tbody> |
---|
| 2659 | </table> |
---|
| 2660 | </dd></dl> |
---|
| 2661 | |
---|
[274f9ef] | 2662 | <dl class="method"> |
---|
| 2663 | <dt id="UioFiles.UioFiles.delete_files"> |
---|
| 2664 | <code class="descname">delete_files</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/UioFiles.html#UioFiles.delete_files"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#UioFiles.UioFiles.delete_files" title="Permalink to this definition">¶</a></dt> |
---|
| 2665 | <dd><p>Deletes the files.</p> |
---|
| 2666 | </dd></dl> |
---|
[708c667] | 2667 | |
---|
[274f9ef] | 2668 | </dd></dl> |
---|
[708c667] | 2669 | |
---|
[274f9ef] | 2670 | </div> |
---|
| 2671 | </div> |
---|
| 2672 | <div class="section" id="modules"> |
---|
| 2673 | <h2><a class="toc-backref" href="#id10">Modules</a><a class="headerlink" href="#modules" title="Permalink to this headline">¶</a></h2> |
---|
| 2674 | <div class="section" id="module-get_mars_data"> |
---|
| 2675 | <span id="get-mars-data"></span><h3><a class="toc-backref" href="#id11">get_mars_data</a><a class="headerlink" href="#module-get_mars_data" title="Permalink to this headline">¶</a></h3> |
---|
[2625ca8] | 2676 | <p>This script extracts MARS data from ECMWF servers.</p> |
---|
| 2677 | <p>At first, the necessary parameters from command line and CONTROL files are |
---|
| 2678 | extracted. They define the data set to be extracted from MARS.</p> |
---|
| 2679 | <p>This file can also be imported as a module and contains the following |
---|
| 2680 | functions:</p> |
---|
| 2681 | <blockquote> |
---|
| 2682 | <div><ul class="simple"> |
---|
| 2683 | <li>main - the main function of the script</li> |
---|
| 2684 | <li>get_mars_data - overall control of ECMWF data retrievment</li> |
---|
| 2685 | <li>write_reqheader - writes the header into the mars_request file</li> |
---|
| 2686 | <li>mk_server - creates the server connection to ECMWF servers</li> |
---|
| 2687 | <li>mk_dates - defines the start and end date</li> |
---|
| 2688 | <li>remove_old - deletes old retrieved grib files</li> |
---|
| 2689 | <li>do_retrievement - creates individual retrievals</li> |
---|
| 2690 | </ul> |
---|
| 2691 | </div></blockquote> |
---|
| 2692 | <p>Type: get_mars_data.py –help |
---|
| 2693 | to get information about command line parameters. |
---|
| 2694 | Read the documentation for usage instructions.</p> |
---|
[274f9ef] | 2695 | <dl class="function"> |
---|
| 2696 | <dt id="get_mars_data.do_retrievement"> |
---|
| 2697 | <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> |
---|
| 2698 | <dd><p>Divides the complete retrieval period in smaller chunks and |
---|
| 2699 | retrieves the data from MARS.</p> |
---|
| 2700 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2701 | <col class="field-name" /> |
---|
| 2702 | <col class="field-body" /> |
---|
| 2703 | <tbody valign="top"> |
---|
| 2704 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[2625ca8] | 2705 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
[274f9ef] | 2706 | command line.</li> |
---|
[2625ca8] | 2707 | <li><strong>server</strong> (<em>ECMWFService</em><em> or </em><em>ECMWFDataServer</em>) – The server connection to ECMWF.</li> |
---|
| 2708 | <li><strong>start</strong> (<em>datetime</em>) – The start date of the retrieval.</li> |
---|
| 2709 | <li><strong>end</strong> (<em>datetime</em>) – The end date of the retrieval.</li> |
---|
| 2710 | <li><strong>delta_t</strong> (<em>datetime</em>) – Delta_t + 1 is the maximal time period of a single |
---|
[274f9ef] | 2711 | retrieval.</li> |
---|
[2625ca8] | 2712 | <li><strong>fluxes</strong> (<em>boolean</em><em>, </em><em>optional</em>) – Decides if the flux parameters are to be retrieved or |
---|
[274f9ef] | 2713 | the rest of the parameter list. |
---|
| 2714 | Default value is False.</li> |
---|
| 2715 | </ul> |
---|
| 2716 | </td> |
---|
| 2717 | </tr> |
---|
| 2718 | </tbody> |
---|
| 2719 | </table> |
---|
| 2720 | </dd></dl> |
---|
[708c667] | 2721 | |
---|
[274f9ef] | 2722 | <dl class="function"> |
---|
| 2723 | <dt id="get_mars_data.get_mars_data"> |
---|
| 2724 | <code class="descclassname">get_mars_data.</code><code class="descname">get_mars_data</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#get_mars_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.get_mars_data" title="Permalink to this definition">¶</a></dt> |
---|
| 2725 | <dd><p>Retrieves the EC data needed for a FLEXPART simulation.</p> |
---|
| 2726 | <p>Start and end dates for retrieval period is set. Retrievals |
---|
| 2727 | are divided into smaller periods if necessary and datechunk parameter |
---|
| 2728 | is set.</p> |
---|
| 2729 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2730 | <col class="field-name" /> |
---|
| 2731 | <col class="field-body" /> |
---|
| 2732 | <tbody valign="top"> |
---|
[2625ca8] | 2733 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
[274f9ef] | 2734 | command line.</td> |
---|
| 2735 | </tr> |
---|
| 2736 | </tbody> |
---|
| 2737 | </table> |
---|
| 2738 | </dd></dl> |
---|
| 2739 | |
---|
| 2740 | <dl class="function"> |
---|
| 2741 | <dt id="get_mars_data.main"> |
---|
| 2742 | <code class="descclassname">get_mars_data.</code><code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.main" title="Permalink to this definition">¶</a></dt> |
---|
| 2743 | <dd><p>Controls the program to get data out of mars.</p> |
---|
| 2744 | <p>This is done if it is called directly from command line. |
---|
| 2745 | Then it also takes program call arguments and control file input.</p> |
---|
| 2746 | </dd></dl> |
---|
| 2747 | |
---|
[2625ca8] | 2748 | <dl class="function"> |
---|
| 2749 | <dt id="get_mars_data.mk_dates"> |
---|
| 2750 | <code class="descclassname">get_mars_data.</code><code class="descname">mk_dates</code><span class="sig-paren">(</span><em>c</em>, <em>fluxes</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#mk_dates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.mk_dates" title="Permalink to this definition">¶</a></dt> |
---|
| 2751 | <dd><p>Prepares start and end date depending on flux or non flux data.</p> |
---|
| 2752 | <p>If forecast for maximum one day (upto 24h) are to be retrieved, then |
---|
| 2753 | collect accumulation data (flux data) with additional days in the |
---|
| 2754 | beginning and at the end (used for complete disaggregation of |
---|
| 2755 | original period)</p> |
---|
| 2756 | <p>If forecast data longer than 24h are to be retrieved, then |
---|
| 2757 | collect accumulation data (flux data) with the exact start and end date |
---|
| 2758 | (disaggregation will be done for the exact time period with |
---|
| 2759 | boundary conditions)</p> |
---|
| 2760 | <p>Since for basetime the extraction contains the 12 hours upfront, |
---|
| 2761 | if basetime is 0, the starting date has to be the day before and</p> |
---|
| 2762 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2763 | <col class="field-name" /> |
---|
| 2764 | <col class="field-body" /> |
---|
| 2765 | <tbody valign="top"> |
---|
| 2766 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
| 2767 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
| 2768 | command line.</li> |
---|
| 2769 | <li><strong>fluxes</strong> (<em>boolean</em><em>, </em><em>optional</em>) – Decides if the flux parameter settings are stored or |
---|
| 2770 | the rest of the parameter list. |
---|
| 2771 | Default value is False.</li> |
---|
| 2772 | </ul> |
---|
| 2773 | </td> |
---|
| 2774 | </tr> |
---|
| 2775 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><ul class="simple"> |
---|
| 2776 | <li><strong>start</strong> (<em>datetime</em>) – The start date of the retrieving data set.</li> |
---|
| 2777 | <li><strong>end</strong> (<em>datetime</em>) – The end date of the retrieving data set.</li> |
---|
| 2778 | <li><strong>chunk</strong> (<em>datetime</em>) – Time period in days for one single mars retrieval.</li> |
---|
| 2779 | </ul> |
---|
| 2780 | </p> |
---|
| 2781 | </td> |
---|
| 2782 | </tr> |
---|
| 2783 | </tbody> |
---|
| 2784 | </table> |
---|
| 2785 | </dd></dl> |
---|
| 2786 | |
---|
| 2787 | <dl class="function"> |
---|
| 2788 | <dt id="get_mars_data.mk_server"> |
---|
| 2789 | <code class="descclassname">get_mars_data.</code><code class="descname">mk_server</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#mk_server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.mk_server" title="Permalink to this definition">¶</a></dt> |
---|
| 2790 | <dd><p>Creates server connection if ECMWF WebAPI is available.</p> |
---|
| 2791 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2792 | <col class="field-name" /> |
---|
| 2793 | <col class="field-body" /> |
---|
| 2794 | <tbody valign="top"> |
---|
| 2795 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
| 2796 | command line.</td> |
---|
| 2797 | </tr> |
---|
| 2798 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>server</strong> – Connection to ECMWF server via python interface ECMWF WebAPI.</td> |
---|
| 2799 | </tr> |
---|
| 2800 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">ECMWFDataServer or ECMWFService</td> |
---|
| 2801 | </tr> |
---|
| 2802 | </tbody> |
---|
| 2803 | </table> |
---|
| 2804 | </dd></dl> |
---|
| 2805 | |
---|
| 2806 | <dl class="function"> |
---|
| 2807 | <dt id="get_mars_data.remove_old"> |
---|
| 2808 | <code class="descclassname">get_mars_data.</code><code class="descname">remove_old</code><span class="sig-paren">(</span><em>pattern</em>, <em>inputdir</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#remove_old"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.remove_old" title="Permalink to this definition">¶</a></dt> |
---|
| 2809 | <dd><p>Deletes old retrieval files from current input directory |
---|
| 2810 | matching the pattern.</p> |
---|
| 2811 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2812 | <col class="field-name" /> |
---|
| 2813 | <col class="field-body" /> |
---|
| 2814 | <tbody valign="top"> |
---|
| 2815 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 2816 | <li><strong>pattern</strong> (<em>str</em>) – The sub string pattern which identifies the files to be deleted.</li> |
---|
| 2817 | <li><strong>inputdir</strong> (<em>str</em><em>, </em><em>optional</em>) – Path to the directory where the retrieved data is stored.</li> |
---|
| 2818 | </ul> |
---|
| 2819 | </td> |
---|
| 2820 | </tr> |
---|
| 2821 | </tbody> |
---|
| 2822 | </table> |
---|
| 2823 | </dd></dl> |
---|
| 2824 | |
---|
| 2825 | <dl class="function"> |
---|
| 2826 | <dt id="get_mars_data.write_reqheader"> |
---|
| 2827 | <code class="descclassname">get_mars_data.</code><code class="descname">write_reqheader</code><span class="sig-paren">(</span><em>marsfile</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/get_mars_data.html#write_reqheader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.write_reqheader" title="Permalink to this definition">¶</a></dt> |
---|
| 2828 | <dd><p>Writes header with column names into mars request file.</p> |
---|
| 2829 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2830 | <col class="field-name" /> |
---|
| 2831 | <col class="field-body" /> |
---|
| 2832 | <tbody valign="top"> |
---|
| 2833 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>marsfile</strong> (<em>str</em>) – Path to the mars request file.</td> |
---|
| 2834 | </tr> |
---|
| 2835 | </tbody> |
---|
| 2836 | </table> |
---|
| 2837 | </dd></dl> |
---|
| 2838 | |
---|
[274f9ef] | 2839 | </div> |
---|
| 2840 | <div class="section" id="module-prepare_flexpart"> |
---|
| 2841 | <span id="prepare-flexpart"></span><h3><a class="toc-backref" href="#id12">prepare_flexpart</a><a class="headerlink" href="#module-prepare_flexpart" title="Permalink to this headline">¶</a></h3> |
---|
[2625ca8] | 2842 | <p>This script prepares the final version of the grib files which are |
---|
| 2843 | then used by FLEXPART.</p> |
---|
| 2844 | <p>It converts the bunch of grib files extracted via get_mars_data before, |
---|
| 2845 | by doing the necessary conversion to get consistent grids or the |
---|
| 2846 | disaggregation of flux data. Finally, the data fields are combined |
---|
| 2847 | in files per available hour with the naming convention xxYYMMDDHH, |
---|
| 2848 | where xx should be 2 arbitrary letters (mostly xx is chosen to be “EN”).</p> |
---|
| 2849 | <p>This file can also be imported as a module which then contains the following |
---|
| 2850 | functions:</p> |
---|
| 2851 | <blockquote> |
---|
| 2852 | <div><ul class="simple"> |
---|
| 2853 | <li>main</li> |
---|
| 2854 | <li>prepare_flexpart</li> |
---|
| 2855 | </ul> |
---|
| 2856 | </div></blockquote> |
---|
| 2857 | <p>Type: prepare_flexpart.py –help |
---|
| 2858 | to get information about command line parameters. |
---|
| 2859 | Read the documentation for usage instructions.</p> |
---|
[274f9ef] | 2860 | <dl class="function"> |
---|
| 2861 | <dt id="prepare_flexpart.main"> |
---|
| 2862 | <code class="descclassname">prepare_flexpart.</code><code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/prepare_flexpart.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#prepare_flexpart.main" title="Permalink to this definition">¶</a></dt> |
---|
| 2863 | <dd><p>Controls the program to prepare flexpart input files from mars data.</p> |
---|
| 2864 | <p>This is done if it is called directly from command line. |
---|
| 2865 | Then it also takes program call arguments and control file input.</p> |
---|
| 2866 | </dd></dl> |
---|
[708c667] | 2867 | |
---|
[274f9ef] | 2868 | <dl class="function"> |
---|
| 2869 | <dt id="prepare_flexpart.prepare_flexpart"> |
---|
| 2870 | <code class="descclassname">prepare_flexpart.</code><code class="descname">prepare_flexpart</code><span class="sig-paren">(</span><em>ppid</em>, <em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/prepare_flexpart.html#prepare_flexpart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#prepare_flexpart.prepare_flexpart" title="Permalink to this definition">¶</a></dt> |
---|
| 2871 | <dd><p>Converts the mars data into flexpart ready input files.</p> |
---|
| 2872 | <p>Specific data fields are converted to a different grid and the flux |
---|
| 2873 | data are going to be disaggregated. The data fields are collected by |
---|
| 2874 | hour and stored in a file with a specific FLEXPART relevant naming |
---|
| 2875 | convention.</p> |
---|
| 2876 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2877 | <col class="field-name" /> |
---|
| 2878 | <col class="field-body" /> |
---|
| 2879 | <tbody valign="top"> |
---|
| 2880 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[2625ca8] | 2881 | <li><strong>ppid</strong> (<em>int</em>) – Contains the ppid number of the current ECMWF job. It will be None if |
---|
[274f9ef] | 2882 | the method was called within this module.</li> |
---|
[2625ca8] | 2883 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
[274f9ef] | 2884 | command line.</li> |
---|
| 2885 | </ul> |
---|
| 2886 | </td> |
---|
| 2887 | </tr> |
---|
| 2888 | </tbody> |
---|
| 2889 | </table> |
---|
| 2890 | </dd></dl> |
---|
[708c667] | 2891 | |
---|
[274f9ef] | 2892 | </div> |
---|
| 2893 | <div class="section" id="module-tools"> |
---|
| 2894 | <span id="tools"></span><h3><a class="toc-backref" href="#id13">tools</a><a class="headerlink" href="#module-tools" title="Permalink to this headline">¶</a></h3> |
---|
[2625ca8] | 2895 | <p>This module contains a collection of diverse tasks within flex_extract.</p> |
---|
[274f9ef] | 2896 | <dl class="function"> |
---|
| 2897 | <dt id="tools.clean_up"> |
---|
| 2898 | <code class="descclassname">tools.</code><code class="descname">clean_up</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#clean_up"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.clean_up" title="Permalink to this definition">¶</a></dt> |
---|
[2625ca8] | 2899 | <dd><p>Remove files from the intermediate directory (inputdir).</p> |
---|
| 2900 | <p>It keeps the final FLEXPART input files if program runs without |
---|
| 2901 | ECMWF Api and keywords “ectrans” or “ecstorage” are set to “1”.</p> |
---|
[274f9ef] | 2902 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2903 | <col class="field-name" /> |
---|
| 2904 | <col class="field-body" /> |
---|
| 2905 | <tbody valign="top"> |
---|
[2625ca8] | 2906 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
[274f9ef] | 2907 | command line.</td> |
---|
| 2908 | </tr> |
---|
| 2909 | </tbody> |
---|
| 2910 | </table> |
---|
| 2911 | </dd></dl> |
---|
[708c667] | 2912 | |
---|
[274f9ef] | 2913 | <dl class="function"> |
---|
[2625ca8] | 2914 | <dt id="tools.execute_subprocess"> |
---|
| 2915 | <code class="descclassname">tools.</code><code class="descname">execute_subprocess</code><span class="sig-paren">(</span><em>cmd_list</em>, <em>error_msg='SUBPROCESS FAILED!'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#execute_subprocess"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.execute_subprocess" title="Permalink to this definition">¶</a></dt> |
---|
| 2916 | <dd><p>Executes a command line instruction via a subprocess.</p> |
---|
| 2917 | <p>Error handling is done if an error occures.</p> |
---|
| 2918 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2919 | <col class="field-name" /> |
---|
| 2920 | <col class="field-body" /> |
---|
| 2921 | <tbody valign="top"> |
---|
| 2922 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cmd_list</strong> (<em>list of str</em>) – A list of the components for the command line execution. Each |
---|
| 2923 | list entry is a single part of the command which is seperated from |
---|
| 2924 | the rest by a blank space. |
---|
| 2925 | E.g. [‘mv’, file1, file2]</td> |
---|
| 2926 | </tr> |
---|
| 2927 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>error_msg</strong> – The possible error message if the subprocess failed. |
---|
| 2928 | By default it will just tell “SUBPROCESS FAILED!”.</td> |
---|
| 2929 | </tr> |
---|
| 2930 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str, optional</td> |
---|
| 2931 | </tr> |
---|
| 2932 | </tbody> |
---|
| 2933 | </table> |
---|
| 2934 | </dd></dl> |
---|
| 2935 | |
---|
| 2936 | <dl class="function"> |
---|
| 2937 | <dt id="tools.get_cmdline_args"> |
---|
| 2938 | <code class="descclassname">tools.</code><code class="descname">get_cmdline_args</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#get_cmdline_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_cmdline_args" title="Permalink to this definition">¶</a></dt> |
---|
[274f9ef] | 2939 | <dd><p>Decomposes the command line arguments and assigns them to variables. |
---|
| 2940 | Apply default values for non mentioned arguments.</p> |
---|
| 2941 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2942 | <col class="field-name" /> |
---|
| 2943 | <col class="field-body" /> |
---|
| 2944 | <tbody valign="top"> |
---|
| 2945 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>args</strong> – Contains the commandline arguments from script/program call.</td> |
---|
| 2946 | </tr> |
---|
[2625ca8] | 2947 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Namespace</td> |
---|
| 2948 | </tr> |
---|
| 2949 | </tbody> |
---|
| 2950 | </table> |
---|
| 2951 | </dd></dl> |
---|
| 2952 | |
---|
| 2953 | <dl class="function"> |
---|
| 2954 | <dt id="tools.get_dimensions"> |
---|
| 2955 | <code class="descclassname">tools.</code><code class="descname">get_dimensions</code><span class="sig-paren">(</span><em>info</em>, <em>purefc</em>, <em>dtime</em>, <em>index_vals</em>, <em>start_date</em>, <em>end_date</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#get_dimensions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_dimensions" title="Permalink to this definition">¶</a></dt> |
---|
| 2956 | <dd><p>This function specifies the correct dimensions for x, y and t.</p> |
---|
| 2957 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2958 | <col class="field-name" /> |
---|
| 2959 | <col class="field-body" /> |
---|
| 2960 | <tbody valign="top"> |
---|
| 2961 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
| 2962 | <li><strong>info</strong> (<em>dict</em>) – Contains basic informations of the ECMWF grib files, e.g. |
---|
| 2963 | ‘Ni’, ‘Nj’, ‘latitudeOfFirstGridPointInDegrees’, |
---|
| 2964 | ‘longitudeOfFirstGridPointInDegrees’, ‘latitudeOfLastGridPointInDegrees’, |
---|
| 2965 | ‘longitudeOfLastGridPointInDegrees’, ‘jDirectionIncrementInDegrees’, |
---|
| 2966 | ‘iDirectionIncrementInDegrees’, ‘missingValue’</li> |
---|
| 2967 | <li><strong>purefc</strong> (<em>int</em>) – Switch for definition of pure forecast mode or not.</li> |
---|
| 2968 | <li><strong>dtime</strong> (<em>str</em>) – Time step in hours.</li> |
---|
| 2969 | <li><strong>index_vals</strong> (<em>list of list of str</em>) – Contains the values from the keys used for a distinct selection |
---|
| 2970 | of grib messages in processing the grib files. |
---|
| 2971 | Content looks like e.g.: |
---|
| 2972 | index_vals[0]: (‘20171106’, ‘20171107’, ‘20171108’) ; date |
---|
| 2973 | index_vals[1]: (‘0’, ‘1200’, ‘1800’, ‘600’) ; time |
---|
| 2974 | index_vals[2]: (‘0’, ‘12’, ‘3’, ‘6’, ‘9’) ; stepRange</li> |
---|
| 2975 | <li><strong>start_date</strong> (<em>str</em>) – The start date of the retrieval job.</li> |
---|
| 2976 | <li><strong>end_date</strong> (<em>str</em>) – The end date of the retrieval job.</li> |
---|
| 2977 | </ul> |
---|
| 2978 | </td> |
---|
| 2979 | </tr> |
---|
| 2980 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>(ix, jy, it)</strong> – Dimension in x-direction, y-direction and in time.</p> |
---|
| 2981 | </td> |
---|
| 2982 | </tr> |
---|
| 2983 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">tuple of int</p> |
---|
| 2984 | </td> |
---|
| 2985 | </tr> |
---|
| 2986 | </tbody> |
---|
| 2987 | </table> |
---|
| 2988 | </dd></dl> |
---|
| 2989 | |
---|
| 2990 | <dl class="function"> |
---|
| 2991 | <dt id="tools.get_informations"> |
---|
| 2992 | <code class="descclassname">tools.</code><code class="descname">get_informations</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#get_informations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_informations" title="Permalink to this definition">¶</a></dt> |
---|
| 2993 | <dd><p>Gets basic information from an example grib file.</p> |
---|
| 2994 | <p>These information are important for later use and the |
---|
| 2995 | initialization of numpy arrays for data storing.</p> |
---|
| 2996 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 2997 | <col class="field-name" /> |
---|
| 2998 | <col class="field-body" /> |
---|
| 2999 | <tbody valign="top"> |
---|
| 3000 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>str</em>) – Name of the file which will be opened to extract basic information.</td> |
---|
| 3001 | </tr> |
---|
| 3002 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>data</strong> – Contains basic informations of the ECMWF grib files, e.g. |
---|
| 3003 | ‘Ni’, ‘Nj’, ‘latitudeOfFirstGridPointInDegrees’, |
---|
| 3004 | ‘longitudeOfFirstGridPointInDegrees’, ‘latitudeOfLastGridPointInDegrees’, |
---|
| 3005 | ‘longitudeOfLastGridPointInDegrees’, ‘jDirectionIncrementInDegrees’, |
---|
| 3006 | ‘iDirectionIncrementInDegrees’, ‘missingValue’</td> |
---|
| 3007 | </tr> |
---|
| 3008 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td> |
---|
[274f9ef] | 3009 | </tr> |
---|
| 3010 | </tbody> |
---|
| 3011 | </table> |
---|
| 3012 | </dd></dl> |
---|
[708c667] | 3013 | |
---|
[274f9ef] | 3014 | <dl class="function"> |
---|
| 3015 | <dt id="tools.get_list_as_string"> |
---|
| 3016 | <code class="descclassname">tools.</code><code class="descname">get_list_as_string</code><span class="sig-paren">(</span><em>list_obj</em>, <em>concatenate_sign='</em>, <em>'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#get_list_as_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_list_as_string" title="Permalink to this definition">¶</a></dt> |
---|
| 3017 | <dd><p>Converts a list of arbitrary content into a single string.</p> |
---|
| 3018 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3019 | <col class="field-name" /> |
---|
| 3020 | <col class="field-body" /> |
---|
| 3021 | <tbody valign="top"> |
---|
| 3022 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
[2625ca8] | 3023 | <li><strong>list_obj</strong> (<em>list of *</em>) – A list with arbitrary content.</li> |
---|
| 3024 | <li><strong>concatenate_sign</strong> (<em>str</em><em>, </em><em>optional</em>) – A string which is used to concatenate the single |
---|
[274f9ef] | 3025 | list elements. Default value is “, “.</li> |
---|
| 3026 | </ul> |
---|
| 3027 | </td> |
---|
| 3028 | </tr> |
---|
| 3029 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>str_of_list</strong> – The content of the list as a single string.</p> |
---|
| 3030 | </td> |
---|
| 3031 | </tr> |
---|
[2625ca8] | 3032 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p> |
---|
[274f9ef] | 3033 | </td> |
---|
| 3034 | </tr> |
---|
| 3035 | </tbody> |
---|
| 3036 | </table> |
---|
| 3037 | </dd></dl> |
---|
[708c667] | 3038 | |
---|
[274f9ef] | 3039 | <dl class="function"> |
---|
| 3040 | <dt id="tools.init128"> |
---|
| 3041 | <code class="descclassname">tools.</code><code class="descname">init128</code><span class="sig-paren">(</span><em>filepath</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#init128"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.init128" title="Permalink to this definition">¶</a></dt> |
---|
| 3042 | <dd><p>Opens and reads the grib file with table 128 information.</p> |
---|
| 3043 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3044 | <col class="field-name" /> |
---|
| 3045 | <col class="field-body" /> |
---|
| 3046 | <tbody valign="top"> |
---|
[2625ca8] | 3047 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filepath</strong> (<em>str</em>) – Path to file of ECMWF grib table number 128.</td> |
---|
[274f9ef] | 3048 | </tr> |
---|
| 3049 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>table128</strong> – Contains the ECMWF grib table 128 information. |
---|
| 3050 | The key is the parameter number and the value is the |
---|
| 3051 | short name of the parameter.</td> |
---|
| 3052 | </tr> |
---|
[2625ca8] | 3053 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td> |
---|
[274f9ef] | 3054 | </tr> |
---|
| 3055 | </tbody> |
---|
| 3056 | </table> |
---|
| 3057 | </dd></dl> |
---|
[708c667] | 3058 | |
---|
[274f9ef] | 3059 | <dl class="function"> |
---|
| 3060 | <dt id="tools.make_dir"> |
---|
| 3061 | <code class="descclassname">tools.</code><code class="descname">make_dir</code><span class="sig-paren">(</span><em>directory</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#make_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.make_dir" title="Permalink to this definition">¶</a></dt> |
---|
[2625ca8] | 3062 | <dd><p>Creates a directory.</p> |
---|
| 3063 | <p>It gives a warning if the directory already exists and skips process. |
---|
| 3064 | The program stops only if there is another problem.</p> |
---|
[274f9ef] | 3065 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3066 | <col class="field-name" /> |
---|
| 3067 | <col class="field-body" /> |
---|
| 3068 | <tbody valign="top"> |
---|
[2625ca8] | 3069 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>directory</strong> (<em>str</em>) – The path to directory which should be created.</td> |
---|
[274f9ef] | 3070 | </tr> |
---|
| 3071 | </tbody> |
---|
| 3072 | </table> |
---|
| 3073 | </dd></dl> |
---|
[708c667] | 3074 | |
---|
[274f9ef] | 3075 | <dl class="function"> |
---|
| 3076 | <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> |
---|
| 3078 | <dd><p>Prints a specified error message which can be passed to the function |
---|
| 3079 | before exiting the program.</p> |
---|
| 3080 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3081 | <col class="field-name" /> |
---|
| 3082 | <col class="field-body" /> |
---|
| 3083 | <tbody valign="top"> |
---|
| 3084 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
[2625ca8] | 3085 | <li><strong>user</strong> (<em>list of str</em>) – Contains all email addresses which should be notified. |
---|
[274f9ef] | 3086 | It might also contain just the ecmwf user name which wil trigger |
---|
| 3087 | mailing to the associated email address for this user.</li> |
---|
[2625ca8] | 3088 | <li><strong>message</strong> (<em>str</em><em>, </em><em>optional</em>) – Error message. Default value is “ERROR”.</li> |
---|
[274f9ef] | 3089 | </ul> |
---|
| 3090 | </td> |
---|
| 3091 | </tr> |
---|
| 3092 | </tbody> |
---|
| 3093 | </table> |
---|
| 3094 | </dd></dl> |
---|
[708c667] | 3095 | |
---|
[274f9ef] | 3096 | <dl class="function"> |
---|
| 3097 | <dt id="tools.none_or_int"> |
---|
| 3098 | <code class="descclassname">tools.</code><code class="descname">none_or_int</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#none_or_int"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.none_or_int" title="Permalink to this definition">¶</a></dt> |
---|
| 3099 | <dd><p>Converts the input string into pythons None-type if the string |
---|
| 3100 | contains string “None”. Otherwise it is converted to an integer value.</p> |
---|
| 3101 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3102 | <col class="field-name" /> |
---|
| 3103 | <col class="field-body" /> |
---|
| 3104 | <tbody valign="top"> |
---|
[2625ca8] | 3105 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> (<em>str</em>) – String to be checked for the “None” word.</td> |
---|
[274f9ef] | 3106 | </tr> |
---|
| 3107 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Return depends on the content of the input value. If it was “None”, |
---|
| 3108 | then the python type None is returned. Otherwise the string is |
---|
| 3109 | converted into an integer value.</td> |
---|
| 3110 | </tr> |
---|
| 3111 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None or int(value)</td> |
---|
| 3112 | </tr> |
---|
| 3113 | </tbody> |
---|
| 3114 | </table> |
---|
| 3115 | </dd></dl> |
---|
[708c667] | 3116 | |
---|
[274f9ef] | 3117 | <dl class="function"> |
---|
| 3118 | <dt id="tools.none_or_str"> |
---|
| 3119 | <code class="descclassname">tools.</code><code class="descname">none_or_str</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#none_or_str"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.none_or_str" title="Permalink to this definition">¶</a></dt> |
---|
| 3120 | <dd><p>Converts the input string into pythons None-type if the string |
---|
| 3121 | contains string “None”.</p> |
---|
| 3122 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3123 | <col class="field-name" /> |
---|
| 3124 | <col class="field-body" /> |
---|
| 3125 | <tbody valign="top"> |
---|
[2625ca8] | 3126 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> (<em>str</em>) – String to be checked for the “None” word.</td> |
---|
[274f9ef] | 3127 | </tr> |
---|
| 3128 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Return depends on the content of the input value. If it was “None”, |
---|
| 3129 | then the python type None is returned. Otherwise the string itself.</td> |
---|
| 3130 | </tr> |
---|
| 3131 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None or value</td> |
---|
| 3132 | </tr> |
---|
| 3133 | </tbody> |
---|
| 3134 | </table> |
---|
| 3135 | </dd></dl> |
---|
[708c667] | 3136 | |
---|
[274f9ef] | 3137 | <dl class="function"> |
---|
| 3138 | <dt id="tools.normal_exit"> |
---|
[2625ca8] | 3139 | <code class="descclassname">tools.</code><code class="descname">normal_exit</code><span class="sig-paren">(</span><em>message='Done!'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#normal_exit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.normal_exit" title="Permalink to this definition">¶</a></dt> |
---|
[274f9ef] | 3140 | <dd><p>Prints a specific exit message which can be passed to the function.</p> |
---|
| 3141 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3142 | <col class="field-name" /> |
---|
| 3143 | <col class="field-body" /> |
---|
| 3144 | <tbody valign="top"> |
---|
[2625ca8] | 3145 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> (<em>str</em><em>, </em><em>optional</em>) – Message for exiting program. Default value is “Done!”.</td> |
---|
[274f9ef] | 3146 | </tr> |
---|
| 3147 | </tbody> |
---|
| 3148 | </table> |
---|
| 3149 | </dd></dl> |
---|
[708c667] | 3150 | |
---|
[274f9ef] | 3151 | <dl class="function"> |
---|
| 3152 | <dt id="tools.product"> |
---|
| 3153 | <code class="descclassname">tools.</code><code class="descname">product</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwds</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#product"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.product" title="Permalink to this definition">¶</a></dt> |
---|
[2625ca8] | 3154 | <dd><p>Creates combinations of all passed arguments.</p> |
---|
| 3155 | <p>This method combines the single characters of the passed arguments |
---|
[274f9ef] | 3156 | with each other. So that each character of each argument value |
---|
| 3157 | will be combined with each character of the other arguments as a tuple.</p> |
---|
| 3158 | <div class="admonition note"> |
---|
| 3159 | <p class="first admonition-title">Note</p> |
---|
| 3160 | <p class="last">This method is taken from an example at the ECMWF wiki website. |
---|
| 3161 | <a class="reference external" href="https://software.ecmwf.int/wiki/display/GRIB/index.py">https://software.ecmwf.int/wiki/display/GRIB/index.py</a>; 2018-03-16</p> |
---|
| 3162 | </div> |
---|
| 3163 | <p class="rubric">Example</p> |
---|
| 3164 | <p>product(‘ABCD’, ‘xy’) –> Ax Ay Bx By Cx Cy Dx Dy</p> |
---|
| 3165 | <p>product(range(2), repeat = 3) –> 000 001 010 011 100 101 110 111</p> |
---|
| 3166 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3167 | <col class="field-name" /> |
---|
| 3168 | <col class="field-body" /> |
---|
| 3169 | <tbody valign="top"> |
---|
| 3170 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
[2625ca8] | 3171 | <li><strong>*args</strong> (<em>list</em><em> or </em><em>str</em>) – Positional arguments (arbitrary number).</li> |
---|
| 3172 | <li><strong>**kwds</strong> (<em>dict</em>) – Contains all the keyword arguments from *args.</li> |
---|
[274f9ef] | 3173 | </ul> |
---|
| 3174 | </td> |
---|
| 3175 | </tr> |
---|
| 3176 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>prod</strong> – Return will be done with “yield”. A tuple of combined arguments. |
---|
| 3177 | See example in description above.</p> |
---|
| 3178 | </td> |
---|
| 3179 | </tr> |
---|
| 3180 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tuple</span></code></p> |
---|
| 3181 | </td> |
---|
| 3182 | </tr> |
---|
| 3183 | </tbody> |
---|
| 3184 | </table> |
---|
| 3185 | </dd></dl> |
---|
[708c667] | 3186 | |
---|
[274f9ef] | 3187 | <dl class="function"> |
---|
| 3188 | <dt id="tools.put_file_to_ecserver"> |
---|
| 3189 | <code class="descclassname">tools.</code><code class="descname">put_file_to_ecserver</code><span class="sig-paren">(</span><em>ecd</em>, <em>filename</em>, <em>target</em>, <em>ecuid</em>, <em>ecgid</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#put_file_to_ecserver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.put_file_to_ecserver" title="Permalink to this definition">¶</a></dt> |
---|
| 3190 | <dd><p>Uses the ecaccess-file-put command to send a file to the ECMWF servers.</p> |
---|
| 3191 | <div class="admonition note"> |
---|
| 3192 | <p class="first admonition-title">Note</p> |
---|
| 3193 | <p class="last">The return value is just for testing reasons. It does not have |
---|
| 3194 | to be used from the calling function since the whole error handling |
---|
| 3195 | is done in here.</p> |
---|
| 3196 | </div> |
---|
| 3197 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3198 | <col class="field-name" /> |
---|
| 3199 | <col class="field-body" /> |
---|
| 3200 | <tbody valign="top"> |
---|
[2625ca8] | 3201 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 3202 | <li><strong>ecd</strong> (<em>str</em>) – The path were the file is stored.</li> |
---|
| 3203 | <li><strong>filename</strong> (<em>str</em>) – The name of the file to send to the ECMWF server.</li> |
---|
| 3204 | <li><strong>target</strong> (<em>str</em>) – The target queue where the file should be sent to.</li> |
---|
| 3205 | <li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li> |
---|
| 3206 | <li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li> |
---|
[274f9ef] | 3207 | </ul> |
---|
| 3208 | </td> |
---|
| 3209 | </tr> |
---|
| 3210 | </tbody> |
---|
| 3211 | </table> |
---|
| 3212 | </dd></dl> |
---|
[708c667] | 3213 | |
---|
[274f9ef] | 3214 | <dl class="function"> |
---|
| 3215 | <dt id="tools.read_ecenv"> |
---|
[2625ca8] | 3216 | <code class="descclassname">tools.</code><code class="descname">read_ecenv</code><span class="sig-paren">(</span><em>filepath</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#read_ecenv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.read_ecenv" title="Permalink to this definition">¶</a></dt> |
---|
[274f9ef] | 3217 | <dd><p>Reads the file into a dictionary where the key values are the parameter |
---|
| 3218 | names.</p> |
---|
| 3219 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3220 | <col class="field-name" /> |
---|
| 3221 | <col class="field-body" /> |
---|
| 3222 | <tbody valign="top"> |
---|
[2625ca8] | 3223 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filepath</strong> (<em>str</em>) – Path to file where the ECMWF environment parameters are stored.</td> |
---|
[274f9ef] | 3224 | </tr> |
---|
| 3225 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>envs</strong> – Contains the environment parameter ecuid, ecgid, gateway |
---|
| 3226 | and destination for ECMWF server environments.</td> |
---|
| 3227 | </tr> |
---|
[2625ca8] | 3228 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td> |
---|
| 3229 | </tr> |
---|
| 3230 | </tbody> |
---|
| 3231 | </table> |
---|
| 3232 | </dd></dl> |
---|
| 3233 | |
---|
| 3234 | <dl class="function"> |
---|
| 3235 | <dt id="tools.send_mail"> |
---|
| 3236 | <code class="descclassname">tools.</code><code class="descname">send_mail</code><span class="sig-paren">(</span><em>users</em>, <em>success_mode</em>, <em>message</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#send_mail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.send_mail" title="Permalink to this definition">¶</a></dt> |
---|
| 3237 | <dd><p>Prints a specific exit message which can be passed to the function.</p> |
---|
| 3238 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3239 | <col class="field-name" /> |
---|
| 3240 | <col class="field-body" /> |
---|
| 3241 | <tbody valign="top"> |
---|
| 3242 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
| 3243 | <li><strong>users</strong> (<em>list of str</em>) – Contains all email addresses which should be notified. |
---|
| 3244 | It might also contain just the ecmwf user name which wil trigger |
---|
| 3245 | mailing to the associated email address for this user.</li> |
---|
| 3246 | <li><strong>success_mode</strong> (<em>str</em>) – States the exit mode of the program to put into |
---|
| 3247 | the mail subject line.</li> |
---|
| 3248 | <li><strong>message</strong> (<em>str</em><em>, </em><em>optional</em>) – Message for exiting program. Default value is “Done!”.</li> |
---|
| 3249 | </ul> |
---|
| 3250 | </td> |
---|
[274f9ef] | 3251 | </tr> |
---|
| 3252 | </tbody> |
---|
| 3253 | </table> |
---|
| 3254 | </dd></dl> |
---|
[708c667] | 3255 | |
---|
[274f9ef] | 3256 | <dl class="function"> |
---|
| 3257 | <dt id="tools.silent_remove"> |
---|
| 3258 | <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> |
---|
| 3259 | <dd><p>Remove file if it exists. |
---|
| 3260 | The function does not fail if the file does not exist.</p> |
---|
| 3261 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3262 | <col class="field-name" /> |
---|
| 3263 | <col class="field-body" /> |
---|
| 3264 | <tbody valign="top"> |
---|
[2625ca8] | 3265 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>str</em>) – The name of the file to be removed without notification.</td> |
---|
[274f9ef] | 3266 | </tr> |
---|
| 3267 | </tbody> |
---|
| 3268 | </table> |
---|
| 3269 | </dd></dl> |
---|
[708c667] | 3270 | |
---|
[274f9ef] | 3271 | <dl class="function"> |
---|
| 3272 | <dt id="tools.submit_job_to_ecserver"> |
---|
| 3273 | <code class="descclassname">tools.</code><code class="descname">submit_job_to_ecserver</code><span class="sig-paren">(</span><em>target</em>, <em>jobname</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/tools.html#submit_job_to_ecserver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.submit_job_to_ecserver" title="Permalink to this definition">¶</a></dt> |
---|
| 3274 | <dd><p>Uses ecaccess-job-submit command to submit a job to the ECMWF server.</p> |
---|
| 3275 | <div class="admonition note"> |
---|
| 3276 | <p class="first admonition-title">Note</p> |
---|
| 3277 | <p class="last">The return value is just for testing reasons. It does not have |
---|
| 3278 | to be used from the calling function since the whole error handling |
---|
| 3279 | is done in here.</p> |
---|
| 3280 | </div> |
---|
| 3281 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3282 | <col class="field-name" /> |
---|
| 3283 | <col class="field-body" /> |
---|
| 3284 | <tbody valign="top"> |
---|
| 3285 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
[2625ca8] | 3286 | <li><strong>target</strong> (<em>str</em>) – The target where the file should be sent to, e.g. the queue.</li> |
---|
| 3287 | <li><strong>jobname</strong> (<em>str</em>) – The name of the jobfile to be submitted to the ECMWF server.</li> |
---|
[274f9ef] | 3288 | </ul> |
---|
| 3289 | </td> |
---|
| 3290 | </tr> |
---|
[2625ca8] | 3291 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>job_id</strong> – The id number of the job as a reference at the ecmwf server.</p> |
---|
[274f9ef] | 3292 | </td> |
---|
| 3293 | </tr> |
---|
[2625ca8] | 3294 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">int</p> |
---|
[274f9ef] | 3295 | </td> |
---|
| 3296 | </tr> |
---|
| 3297 | </tbody> |
---|
| 3298 | </table> |
---|
| 3299 | </dd></dl> |
---|
[708c667] | 3300 | |
---|
[274f9ef] | 3301 | <dl class="function"> |
---|
| 3302 | <dt id="tools.to_param_id"> |
---|
| 3303 | <code class="descclassname">tools.</code><code class="descname">to_param_id</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"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.to_param_id" title="Permalink to this definition">¶</a></dt> |
---|
| 3304 | <dd><p>Transform parameter names to parameter ids with ECMWF grib table 128.</p> |
---|
| 3305 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3306 | <col class="field-name" /> |
---|
| 3307 | <col class="field-body" /> |
---|
| 3308 | <tbody valign="top"> |
---|
| 3309 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
[2625ca8] | 3310 | <li><strong>pars</strong> (<em>str</em>) – Addpar argument from CONTROL file in the format of |
---|
[274f9ef] | 3311 | parameter names instead of ids. The parameter short |
---|
| 3312 | names are sepearted with “/” and they are passed as |
---|
| 3313 | one single string.</li> |
---|
[2625ca8] | 3314 | <li><strong>table</strong> (<em>dict</em>) – Contains the ECMWF grib table 128 information. |
---|
[274f9ef] | 3315 | The key is the parameter number and the value is the |
---|
| 3316 | short name of the parameter.</li> |
---|
| 3317 | </ul> |
---|
| 3318 | </td> |
---|
| 3319 | </tr> |
---|
| 3320 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ipar</strong> – List of addpar parameters from CONTROL file transformed to |
---|
| 3321 | parameter ids in the format of integer.</p> |
---|
| 3322 | </td> |
---|
| 3323 | </tr> |
---|
[2625ca8] | 3324 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of int</p> |
---|
[274f9ef] | 3325 | </td> |
---|
| 3326 | </tr> |
---|
| 3327 | </tbody> |
---|
| 3328 | </table> |
---|
| 3329 | </dd></dl> |
---|
[708c667] | 3330 | |
---|
| 3331 | </div> |
---|
[274f9ef] | 3332 | <div class="section" id="module-disaggregation"> |
---|
| 3333 | <span id="disaggregation"></span><h3><a class="toc-backref" href="#id14">disaggregation</a><a class="headerlink" href="#module-disaggregation" title="Permalink to this headline">¶</a></h3> |
---|
[2625ca8] | 3334 | <p>Disaggregation of deaccumulated flux data from an ECMWF model FG field.</p> |
---|
| 3335 | <dl class="docutils"> |
---|
| 3336 | <dt>Initially the flux data to be concerned are:</dt> |
---|
| 3337 | <dd><ul class="first last simple"> |
---|
| 3338 | <li>large-scale precipitation</li> |
---|
| 3339 | <li>convective precipitation</li> |
---|
| 3340 | <li>surface sensible heat flux</li> |
---|
| 3341 | <li>surface solar radiation</li> |
---|
| 3342 | <li>u stress</li> |
---|
| 3343 | <li>v stress</li> |
---|
| 3344 | </ul> |
---|
| 3345 | </dd> |
---|
| 3346 | </dl> |
---|
| 3347 | <p>Different versions of disaggregation is provided for rainfall |
---|
| 3348 | data (darain, modified linear) and the surface fluxes and |
---|
| 3349 | stress data (dapoly, cubic polynomial).</p> |
---|
[708c667] | 3350 | <dl class="function"> |
---|
| 3351 | <dt id="disaggregation.IA3"> |
---|
| 3352 | <code class="descclassname">disaggregation.</code><code class="descname">IA3</code><span class="sig-paren">(</span><em>g</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/disaggregation.html#IA3"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#disaggregation.IA3" title="Permalink to this definition">¶</a></dt> |
---|
| 3353 | <dd><p>Interpolation with a non-negative geometric mean based algorithm.</p> |
---|
| 3354 | <p>The original grid is reconstructed by adding two sampling points in each |
---|
| 3355 | data series interval. This subgrid is used to keep all information during |
---|
| 3356 | the interpolation within the associated interval. Additionally, an advanced |
---|
| 3357 | monotonicity filter is applied to improve the monotonicity properties of |
---|
| 3358 | the series.</p> |
---|
| 3359 | <div class="admonition note"> |
---|
| 3360 | <p class="first admonition-title">Note</p> |
---|
[2625ca8] | 3361 | <p>(C) Copyright 2017-2019 |
---|
[708c667] | 3362 | Sabine Hittmeir, Anne Philipp, Petra Seibert</p> |
---|
| 3363 | <p class="last">This work is licensed under the Creative Commons Attribution 4.0 |
---|
| 3364 | International License. To view a copy of this license, visit |
---|
| 3365 | <a class="reference external" href="http://creativecommons.org/licenses/by/4.0/">http://creativecommons.org/licenses/by/4.0/</a> or send a letter to |
---|
| 3366 | Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</p> |
---|
| 3367 | </div> |
---|
| 3368 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3369 | <col class="field-name" /> |
---|
| 3370 | <col class="field-body" /> |
---|
| 3371 | <tbody valign="top"> |
---|
[2625ca8] | 3372 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>g</strong> (<em>list of float</em>) – Complete data series that will be interpolated having |
---|
[708c667] | 3373 | the dimension of the original raw series.</td> |
---|
| 3374 | </tr> |
---|
| 3375 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>f</strong> – The interpolated data series with additional subgrid points. |
---|
| 3376 | Its dimension is equal to the length of the input data series |
---|
| 3377 | times three.</td> |
---|
| 3378 | </tr> |
---|
[2625ca8] | 3379 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list of float</td> |
---|
[708c667] | 3380 | </tr> |
---|
| 3381 | </tbody> |
---|
| 3382 | </table> |
---|
| 3383 | <p class="rubric">References</p> |
---|
| 3384 | <p>For more information see article: |
---|
| 3385 | Hittmeir, S.; Philipp, A.; Seibert, P. (2017): A conservative |
---|
| 3386 | interpolation scheme for extensive quantities with application to the |
---|
| 3387 | Lagrangian particle dispersion model FLEXPART., |
---|
| 3388 | Geoscientific Model Development</p> |
---|
| 3389 | </dd></dl> |
---|
| 3390 | |
---|
| 3391 | <dl class="function"> |
---|
| 3392 | <dt id="disaggregation.dapoly"> |
---|
| 3393 | <code class="descclassname">disaggregation.</code><code class="descname">dapoly</code><span class="sig-paren">(</span><em>alist</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/disaggregation.html#dapoly"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#disaggregation.dapoly" title="Permalink to this definition">¶</a></dt> |
---|
| 3394 | <dd><p>Cubic polynomial interpolation of deaccumulated fluxes.</p> |
---|
| 3395 | <p>Interpolation of deaccumulated fluxes of an ECMWF model FG field |
---|
| 3396 | using a cubic polynomial solution which conserves the integrals |
---|
| 3397 | of the fluxes within each timespan. |
---|
| 3398 | Disaggregation is done for 4 accumluated timespans which |
---|
| 3399 | generates a new, disaggregated value which is output at the |
---|
| 3400 | central point of the 4 accumulation timespans. |
---|
| 3401 | This new point is used for linear interpolation of the complete |
---|
| 3402 | timeseries afterwards.</p> |
---|
| 3403 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3404 | <col class="field-name" /> |
---|
| 3405 | <col class="field-body" /> |
---|
| 3406 | <tbody valign="top"> |
---|
[2625ca8] | 3407 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>alist</strong> (<em>list of array of float</em>) – List of 4 timespans as 2-dimensional, horizontal fields. |
---|
[708c667] | 3408 | E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</td> |
---|
| 3409 | </tr> |
---|
| 3410 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>nfield</strong> – Interpolated flux at central point of accumulation timespan.</td> |
---|
| 3411 | </tr> |
---|
[2625ca8] | 3412 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">array of float</td> |
---|
[708c667] | 3413 | </tr> |
---|
| 3414 | </tbody> |
---|
| 3415 | </table> |
---|
| 3416 | <div class="admonition note"> |
---|
| 3417 | <p class="first admonition-title">Note</p> |
---|
| 3418 | <dl class="last docutils"> |
---|
| 3419 | <dt>March 2000 <span class="classifier-delimiter">:</span> <span class="classifier">P. JAMES</span></dt> |
---|
| 3420 | <dd>Original author</dd> |
---|
| 3421 | <dt>June 2003 <span class="classifier-delimiter">:</span> <span class="classifier">A. BECK</span></dt> |
---|
| 3422 | <dd>Adaptations</dd> |
---|
| 3423 | <dt>November 2015 <span class="classifier-delimiter">:</span> <span class="classifier">Leopold Haimberger (University of Vienna)</span></dt> |
---|
| 3424 | <dd>Migration from Fortran to Python</dd> |
---|
| 3425 | </dl> |
---|
| 3426 | </div> |
---|
| 3427 | </dd></dl> |
---|
| 3428 | |
---|
| 3429 | <dl class="function"> |
---|
| 3430 | <dt id="disaggregation.darain"> |
---|
| 3431 | <code class="descclassname">disaggregation.</code><code class="descname">darain</code><span class="sig-paren">(</span><em>alist</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/disaggregation.html#darain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#disaggregation.darain" title="Permalink to this definition">¶</a></dt> |
---|
| 3432 | <dd><p>Linear interpolation of deaccumulated fluxes.</p> |
---|
| 3433 | <p>Interpolation of deaccumulated fluxes of an ECMWF model FG rainfall |
---|
| 3434 | field using a modified linear solution which conserves the integrals |
---|
| 3435 | of the fluxes within each timespan. |
---|
| 3436 | Disaggregation is done for 4 accumluated timespans which generates |
---|
| 3437 | a new, disaggregated value which is output at the central point |
---|
| 3438 | of the 4 accumulation timespans. This new point is used for linear |
---|
| 3439 | interpolation of the complete timeseries afterwards.</p> |
---|
| 3440 | <table class="docutils field-list" frame="void" rules="none"> |
---|
| 3441 | <col class="field-name" /> |
---|
| 3442 | <col class="field-body" /> |
---|
| 3443 | <tbody valign="top"> |
---|
[2625ca8] | 3444 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>alist</strong> (<em>list of array of float</em>) – List of 4 timespans as 2-dimensional, horizontal fields. |
---|
[708c667] | 3445 | E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</td> |
---|
| 3446 | </tr> |
---|
| 3447 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>nfield</strong> – Interpolated flux at central point of accumulation timespan.</td> |
---|
| 3448 | </tr> |
---|
[2625ca8] | 3449 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">array of float</td> |
---|
[708c667] | 3450 | </tr> |
---|
| 3451 | </tbody> |
---|
| 3452 | </table> |
---|
| 3453 | <div class="admonition note"> |
---|
| 3454 | <p class="first admonition-title">Note</p> |
---|
| 3455 | <dl class="last docutils"> |
---|
| 3456 | <dt>March 2000 <span class="classifier-delimiter">:</span> <span class="classifier">P. JAMES</span></dt> |
---|
| 3457 | <dd>Original author</dd> |
---|
| 3458 | <dt>June 2003 <span class="classifier-delimiter">:</span> <span class="classifier">A. BECK</span></dt> |
---|
| 3459 | <dd>Adaptations</dd> |
---|
| 3460 | <dt>November 2015 <span class="classifier-delimiter">:</span> <span class="classifier">Leopold Haimberger (University of Vienna)</span></dt> |
---|
| 3461 | <dd>Migration from Fortran to Python</dd> |
---|
| 3462 | </dl> |
---|
| 3463 | </div> |
---|
| 3464 | </dd></dl> |
---|
| 3465 | |
---|
| 3466 | </div> |
---|
[274f9ef] | 3467 | </div> |
---|
| 3468 | </div> |
---|
[708c667] | 3469 | |
---|
| 3470 | |
---|
| 3471 | </div> |
---|
| 3472 | |
---|
| 3473 | </div> |
---|
| 3474 | <footer> |
---|
| 3475 | |
---|
| 3476 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
---|
| 3477 | |
---|
| 3478 | <a href="support.html" class="btn btn-neutral float-right" title="Support" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
---|
| 3479 | |
---|
| 3480 | |
---|
[274f9ef] | 3481 | <a href="user_guide/control_templates.html" class="btn btn-neutral" title="CONTROL-file templates" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
---|
[708c667] | 3482 | |
---|
| 3483 | </div> |
---|
| 3484 | |
---|
| 3485 | |
---|
| 3486 | <hr/> |
---|
| 3487 | |
---|
| 3488 | <div role="contentinfo"> |
---|
| 3489 | <p> |
---|
[2625ca8] | 3490 | © Copyright 2018, Anne Philipp and Leopold Haimberger |
---|
[708c667] | 3491 | |
---|
| 3492 | </p> |
---|
| 3493 | </div> |
---|
| 3494 | 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>. |
---|
| 3495 | |
---|
| 3496 | </footer> |
---|
| 3497 | |
---|
| 3498 | </div> |
---|
| 3499 | </div> |
---|
| 3500 | |
---|
| 3501 | </section> |
---|
| 3502 | |
---|
| 3503 | </div> |
---|
| 3504 | |
---|
| 3505 | |
---|
| 3506 | |
---|
| 3507 | |
---|
| 3508 | |
---|
[2625ca8] | 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 | |
---|
[708c667] | 3516 | |
---|
| 3517 | |
---|
| 3518 | |
---|
| 3519 | <script type="text/javascript" src="_static/js/theme.js"></script> |
---|
| 3520 | |
---|
| 3521 | <script type="text/javascript"> |
---|
| 3522 | jQuery(function () { |
---|
| 3523 | SphinxRtdTheme.Navigation.enable(true); |
---|
| 3524 | }); |
---|
| 3525 | </script> |
---|
| 3526 | |
---|
| 3527 | </body> |
---|
| 3528 | </html> |
---|