source: flex_extract.git/Documentation/html/_modules/GribUtil.html @ 6bc4b42

ctbtodev
Last change on this file since 6bc4b42 was ba99230, checked in by Anne Philipp <anne.philipp@…>, 5 years ago

capitalize all directory names and adapt pathes in files
  • Property mode set to 100644
File size: 35.7 KB
Line 
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7  <meta charset="utf-8">
8 
9  <meta name="viewport" content="width=device-width, initial-scale=1.0">
10 
11  <title>GribUtil &mdash; flex_extract 7.1 alpha documentation</title>
12 
13
14 
15 
16 
17 
18
19 
20  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
21 
22   
23      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
24        <script type="text/javascript" src="../_static/jquery.js"></script>
25        <script type="text/javascript" src="../_static/underscore.js"></script>
26        <script type="text/javascript" src="../_static/doctools.js"></script>
27        <script type="text/javascript" src="../_static/language_data.js"></script>
28        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
29   
30    <script type="text/javascript" src="../_static/js/theme.js"></script>
31
32   
33
34 
35  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
36  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
37  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
38  <link rel="stylesheet" href="../_static/css/theme_overrides.css" type="text/css" />
39    <link rel="index" title="Index" href="../genindex.html" />
40    <link rel="search" title="Search" href="../search.html" /> 
41</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">
64                7.1
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="../installation.html">Installation</a></li>
91<li class="toctree-l1"><a class="reference internal" href="../quick_start.html">Quick Start</a></li>
92<li class="toctree-l1"><a class="reference internal" href="../ecmwf_data.html">ECMWF Data</a></li>
93<li class="toctree-l1"><a class="reference internal" href="../documentation.html">Documentation</a></li>
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> &raquo;</li>
144       
145          <li><a href="index.html">Module code</a> &raquo;</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>
163<span></span><span class="ch">#!/usr/bin/env python</span>
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>
177<span class="c1">#    (C) Copyright 2014-2018.</span>
178<span class="c1">#</span>
179<span class="c1">#    This software is licensed under the terms of the Apache Licence Version 2.0</span>
180<span class="c1">#    which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.</span>
181<span class="c1">#</span>
182<span class="c1"># @Class Description:</span>
183<span class="c1">#    The GRIB API provides all necessary tools to work directly with the</span>
184<span class="c1">#    grib files. Nevertheless, the GRIB API tools are very basic and are in</span>
185<span class="c1">#    direct connection with the grib files. This class provides some higher</span>
186<span class="c1">#    functions which apply a set of GRIB API tools together in the respective</span>
187<span class="c1">#    context. So, the class initially contains a list of grib files (their</span>
188<span class="c1">#    names) and the using program then applies the methods directly on the</span>
189<span class="c1">#    class objects without having to think about how the actual GRIB API</span>
190<span class="c1">#    tools have to be arranged.</span>
191<span class="c1">#</span>
192<span class="c1"># @Class Content:</span>
193<span class="c1">#    - __init__</span>
194<span class="c1">#    - get_keys</span>
195<span class="c1">#    - set_keys</span>
196<span class="c1">#    - copy_dummy_msg</span>
197<span class="c1">#    - index</span>
198<span class="c1">#</span>
199<span class="c1"># @Class Attributes:</span>
200<span class="c1">#    - filenames</span>
201<span class="c1">#</span>
202<span class="c1">#*******************************************************************************</span>
203
204<span class="c1"># ------------------------------------------------------------------------------</span>
205<span class="c1"># MODULES</span>
206<span class="c1"># ------------------------------------------------------------------------------</span>
207<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span>
208
209<span class="kn">import</span> <span class="nn">os</span>
210
211<span class="c1"># ------------------------------------------------------------------------------</span>
212<span class="c1"># CLASS</span>
213<span class="c1"># ------------------------------------------------------------------------------</span>
214<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>
215    <span class="sd">&#39;&#39;&#39;</span>
216<span class="sd">    Class for GRIB utilities (new methods) based on GRIB API</span>
217<span class="sd">    &#39;&#39;&#39;</span>
218    <span class="c1"># --------------------------------------------------------------------------</span>
219    <span class="c1"># CLASS FUNCTIONS</span>
220    <span class="c1"># --------------------------------------------------------------------------</span>
221    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filenames</span><span class="p">):</span>
222        <span class="sd">&#39;&#39;&#39;Initialise an object of GribUtil and assign a list of filenames.</span>
223
224<span class="sd">        Parameters</span>
225<span class="sd">        ----------</span>
226<span class="sd">        filenames : :obj:`list` of :obj:`strings`</span>
227<span class="sd">             A list of filenames.</span>
228
229<span class="sd">        Return</span>
230<span class="sd">        ------</span>
231
232<span class="sd">        &#39;&#39;&#39;</span>
233
234        <span class="bp">self</span><span class="o">.</span><span class="n">filenames</span> <span class="o">=</span> <span class="n">filenames</span>
235
236        <span class="k">return</span>
237
238
239<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="o">=</span><span class="p">[],</span> <span class="n">wherekeyvalues</span><span class="o">=</span><span class="p">[]):</span>
240        <span class="sd">&#39;&#39;&#39;Get keyvalues for a given list of keynames a where statement</span>
241<span class="sd">        can be given (list of key and list of values)</span>
242
243<span class="sd">        Parameters</span>
244<span class="sd">        ----------</span>
245<span class="sd">        keynames : :obj:`list` of :obj:`string`</span>
246<span class="sd">            List of keynames.</span>
247
248<span class="sd">        wherekeynames : :obj:`list` of :obj:`string`, optional</span>
249<span class="sd">            Default value is an empty list.</span>
250
251<span class="sd">        wherekeyvalues : :obj:`list` of :obj:`string`, optional</span>
252<span class="sd">            Default value is an empty list.</span>
253
254<span class="sd">        Return</span>
255<span class="sd">        ------</span>
256<span class="sd">        return_list : :obj:`list` of :obj:`string`</span>
257<span class="sd">            List of keyvalues for given keynames.</span>
258<span class="sd">        &#39;&#39;&#39;</span>
259        <span class="kn">from</span> <span class="nn">eccodes</span> <span class="k">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>
260                             <span class="n">codes_release</span><span class="p">)</span>
261
262        <span class="n">fileid</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="s1">&#39;r&#39;</span><span class="p">)</span>
263
264        <span class="n">return_list</span> <span class="o">=</span> <span class="p">[]</span>
265
266        <span class="k">while</span> <span class="mi">1</span><span class="p">:</span>
267            <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>
268
269            <span class="k">if</span> <span class="n">gid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
270                <span class="k">break</span>
271
272            <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>
273                <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Number of key values and key names must be </span><span class="se">\</span>
274<span class="s2">                                 the same. Give a value for each keyname!&quot;</span><span class="p">)</span>
275
276            <span class="n">select</span> <span class="o">=</span> <span class="kc">True</span>
277            <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span>
278            <span class="k">for</span> <span class="n">wherekey</span> <span class="ow">in</span> <span class="n">wherekeynames</span><span class="p">:</span>
279                <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>
280                    <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;where key was not defined&quot;</span><span class="p">)</span>
281
282                <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>
283                                      <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>
284                <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
285
286            <span class="k">if</span> <span class="n">select</span><span class="p">:</span>
287                <span class="n">llist</span> <span class="o">=</span> <span class="p">[]</span>
288                <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keynames</span><span class="p">:</span>
289                    <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>
290                <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>
291
292            <span class="n">codes_release</span><span class="p">(</span><span class="n">gid</span><span class="p">)</span>
293
294        <span class="n">fileid</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
295
296        <span class="k">return</span> <span class="n">return_list</span></div>
297
298
299<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">keynames</span><span class="p">,</span> <span class="n">keyvalues</span><span class="p">,</span> <span class="n">wherekeynames</span><span class="o">=</span><span class="p">[],</span>
300                 <span class="n">wherekeyvalues</span><span class="o">=</span><span class="p">[],</span> <span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">filemode</span><span class="o">=</span><span class="s1">&#39;w&#39;</span><span class="p">):</span>
301        <span class="sd">&#39;&#39;&#39;Opens the file to read the grib messages and then write</span>
302<span class="sd">        the selected messages (with wherekeys) to a new output file.</span>
303<span class="sd">        Also, the keyvalues of the passed list of keynames are set.</span>
304
305<span class="sd">        Parameters</span>
306<span class="sd">        ----------</span>
307<span class="sd">        fromfile : :obj:`string`</span>
308<span class="sd">            Filename of the input file to read the grib messages from.</span>
309
310<span class="sd">        keynames : :obj:`list` of :obj:`string`</span>
311<span class="sd">            List of keynames to set in the selected messages.</span>
312<span class="sd">            Default is an empty list.</span>
313
314<span class="sd">        keyvalues : :obj:`list` of :obj:`string`</span>
315<span class="sd">            List of keyvalues to set in the selected messages.</span>
316<span class="sd">            Default is an empty list.</span>
317
318<span class="sd">        wherekeynames : :obj:`list` of :obj:`string`, optional</span>
319<span class="sd">            List of keynames to select correct message.</span>
320<span class="sd">            Default value is an empty list.</span>
321
322<span class="sd">        wherekeyvalues : :obj:`list` of :obj:`string`, optional</span>
323<span class="sd">            List of keyvalues for keynames to select correct message.</span>
324<span class="sd">            Default value is an empty list.</span>
325
326<span class="sd">        strict : :obj:`boolean`, optional</span>
327<span class="sd">            Decides if everything from keynames and keyvalues</span>
328<span class="sd">            is written out the grib file (False) or only those</span>
329<span class="sd">            meeting the where statement (True). Default is False.</span>
330
331<span class="sd">        filemode : :obj:`string`, optional</span>
332<span class="sd">            Sets the mode for the output file. Default is &quot;w&quot;.</span>
333
334<span class="sd">        Return</span>
335<span class="sd">        ------</span>
336
337<span class="sd">        &#39;&#39;&#39;</span>
338        <span class="kn">from</span> <span class="nn">eccodes</span> <span class="k">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>
339                             <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>
340                             <span class="n">codes_set_values</span><span class="p">,</span> <span class="n">codes_release</span><span class="p">)</span>
341
342        <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>
343            <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Give a value for each keyname!&quot;</span><span class="p">)</span>
344
345        <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>
346        <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>
347
348        <span class="k">while</span> <span class="mi">1</span><span class="p">:</span>
349            <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>
350
351            <span class="k">if</span> <span class="n">gid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
352                <span class="k">break</span>
353
354            <span class="n">select</span> <span class="o">=</span> <span class="kc">True</span>
355            <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span>
356            <span class="k">for</span> <span class="n">wherekey</span> <span class="ow">in</span> <span class="n">wherekeynames</span><span class="p">:</span>
357                <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>
358                    <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;wherekey was not defined&quot;</span><span class="p">)</span>
359
360                <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>
361                                      <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>
362                <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
363
364            <span class="k">if</span> <span class="n">select</span><span class="p">:</span>
365                <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span>
366                <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keynames</span><span class="p">:</span>
367                    <span class="k">if</span> <span class="n">key</span> <span class="o">==</span> <span class="s1">&#39;values&#39;</span><span class="p">:</span>
368                        <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>
369                    <span class="k">else</span><span class="p">:</span>
370                        <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>
371                    <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
372
373                <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>
374
375            <span class="n">codes_release</span><span class="p">(</span><span class="n">gid</span><span class="p">)</span>
376
377        <span class="n">fin</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
378        <span class="n">fout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
379
380        <span class="k">return</span></div>
381
382<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">selectWhere</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
383                 <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> <span class="n">filemode</span><span class="o">=</span><span class="s1">&#39;w&#39;</span><span class="p">):</span>
384        <span class="sd">&#39;&#39;&#39;Add the content of another input grib file to the objects file but</span>
385<span class="sd">        only messages corresponding to keys/values passed to the function.</span>
386<span class="sd">        The selectWhere switch decides if to copy the keys equal to (True) or</span>
387<span class="sd">        different to (False) the keynames/keyvalues list passed to the function.</span>
388
389<span class="sd">        Parameters</span>
390<span class="sd">        ----------</span>
391<span class="sd">        filename_in : :obj:`string`</span>
392<span class="sd">            Filename of the input file to read the grib messages from.</span>
393
394<span class="sd">        selectWhere : :obj:`boolean`, optional</span>
395<span class="sd">            Decides if to copy the keynames and values equal to (True) or</span>
396<span class="sd">            different to (False) the keynames/keyvalues list passed to the</span>
397<span class="sd">            function. Default is True.</span>
398
399<span class="sd">        keynames : :obj:`list` of :obj:`string`, optional</span>
400<span class="sd">            List of keynames. Default is an empty list.</span>
401
402<span class="sd">        keyvalues : :obj:`list` of :obj:`string`, optional</span>
403<span class="sd">            List of keyvalues. Default is an empty list.</span>
404
405<span class="sd">        filemode : :obj:`string`, optional</span>
406<span class="sd">            Sets the mode for the output file. Default is &quot;w&quot;.</span>
407
408<span class="sd">        Return</span>
409<span class="sd">        ------</span>
410
411<span class="sd">        &#39;&#39;&#39;</span>
412        <span class="kn">from</span> <span class="nn">eccodes</span> <span class="k">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>
413                             <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>
414
415        <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>
416            <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Give a value for each keyname!&quot;</span><span class="p">)</span>
417
418        <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">&#39;rb&#39;</span><span class="p">)</span>
419        <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>
420
421        <span class="n">fields</span> <span class="o">=</span> <span class="mi">0</span>
422
423        <span class="k">while</span> <span class="n">fields</span> <span class="o">&lt;</span> <span class="mi">1</span><span class="p">:</span>
424            <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>
425
426            <span class="k">if</span> <span class="n">gid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
427                <span class="k">break</span>
428
429            <span class="n">select</span> <span class="o">=</span> <span class="kc">True</span>
430            <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span>
431            <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keynames</span><span class="p">:</span>
432                <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>
433                    <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Key was not defined&quot;</span><span class="p">)</span>
434
435                <span class="k">if</span> <span class="n">selectWhere</span><span class="p">:</span>
436                    <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>
437                                          <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>
438                <span class="k">else</span><span class="p">:</span>
439                    <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>
440                                          <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>
441                <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
442
443            <span class="k">if</span> <span class="n">select</span><span class="p">:</span>
444                <span class="n">fields</span> <span class="o">=</span> <span class="n">fields</span> <span class="o">+</span> <span class="mi">1</span>
445                <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>
446
447            <span class="n">codes_release</span><span class="p">(</span><span class="n">gid</span><span class="p">)</span>
448
449        <span class="n">fin</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
450        <span class="n">fout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
451
452        <span class="k">return</span></div>
453
454<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="o">=</span><span class="p">[</span><span class="s2">&quot;mars&quot;</span><span class="p">],</span> <span class="n">index_file</span><span class="o">=</span><span class="s2">&quot;my.idx&quot;</span><span class="p">):</span>
455        <span class="sd">&#39;&#39;&#39;Create index file from a list of files if it does not exist or</span>
456<span class="sd">        read an index file.</span>
457
458<span class="sd">        Parameters</span>
459<span class="sd">        ----------</span>
460<span class="sd">        index_keys: :obj:`list` of :obj:`string`, optional</span>
461<span class="sd">            Contains the list of key parameter names from</span>
462<span class="sd">            which the index is to be created.</span>
463<span class="sd">            Default is a list with a single entry string &quot;mars&quot;.</span>
464
465<span class="sd">        index_file: :obj:`string`, optional</span>
466<span class="sd">            Filename where the indices are stored.</span>
467<span class="sd">            Default is &quot;my.idx&quot;.</span>
468
469<span class="sd">        Return</span>
470<span class="sd">        ------</span>
471<span class="sd">        iid: :obj:`integer`</span>
472<span class="sd">            Grib index id.</span>
473<span class="sd">        &#39;&#39;&#39;</span>
474        <span class="kn">from</span> <span class="nn">eccodes</span> <span class="k">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>
475                             <span class="n">codes_index_add_file</span><span class="p">,</span> <span class="n">codes_index_write</span><span class="p">)</span>
476
477        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;... index will be done&quot;</span><span class="p">)</span>
478        <span class="n">iid</span> <span class="o">=</span> <span class="kc">None</span>
479
480        <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>
481            <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>
482            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Use existing index file: </span><span class="si">%s</span><span class="s2"> &quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">index_file</span><span class="p">))</span>
483        <span class="k">else</span><span class="p">:</span>
484            <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>
485                <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Inputfile: </span><span class="si">%s</span><span class="s2"> &quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">filename</span><span class="p">))</span>
486                <span class="k">if</span> <span class="n">iid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
487                    <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>
488                <span class="k">else</span><span class="p">:</span>
489                    <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>
490
491            <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>
492                <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>
493
494        <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;... index done&#39;</span><span class="p">)</span>
495
496        <span class="k">return</span> <span class="n">iid</span></div></div>
497</pre></div>
498
499           </div>
500           
501          </div>
502          <footer>
503 
504
505  <hr/>
506
507  <div role="contentinfo">
508    <p>
509        &copy; Copyright 2019, Anne Philipp and Leopold Haimberger
510
511    </p>
512  </div>
513  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>.
514
515</footer>
516
517        </div>
518      </div>
519
520    </section>
521
522  </div>
523 
524
525
526  <script type="text/javascript">
527      jQuery(function () {
528          SphinxRtdTheme.Navigation.enable(true);
529      });
530  </script>
531
532 
533 
534   
535   
536
537</body>
538</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG