[0b00607] | 1 | |
---|
| 2 | |
---|
| 3 | <!DOCTYPE html> |
---|
| 4 | <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
---|
| 5 | <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
---|
| 6 | <head> |
---|
| 7 | <meta charset="utf-8"> |
---|
| 8 | |
---|
| 9 | <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
---|
| 10 | |
---|
[6931f61] | 11 | <title>GribUtil — flex_extract 7.1.2 documentation</title> |
---|
[0b00607] | 12 | |
---|
| 13 | |
---|
| 14 | |
---|
| 15 | |
---|
| 16 | |
---|
| 17 | |
---|
| 18 | |
---|
| 19 | |
---|
| 20 | <script type="text/javascript" src="../_static/js/modernizr.min.js"></script> |
---|
| 21 | |
---|
| 22 | |
---|
| 23 | <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> |
---|
[b1674ed] | 24 | <script src="../_static/jquery.js"></script> |
---|
| 25 | <script src="../_static/underscore.js"></script> |
---|
| 26 | <script src="../_static/doctools.js"></script> |
---|
| 27 | <script src="../_static/language_data.js"></script> |
---|
| 28 | <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
---|
[0b00607] | 29 | |
---|
| 30 | <script type="text/javascript" src="../_static/js/theme.js"></script> |
---|
| 31 | |
---|
| 32 | |
---|
| 33 | |
---|
| 34 | |
---|
| 35 | <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> |
---|
| 36 | <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> |
---|
| 37 | <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" /> |
---|
| 38 | <link rel="stylesheet" href="../_static/css/theme_overrides.css" type="text/css" /> |
---|
| 39 | <link rel="index" title="Index" href="../genindex.html" /> |
---|
| 40 | <link rel="search" title="Search" href="../search.html" /> |
---|
| 41 | </head> |
---|
| 42 | |
---|
| 43 | <body class="wy-body-for-nav"> |
---|
| 44 | |
---|
| 45 | |
---|
| 46 | <div class="wy-grid-for-nav"> |
---|
| 47 | |
---|
| 48 | <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
---|
| 49 | <div class="wy-side-scroll"> |
---|
| 50 | <div class="wy-side-nav-search" > |
---|
| 51 | |
---|
| 52 | |
---|
| 53 | |
---|
| 54 | <a href="../index.html" class="icon icon-home"> flex_extract |
---|
| 55 | |
---|
| 56 | |
---|
| 57 | |
---|
| 58 | </a> |
---|
| 59 | |
---|
| 60 | |
---|
| 61 | |
---|
| 62 | |
---|
| 63 | <div class="version"> |
---|
[6931f61] | 64 | 7.1.2 |
---|
[0b00607] | 65 | </div> |
---|
| 66 | |
---|
| 67 | |
---|
| 68 | |
---|
| 69 | |
---|
| 70 | <div role="search"> |
---|
| 71 | <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
---|
| 72 | <input type="text" name="q" placeholder="Search docs" /> |
---|
| 73 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 74 | <input type="hidden" name="area" value="default" /> |
---|
| 75 | </form> |
---|
| 76 | </div> |
---|
| 77 | |
---|
| 78 | |
---|
| 79 | </div> |
---|
| 80 | |
---|
| 81 | <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
---|
| 82 | |
---|
| 83 | |
---|
| 84 | |
---|
| 85 | |
---|
| 86 | |
---|
| 87 | |
---|
| 88 | <p class="caption"><span class="caption-text">Table of Contents:</span></p> |
---|
| 89 | <ul> |
---|
| 90 | <li class="toctree-l1"><a class="reference internal" href="../ecmwf_data.html">ECMWF Data</a></li> |
---|
[5bee29a] | 91 | <li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li> |
---|
| 92 | <li class="toctree-l1"><a class="reference internal" href="../quick_start.html">Usage</a></li> |
---|
| 93 | <li class="toctree-l1"><a class="reference internal" href="../documentation.html">Code-Level Documentation</a></li> |
---|
[0b00607] | 94 | <li class="toctree-l1"><a class="reference internal" href="../evaluation.html">Evaluation</a></li> |
---|
| 95 | <li class="toctree-l1"><a class="reference internal" href="../dev_guide.html">Developer Guide</a></li> |
---|
| 96 | <li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li> |
---|
| 97 | <li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li> |
---|
| 98 | <li class="toctree-l1"><a class="reference internal" href="../Support/faq.html">FAQ - Frequently asked questions</a></li> |
---|
| 99 | <li class="toctree-l1"><a class="reference internal" href="../authors.html">Developer Team</a></li> |
---|
| 100 | </ul> |
---|
| 101 | |
---|
| 102 | |
---|
| 103 | |
---|
| 104 | </div> |
---|
| 105 | </div> |
---|
| 106 | </nav> |
---|
| 107 | |
---|
| 108 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
---|
| 109 | |
---|
| 110 | |
---|
| 111 | <nav class="wy-nav-top" aria-label="top navigation"> |
---|
| 112 | |
---|
| 113 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
---|
| 114 | <a href="../index.html">flex_extract</a> |
---|
| 115 | |
---|
| 116 | </nav> |
---|
| 117 | |
---|
| 118 | |
---|
| 119 | <div class="wy-nav-content"> |
---|
| 120 | |
---|
| 121 | <div class="rst-content"> |
---|
| 122 | |
---|
| 123 | |
---|
| 124 | |
---|
| 125 | |
---|
| 126 | |
---|
| 127 | |
---|
| 128 | |
---|
| 129 | |
---|
| 130 | |
---|
| 131 | |
---|
| 132 | |
---|
| 133 | |
---|
| 134 | |
---|
| 135 | |
---|
| 136 | |
---|
| 137 | |
---|
| 138 | |
---|
| 139 | <div role="navigation" aria-label="breadcrumbs navigation"> |
---|
| 140 | |
---|
| 141 | <ul class="wy-breadcrumbs"> |
---|
| 142 | |
---|
| 143 | <li><a href="../index.html">Docs</a> »</li> |
---|
| 144 | |
---|
| 145 | <li><a href="index.html">Module code</a> »</li> |
---|
| 146 | |
---|
| 147 | <li>GribUtil</li> |
---|
| 148 | |
---|
| 149 | |
---|
| 150 | <li class="wy-breadcrumbs-aside"> |
---|
| 151 | |
---|
| 152 | </li> |
---|
| 153 | |
---|
| 154 | </ul> |
---|
| 155 | |
---|
| 156 | |
---|
| 157 | <hr/> |
---|
| 158 | </div> |
---|
| 159 | <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
---|
| 160 | <div itemprop="articleBody"> |
---|
| 161 | |
---|
| 162 | <h1>Source code for GribUtil</h1><div class="highlight"><pre> |
---|
[30f7911] | 163 | <span></span><span class="ch">#!/usr/bin/env python3</span> |
---|
[0b00607] | 164 | <span class="c1"># -*- coding: utf-8 -*-</span> |
---|
| 165 | <span class="c1">#*******************************************************************************</span> |
---|
| 166 | <span class="c1"># @Author: Anne Fouilloux (University of Oslo)</span> |
---|
| 167 | <span class="c1">#</span> |
---|
| 168 | <span class="c1"># @Date: July 2014</span> |
---|
| 169 | <span class="c1">#</span> |
---|
| 170 | <span class="c1"># @Change History:</span> |
---|
| 171 | <span class="c1"># February 2018 - Anne Philipp (University of Vienna):</span> |
---|
| 172 | <span class="c1"># - applied PEP8 style guide</span> |
---|
| 173 | <span class="c1"># - added documentation</span> |
---|
| 174 | <span class="c1"># - changed some naming</span> |
---|
| 175 | <span class="c1">#</span> |
---|
| 176 | <span class="c1"># @License:</span> |
---|
[08c9091] | 177 | <span class="c1"># (C) Copyright 2014-2020.</span> |
---|
[30f7911] | 178 | <span class="c1"># Anne Philipp, Leopold Haimberger</span> |
---|
[0b00607] | 179 | <span class="c1">#</span> |
---|
[30f7911] | 180 | <span class="c1"># SPDX-License-Identifier: CC-BY-4.0</span> |
---|
[0b00607] | 181 | <span class="c1">#</span> |
---|
[30f7911] | 182 | <span class="c1"># This work is licensed under the Creative Commons Attribution 4.0</span> |
---|
| 183 | <span class="c1"># International License. To view a copy of this license, visit</span> |
---|
| 184 | <span class="c1"># http://creativecommons.org/licenses/by/4.0/ or send a letter to</span> |
---|
| 185 | <span class="c1"># Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</span> |
---|
[0b00607] | 186 | <span class="c1">#*******************************************************************************</span> |
---|
| 187 | |
---|
| 188 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
| 189 | <span class="c1"># MODULES</span> |
---|
| 190 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
[b1674ed] | 191 | <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">print_function</span> |
---|
[0b00607] | 192 | |
---|
| 193 | <span class="kn">import</span> <span class="nn">os</span> |
---|
| 194 | |
---|
| 195 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
| 196 | <span class="c1"># CLASS</span> |
---|
| 197 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
| 198 | <div class="viewcode-block" id="GribUtil"><a class="viewcode-back" href="../Documentation/Api/api_python.html#GribUtil.GribUtil">[docs]</a><span class="k">class</span> <span class="nc">GribUtil</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
---|
| 199 | <span class="sd">'''</span> |
---|
| 200 | <span class="sd"> Class for GRIB utilities (new methods) based on GRIB API</span> |
---|
[30f7911] | 201 | |
---|
| 202 | <span class="sd"> The GRIB API provides all necessary tools to work directly with the</span> |
---|
| 203 | <span class="sd"> grib files. Nevertheless, the GRIB API tools are very basic and are in</span> |
---|
| 204 | <span class="sd"> direct connection with the grib files. This class provides some higher</span> |
---|
| 205 | <span class="sd"> functions which apply a set of GRIB API tools together in the respective</span> |
---|
| 206 | <span class="sd"> context. So, the class initially contains a list of grib files (their</span> |
---|
| 207 | <span class="sd"> names) and the using program then applies the methods directly on the</span> |
---|
| 208 | <span class="sd"> class objects without having to think about how the actual GRIB API</span> |
---|
| 209 | <span class="sd"> tools have to be arranged.</span> |
---|
[0b00607] | 210 | <span class="sd"> '''</span> |
---|
| 211 | <span class="c1"># --------------------------------------------------------------------------</span> |
---|
| 212 | <span class="c1"># CLASS FUNCTIONS</span> |
---|
| 213 | <span class="c1"># --------------------------------------------------------------------------</span> |
---|
[b1674ed] | 214 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filenames</span><span class="p">):</span> |
---|
[0b00607] | 215 | <span class="sd">'''Initialise an object of GribUtil and assign a list of filenames.</span> |
---|
| 216 | |
---|
| 217 | <span class="sd"> Parameters</span> |
---|
| 218 | <span class="sd"> ----------</span> |
---|
| 219 | <span class="sd"> filenames : :obj:`list` of :obj:`strings`</span> |
---|
| 220 | <span class="sd"> A list of filenames.</span> |
---|
| 221 | |
---|
| 222 | <span class="sd"> Return</span> |
---|
| 223 | <span class="sd"> ------</span> |
---|
| 224 | |
---|
| 225 | <span class="sd"> '''</span> |
---|
| 226 | |
---|
| 227 | <span class="bp">self</span><span class="o">.</span><span class="n">filenames</span> <span class="o">=</span> <span class="n">filenames</span> |
---|
| 228 | |
---|
| 229 | <span class="k">return</span> |
---|
| 230 | |
---|
| 231 | |
---|
[eca358d] | 232 | <div class="viewcode-block" id="GribUtil.get_keys"><a class="viewcode-back" href="../Documentation/Api/api_python.html#GribUtil.GribUtil.get_keys">[docs]</a> <span class="k">def</span> <span class="nf">get_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">keynames</span><span class="p">,</span> <span class="n">wherekeynames</span><span class="p">,</span> <span class="n">wherekeyvalues</span><span class="p">):</span> |
---|
[0b00607] | 233 | <span class="sd">'''Get keyvalues for a given list of keynames a where statement</span> |
---|
| 234 | <span class="sd"> can be given (list of key and list of values)</span> |
---|
| 235 | |
---|
| 236 | <span class="sd"> Parameters</span> |
---|
| 237 | <span class="sd"> ----------</span> |
---|
| 238 | <span class="sd"> keynames : :obj:`list` of :obj:`string`</span> |
---|
| 239 | <span class="sd"> List of keynames.</span> |
---|
| 240 | |
---|
[eca358d] | 241 | <span class="sd"> wherekeynames : :obj:`list` of :obj:`string`</span> |
---|
| 242 | <span class="sd"> List of key names for indexing grib message parameter.</span> |
---|
[0b00607] | 243 | |
---|
[eca358d] | 244 | <span class="sd"> wherekeyvalues : :obj:`list` of :obj:`string`</span> |
---|
| 245 | <span class="sd"> List of key values corresponding the key names.</span> |
---|
[0b00607] | 246 | |
---|
| 247 | <span class="sd"> Return</span> |
---|
| 248 | <span class="sd"> ------</span> |
---|
| 249 | <span class="sd"> return_list : :obj:`list` of :obj:`string`</span> |
---|
| 250 | <span class="sd"> List of keyvalues for given keynames.</span> |
---|
| 251 | <span class="sd"> '''</span> |
---|
[b1674ed] | 252 | <span class="kn">from</span> <span class="nn">eccodes</span> <span class="kn">import</span> <span class="p">(</span><span class="n">codes_new_from_file</span><span class="p">,</span> <span class="n">codes_is_defined</span><span class="p">,</span> <span class="n">codes_get</span><span class="p">,</span> |
---|
[0b00607] | 253 | <span class="n">codes_release</span><span class="p">)</span> |
---|
| 254 | |
---|
| 255 | <span class="n">return_list</span> <span class="o">=</span> <span class="p">[]</span> |
---|
| 256 | |
---|
[30f7911] | 257 | <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">filenames</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">fileid</span><span class="p">:</span> |
---|
[0b00607] | 258 | |
---|
[30f7911] | 259 | <span class="n">gid</span> <span class="o">=</span> <span class="n">codes_new_from_file</span><span class="p">(</span><span class="n">fileid</span><span class="p">)</span> |
---|
[0b00607] | 260 | |
---|
| 261 | <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">wherekeynames</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">wherekeyvalues</span><span class="p">):</span> |
---|
| 262 | <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"Number of key values and key names must be </span><span class="se">\</span> |
---|
| 263 | <span class="s2"> the same. Give a value for each keyname!"</span><span class="p">)</span> |
---|
| 264 | |
---|
| 265 | <span class="n">select</span> <span class="o">=</span> <span class="kc">True</span> |
---|
| 266 | <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span> |
---|
| 267 | <span class="k">for</span> <span class="n">wherekey</span> <span class="ow">in</span> <span class="n">wherekeynames</span><span class="p">:</span> |
---|
| 268 | <span class="k">if</span> <span class="ow">not</span> <span class="n">codes_is_defined</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">wherekey</span><span class="p">):</span> |
---|
| 269 | <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"where key was not defined"</span><span class="p">)</span> |
---|
| 270 | |
---|
| 271 | <span class="n">select</span> <span class="o">=</span> <span class="p">(</span><span class="n">select</span> <span class="ow">and</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">wherekeyvalues</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> <span class="o">==</span> |
---|
| 272 | <span class="nb">str</span><span class="p">(</span><span class="n">codes_get</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">wherekey</span><span class="p">))))</span> |
---|
| 273 | <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> |
---|
| 274 | |
---|
| 275 | <span class="k">if</span> <span class="n">select</span><span class="p">:</span> |
---|
| 276 | <span class="n">llist</span> <span class="o">=</span> <span class="p">[]</span> |
---|
| 277 | <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keynames</span><span class="p">:</span> |
---|
| 278 | <span class="n">llist</span><span class="o">.</span><span class="n">extend</span><span class="p">([</span><span class="nb">str</span><span class="p">(</span><span class="n">codes_get</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">key</span><span class="p">))])</span> |
---|
| 279 | <span class="n">return_list</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">llist</span><span class="p">)</span> |
---|
| 280 | |
---|
| 281 | <span class="n">codes_release</span><span class="p">(</span><span class="n">gid</span><span class="p">)</span> |
---|
| 282 | |
---|
| 283 | <span class="k">return</span> <span class="n">return_list</span></div> |
---|
| 284 | |
---|
| 285 | |
---|
[08c9091] | 286 | <div class="viewcode-block" id="GribUtil.set_keys"><a class="viewcode-back" href="../Documentation/Api/api_python.html#GribUtil.GribUtil.set_keys">[docs]</a> <span class="k">def</span> <span class="nf">set_keys</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fromfile</span><span class="p">,</span> <span class="n">filemode</span><span class="o">=</span><span class="s1">'wb'</span><span class="p">,</span> <span class="n">keynames</span><span class="o">=</span><span class="p">[],</span> <span class="n">keyvalues</span><span class="o">=</span><span class="p">[],</span> |
---|
| 287 | <span class="n">wherekeynames</span><span class="o">=</span><span class="p">[],</span> <span class="n">wherekeyvalues</span><span class="o">=</span><span class="p">[]):</span> |
---|
[0b00607] | 288 | <span class="sd">'''Opens the file to read the grib messages and then write</span> |
---|
| 289 | <span class="sd"> the selected messages (with wherekeys) to a new output file.</span> |
---|
| 290 | <span class="sd"> Also, the keyvalues of the passed list of keynames are set.</span> |
---|
| 291 | |
---|
| 292 | <span class="sd"> Parameters</span> |
---|
| 293 | <span class="sd"> ----------</span> |
---|
| 294 | <span class="sd"> fromfile : :obj:`string`</span> |
---|
| 295 | <span class="sd"> Filename of the input file to read the grib messages from.</span> |
---|
| 296 | |
---|
| 297 | <span class="sd"> keynames : :obj:`list` of :obj:`string`</span> |
---|
| 298 | <span class="sd"> List of keynames to set in the selected messages.</span> |
---|
| 299 | <span class="sd"> Default is an empty list.</span> |
---|
| 300 | |
---|
| 301 | <span class="sd"> keyvalues : :obj:`list` of :obj:`string`</span> |
---|
| 302 | <span class="sd"> List of keyvalues to set in the selected messages.</span> |
---|
| 303 | <span class="sd"> Default is an empty list.</span> |
---|
| 304 | |
---|
[eca358d] | 305 | <span class="sd"> wherekeynames : :obj:`list` of :obj:`string`</span> |
---|
[0b00607] | 306 | <span class="sd"> List of keynames to select correct message.</span> |
---|
| 307 | |
---|
[eca358d] | 308 | <span class="sd"> wherekeyvalues : :obj:`list` of :obj:`string`</span> |
---|
[0b00607] | 309 | <span class="sd"> List of keyvalues for keynames to select correct message.</span> |
---|
| 310 | |
---|
| 311 | <span class="sd"> filemode : :obj:`string`, optional</span> |
---|
[30f7911] | 312 | <span class="sd"> Sets the mode for the output file. Default is "wb".</span> |
---|
[0b00607] | 313 | |
---|
| 314 | <span class="sd"> Return</span> |
---|
| 315 | <span class="sd"> ------</span> |
---|
| 316 | |
---|
| 317 | <span class="sd"> '''</span> |
---|
[b1674ed] | 318 | <span class="kn">from</span> <span class="nn">eccodes</span> <span class="kn">import</span> <span class="p">(</span><span class="n">codes_grib_new_from_file</span><span class="p">,</span> <span class="n">codes_is_defined</span><span class="p">,</span> |
---|
[0b00607] | 319 | <span class="n">codes_get</span><span class="p">,</span> <span class="n">codes_set</span><span class="p">,</span> <span class="n">codes_write</span><span class="p">,</span> |
---|
| 320 | <span class="n">codes_set_values</span><span class="p">,</span> <span class="n">codes_release</span><span class="p">)</span> |
---|
| 321 | |
---|
| 322 | <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">wherekeynames</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">wherekeyvalues</span><span class="p">):</span> |
---|
| 323 | <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"Give a value for each keyname!"</span><span class="p">)</span> |
---|
| 324 | |
---|
| 325 | <span class="n">fout</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">filenames</span><span class="p">,</span> <span class="n">filemode</span><span class="p">)</span> |
---|
[08c9091] | 326 | <span class="c1"># print(fout)</span> |
---|
| 327 | <span class="n">fin</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">fromfile</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> |
---|
| 328 | <span class="c1"># print(fin)</span> |
---|
| 329 | <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> |
---|
[0b00607] | 330 | <span class="n">gid</span> <span class="o">=</span> <span class="n">codes_grib_new_from_file</span><span class="p">(</span><span class="n">fin</span><span class="p">)</span> |
---|
[08c9091] | 331 | <span class="c1"># print('test')</span> |
---|
| 332 | <span class="k">if</span> <span class="n">gid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
---|
| 333 | <span class="k">break</span> |
---|
| 334 | |
---|
[0b00607] | 335 | <span class="n">select</span> <span class="o">=</span> <span class="kc">True</span> |
---|
[08c9091] | 336 | <span class="c1">#print(str(codes_get(gid,'paramId')))</span> |
---|
| 337 | <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">wherekey</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">wherekeynames</span><span class="p">):</span> |
---|
[0b00607] | 338 | <span class="k">if</span> <span class="ow">not</span> <span class="n">codes_is_defined</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">wherekey</span><span class="p">):</span> |
---|
| 339 | <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"wherekey was not defined"</span><span class="p">)</span> |
---|
| 340 | |
---|
| 341 | <span class="n">select</span> <span class="o">=</span> <span class="p">(</span><span class="n">select</span> <span class="ow">and</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">wherekeyvalues</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> <span class="o">==</span> |
---|
| 342 | <span class="nb">str</span><span class="p">(</span><span class="n">codes_get</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">wherekey</span><span class="p">))))</span> |
---|
| 343 | |
---|
| 344 | <span class="k">if</span> <span class="n">select</span><span class="p">:</span> |
---|
[08c9091] | 345 | <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">key</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">keynames</span><span class="p">):</span> |
---|
[0b00607] | 346 | <span class="k">if</span> <span class="n">key</span> <span class="o">==</span> <span class="s1">'values'</span><span class="p">:</span> |
---|
| 347 | <span class="n">codes_set_values</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">keyvalues</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> |
---|
| 348 | <span class="k">else</span><span class="p">:</span> |
---|
| 349 | <span class="n">codes_set</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">keyvalues</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> |
---|
| 350 | |
---|
| 351 | <span class="n">codes_write</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">fout</span><span class="p">)</span> |
---|
| 352 | |
---|
| 353 | <span class="n">codes_release</span><span class="p">(</span><span class="n">gid</span><span class="p">)</span> |
---|
| 354 | |
---|
| 355 | <span class="n">fout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
---|
[08c9091] | 356 | <span class="n">fin</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
---|
[0b00607] | 357 | |
---|
| 358 | <span class="k">return</span></div> |
---|
| 359 | |
---|
[eca358d] | 360 | <div class="viewcode-block" id="GribUtil.copy_dummy_msg"><a class="viewcode-back" href="../Documentation/Api/api_python.html#GribUtil.GribUtil.copy_dummy_msg">[docs]</a> <span class="k">def</span> <span class="nf">copy_dummy_msg</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename_in</span><span class="p">,</span> <span class="n">keynames</span><span class="p">,</span> <span class="n">keyvalues</span><span class="p">,</span> |
---|
| 361 | <span class="n">selectwhere</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">filemode</span><span class="o">=</span><span class="s1">'wb'</span><span class="p">):</span> |
---|
[0b00607] | 362 | <span class="sd">'''Add the content of another input grib file to the objects file but</span> |
---|
| 363 | <span class="sd"> only messages corresponding to keys/values passed to the function.</span> |
---|
| 364 | <span class="sd"> The selectWhere switch decides if to copy the keys equal to (True) or</span> |
---|
| 365 | <span class="sd"> different to (False) the keynames/keyvalues list passed to the function.</span> |
---|
| 366 | |
---|
| 367 | <span class="sd"> Parameters</span> |
---|
| 368 | <span class="sd"> ----------</span> |
---|
| 369 | <span class="sd"> filename_in : :obj:`string`</span> |
---|
| 370 | <span class="sd"> Filename of the input file to read the grib messages from.</span> |
---|
| 371 | |
---|
[eca358d] | 372 | <span class="sd"> selectwhere : :obj:`boolean`, optional</span> |
---|
[0b00607] | 373 | <span class="sd"> Decides if to copy the keynames and values equal to (True) or</span> |
---|
| 374 | <span class="sd"> different to (False) the keynames/keyvalues list passed to the</span> |
---|
| 375 | <span class="sd"> function. Default is True.</span> |
---|
| 376 | |
---|
[eca358d] | 377 | <span class="sd"> keynames : :obj:`list` of :obj:`string`</span> |
---|
| 378 | <span class="sd"> List of keynames.</span> |
---|
[0b00607] | 379 | |
---|
[eca358d] | 380 | <span class="sd"> keyvalues : :obj:`list` of :obj:`string`</span> |
---|
| 381 | <span class="sd"> List of keyvalues.</span> |
---|
[0b00607] | 382 | |
---|
| 383 | <span class="sd"> filemode : :obj:`string`, optional</span> |
---|
[30f7911] | 384 | <span class="sd"> Sets the mode for the output file. Default is "wb".</span> |
---|
[0b00607] | 385 | |
---|
| 386 | <span class="sd"> Return</span> |
---|
| 387 | <span class="sd"> ------</span> |
---|
| 388 | |
---|
| 389 | <span class="sd"> '''</span> |
---|
[b1674ed] | 390 | <span class="kn">from</span> <span class="nn">eccodes</span> <span class="kn">import</span> <span class="p">(</span><span class="n">codes_grib_new_from_file</span><span class="p">,</span> <span class="n">codes_is_defined</span><span class="p">,</span> |
---|
[0b00607] | 391 | <span class="n">codes_get</span><span class="p">,</span> <span class="n">codes_release</span><span class="p">,</span> <span class="n">codes_write</span><span class="p">)</span> |
---|
| 392 | |
---|
| 393 | <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">keynames</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">keyvalues</span><span class="p">):</span> |
---|
| 394 | <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"Give a value for each keyname!"</span><span class="p">)</span> |
---|
| 395 | |
---|
| 396 | <span class="n">fout</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">filenames</span><span class="p">,</span> <span class="n">filemode</span><span class="p">)</span> |
---|
[08c9091] | 397 | <span class="n">fin</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename_in</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> |
---|
| 398 | |
---|
[0b00607] | 399 | <span class="n">fields</span> <span class="o">=</span> <span class="mi">0</span> |
---|
[08c9091] | 400 | <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> |
---|
| 401 | <span class="k">if</span> <span class="n">fields</span> <span class="o">>=</span> <span class="nb">len</span><span class="p">(</span><span class="n">keyvalues</span><span class="p">):</span> |
---|
[30f7911] | 402 | <span class="n">fout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
---|
[08c9091] | 403 | <span class="n">fin</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
---|
[30f7911] | 404 | <span class="k">return</span> |
---|
[08c9091] | 405 | |
---|
[30f7911] | 406 | <span class="n">gid</span> <span class="o">=</span> <span class="n">codes_grib_new_from_file</span><span class="p">(</span><span class="n">fin</span><span class="p">)</span> |
---|
[08c9091] | 407 | <span class="k">if</span> <span class="n">gid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
---|
| 408 | <span class="k">break</span> |
---|
[0b00607] | 409 | |
---|
[08c9091] | 410 | <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">key</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">keynames</span><span class="p">):</span> |
---|
| 411 | |
---|
| 412 | <span class="n">select</span> <span class="o">=</span> <span class="kc">True</span> |
---|
| 413 | |
---|
[0b00607] | 414 | <span class="k">if</span> <span class="ow">not</span> <span class="n">codes_is_defined</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span> |
---|
| 415 | <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">"Key was not defined"</span><span class="p">)</span> |
---|
| 416 | |
---|
[eca358d] | 417 | <span class="k">if</span> <span class="n">selectwhere</span><span class="p">:</span> |
---|
[0b00607] | 418 | <span class="n">select</span> <span class="o">=</span> <span class="p">(</span><span class="n">select</span> <span class="ow">and</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">keyvalues</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> <span class="o">==</span> |
---|
| 419 | <span class="nb">str</span><span class="p">(</span><span class="n">codes_get</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">key</span><span class="p">))))</span> |
---|
| 420 | <span class="k">else</span><span class="p">:</span> |
---|
| 421 | <span class="n">select</span> <span class="o">=</span> <span class="p">(</span><span class="n">select</span> <span class="ow">and</span> <span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">keyvalues</span><span class="p">[</span><span class="n">i</span><span class="p">])</span> <span class="o">!=</span> |
---|
| 422 | <span class="nb">str</span><span class="p">(</span><span class="n">codes_get</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">key</span><span class="p">))))</span> |
---|
[08c9091] | 423 | |
---|
| 424 | <span class="k">if</span> <span class="n">select</span><span class="p">:</span> |
---|
| 425 | <span class="n">fields</span> <span class="o">=</span> <span class="n">fields</span> <span class="o">+</span> <span class="mi">1</span> |
---|
| 426 | <span class="n">codes_write</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">fout</span><span class="p">)</span> |
---|
| 427 | |
---|
[0b00607] | 428 | <span class="n">codes_release</span><span class="p">(</span><span class="n">gid</span><span class="p">)</span> |
---|
| 429 | |
---|
| 430 | <span class="n">fout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
---|
[08c9091] | 431 | <span class="n">fin</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
---|
[0b00607] | 432 | |
---|
| 433 | <span class="k">return</span></div> |
---|
| 434 | |
---|
[eca358d] | 435 | <div class="viewcode-block" id="GribUtil.index"><a class="viewcode-back" href="../Documentation/Api/api_python.html#GribUtil.GribUtil.index">[docs]</a> <span class="k">def</span> <span class="nf">index</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index_keys</span><span class="p">,</span> <span class="n">index_file</span><span class="o">=</span><span class="s2">"my.idx"</span><span class="p">):</span> |
---|
[0b00607] | 436 | <span class="sd">'''Create index file from a list of files if it does not exist or</span> |
---|
| 437 | <span class="sd"> read an index file.</span> |
---|
| 438 | |
---|
| 439 | <span class="sd"> Parameters</span> |
---|
| 440 | <span class="sd"> ----------</span> |
---|
[eca358d] | 441 | <span class="sd"> index_keys: :obj:`list` of :obj:`string`</span> |
---|
[0b00607] | 442 | <span class="sd"> Contains the list of key parameter names from</span> |
---|
| 443 | <span class="sd"> which the index is to be created.</span> |
---|
| 444 | |
---|
| 445 | <span class="sd"> index_file: :obj:`string`, optional</span> |
---|
| 446 | <span class="sd"> Filename where the indices are stored.</span> |
---|
| 447 | <span class="sd"> Default is "my.idx".</span> |
---|
| 448 | |
---|
| 449 | <span class="sd"> Return</span> |
---|
| 450 | <span class="sd"> ------</span> |
---|
| 451 | <span class="sd"> iid: :obj:`integer`</span> |
---|
| 452 | <span class="sd"> Grib index id.</span> |
---|
| 453 | <span class="sd"> '''</span> |
---|
[b1674ed] | 454 | <span class="kn">from</span> <span class="nn">eccodes</span> <span class="kn">import</span> <span class="p">(</span><span class="n">codes_index_read</span><span class="p">,</span> <span class="n">codes_index_new_from_file</span><span class="p">,</span> |
---|
[0b00607] | 455 | <span class="n">codes_index_add_file</span><span class="p">,</span> <span class="n">codes_index_write</span><span class="p">)</span> |
---|
| 456 | |
---|
| 457 | <span class="nb">print</span><span class="p">(</span><span class="s2">"... index will be done"</span><span class="p">)</span> |
---|
| 458 | <span class="n">iid</span> <span class="o">=</span> <span class="kc">None</span> |
---|
| 459 | |
---|
| 460 | <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">index_file</span><span class="p">):</span> |
---|
| 461 | <span class="n">iid</span> <span class="o">=</span> <span class="n">codes_index_read</span><span class="p">(</span><span class="n">index_file</span><span class="p">)</span> |
---|
| 462 | <span class="nb">print</span><span class="p">(</span><span class="s2">"Use existing index file: </span><span class="si">%s</span><span class="s2"> "</span> <span class="o">%</span> <span class="p">(</span><span class="n">index_file</span><span class="p">))</span> |
---|
| 463 | <span class="k">else</span><span class="p">:</span> |
---|
| 464 | <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">filenames</span><span class="p">:</span> |
---|
| 465 | <span class="nb">print</span><span class="p">(</span><span class="s2">"Inputfile: </span><span class="si">%s</span><span class="s2"> "</span> <span class="o">%</span> <span class="p">(</span><span class="n">filename</span><span class="p">))</span> |
---|
| 466 | <span class="k">if</span> <span class="n">iid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
---|
| 467 | <span class="n">iid</span> <span class="o">=</span> <span class="n">codes_index_new_from_file</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">index_keys</span><span class="p">)</span> |
---|
| 468 | <span class="k">else</span><span class="p">:</span> |
---|
| 469 | <span class="n">codes_index_add_file</span><span class="p">(</span><span class="n">iid</span><span class="p">,</span> <span class="n">filename</span><span class="p">)</span> |
---|
| 470 | |
---|
| 471 | <span class="k">if</span> <span class="n">iid</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
---|
| 472 | <span class="n">codes_index_write</span><span class="p">(</span><span class="n">iid</span><span class="p">,</span> <span class="n">index_file</span><span class="p">)</span> |
---|
| 473 | |
---|
| 474 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... index done'</span><span class="p">)</span> |
---|
| 475 | |
---|
| 476 | <span class="k">return</span> <span class="n">iid</span></div></div> |
---|
| 477 | </pre></div> |
---|
| 478 | |
---|
| 479 | </div> |
---|
| 480 | |
---|
| 481 | </div> |
---|
| 482 | <footer> |
---|
| 483 | |
---|
| 484 | |
---|
| 485 | <hr/> |
---|
| 486 | |
---|
| 487 | <div role="contentinfo"> |
---|
| 488 | <p> |
---|
[5bee29a] | 489 | © Copyright 2020, Anne Philipp, Leopold Haimberger and Petra Seibert |
---|
[0b00607] | 490 | |
---|
| 491 | </p> |
---|
| 492 | </div> |
---|
| 493 | 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>. |
---|
| 494 | |
---|
| 495 | </footer> |
---|
| 496 | |
---|
| 497 | </div> |
---|
| 498 | </div> |
---|
| 499 | |
---|
| 500 | </section> |
---|
| 501 | |
---|
| 502 | </div> |
---|
| 503 | |
---|
| 504 | |
---|
| 505 | |
---|
| 506 | <script type="text/javascript"> |
---|
| 507 | jQuery(function () { |
---|
| 508 | SphinxRtdTheme.Navigation.enable(true); |
---|
| 509 | }); |
---|
| 510 | </script> |
---|
| 511 | |
---|
| 512 | |
---|
| 513 | |
---|
| 514 | |
---|
| 515 | |
---|
| 516 | |
---|
| 517 | </body> |
---|
| 518 | </html> |
---|