source: flex_extract.git/documentation/Sphinx/build/html/_modules/GribUtil.html @ f66f990

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

deleted jobscripts for tracking and updated Sphinx doc
  • Property mode set to 100644
File size: 33.9 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
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
32 
33  <script src="../_static/js/modernizr.min.js"></script>
34
35</head>
36
37<body class="wy-body-for-nav">
38
39   
40  <div class="wy-grid-for-nav">
41
42   
43    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
44      <div class="wy-side-scroll">
45        <div class="wy-side-nav-search">
46         
47
48         
49            <a href="../index.html" class="icon icon-home"> flex_extract
50         
51
52         
53          </a>
54
55         
56           
57           
58              <div class="version">
59                7.1
60              </div>
61           
62         
63
64         
65<div role="search">
66  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
67    <input type="text" name="q" placeholder="Search docs" />
68    <input type="hidden" name="check_keywords" value="yes" />
69    <input type="hidden" name="area" value="default" />
70  </form>
71</div>
72
73         
74        </div>
75
76        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
77         
78           
79           
80             
81           
82           
83              <p class="caption"><span class="caption-text">Table of Contents:</span></p>
84<ul>
85<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>
86<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
87<li class="toctree-l1"><a class="reference internal" href="../program_structure.html">Program Structure</a></li>
88<li class="toctree-l1"><a class="reference internal" href="../user_guide.html">User Guide</a></li>
89<li class="toctree-l1"><a class="reference internal" href="../api.html">Auto Generated Documentation</a></li>
90<li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li>
91</ul>
92
93           
94         
95        </div>
96      </div>
97    </nav>
98
99    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
100
101     
102      <nav class="wy-nav-top" aria-label="top navigation">
103       
104          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
105          <a href="../index.html">flex_extract</a>
106       
107      </nav>
108
109
110      <div class="wy-nav-content">
111       
112        <div class="rst-content">
113       
114         
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130<div role="navigation" aria-label="breadcrumbs navigation">
131
132  <ul class="wy-breadcrumbs">
133   
134      <li><a href="../index.html">Docs</a> &raquo;</li>
135       
136          <li><a href="index.html">Module code</a> &raquo;</li>
137       
138      <li>GribUtil</li>
139   
140   
141      <li class="wy-breadcrumbs-aside">
142       
143      </li>
144   
145  </ul>
146
147 
148  <hr/>
149</div>
150          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
151           <div itemprop="articleBody">
152           
153  <h1>Source code for GribUtil</h1><div class="highlight"><pre>
154<span></span><span class="ch">#!/usr/bin/env python</span>
155<span class="c1"># -*- coding: utf-8 -*-</span>
156<span class="c1">#*******************************************************************************</span>
157<span class="c1"># @Author: Anne Fouilloux (University of Oslo)</span>
158<span class="c1">#</span>
159<span class="c1"># @Date: July 2014</span>
160<span class="c1">#</span>
161<span class="c1"># @Change History:</span>
162<span class="c1">#   February 2018 - Anne Philipp (University of Vienna):</span>
163<span class="c1">#        - applied PEP8 style guide</span>
164<span class="c1">#        - added documentation</span>
165<span class="c1">#        - changed some naming</span>
166<span class="c1">#</span>
167<span class="c1"># @License:</span>
168<span class="c1">#    (C) Copyright 2014-2018.</span>
169<span class="c1">#</span>
170<span class="c1">#    This software is licensed under the terms of the Apache Licence Version 2.0</span>
171<span class="c1">#    which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.</span>
172<span class="c1">#</span>
173<span class="c1"># @Class Description:</span>
174<span class="c1">#    The GRIB API provides all necessary tools to work directly with the</span>
175<span class="c1">#    grib files. Nevertheless, the GRIB API tools are very basic and are in</span>
176<span class="c1">#    direct connection with the grib files. This class provides some higher</span>
177<span class="c1">#    functions which apply a set of GRIB API tools together in the respective</span>
178<span class="c1">#    context. So, the class initially contains a list of grib files (their</span>
179<span class="c1">#    names) and the using program then applies the methods directly on the</span>
180<span class="c1">#    class objects without having to think about how the actual GRIB API</span>
181<span class="c1">#    tools have to be arranged.</span>
182<span class="c1">#</span>
183<span class="c1"># @Class Content:</span>
184<span class="c1">#    - __init__</span>
185<span class="c1">#    - get_keys</span>
186<span class="c1">#    - set_keys</span>
187<span class="c1">#    - copy_dummy_msg</span>
188<span class="c1">#    - index</span>
189<span class="c1">#</span>
190<span class="c1"># @Class Attributes:</span>
191<span class="c1">#    - filenames</span>
192<span class="c1">#</span>
193<span class="c1">#*******************************************************************************</span>
194
195<span class="c1"># ------------------------------------------------------------------------------</span>
196<span class="c1"># MODULES</span>
197<span class="c1"># ------------------------------------------------------------------------------</span>
198<span class="kn">import</span> <span class="nn">os</span>
199
200<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> <span class="n">codes_get</span><span class="p">,</span>
201                     <span class="n">codes_release</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> <span class="n">codes_index_read</span><span class="p">,</span>
202                     <span class="n">codes_index_new_from_file</span><span class="p">,</span> <span class="n">codes_index_add_file</span><span class="p">,</span>
203                     <span class="n">codes_index_write</span><span class="p">,</span> <span class="n">codes_set_values</span><span class="p">)</span>
204
205<span class="c1"># ------------------------------------------------------------------------------</span>
206<span class="c1"># CLASS</span>
207<span class="c1"># ------------------------------------------------------------------------------</span>
208<div class="viewcode-block" id="GribUtil"><a class="viewcode-back" href="../api.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>
209    <span class="sd">&#39;&#39;&#39;</span>
210<span class="sd">    Class for GRIB utilities (new methods) based on GRIB API</span>
211<span class="sd">    &#39;&#39;&#39;</span>
212    <span class="c1"># --------------------------------------------------------------------------</span>
213    <span class="c1"># CLASS FUNCTIONS</span>
214    <span class="c1"># --------------------------------------------------------------------------</span>
215    <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>
216        <span class="sd">&#39;&#39;&#39;Initialise an object of GribUtil and assign a list of filenames.</span>
217
218<span class="sd">        Parameters</span>
219<span class="sd">        ----------</span>
220<span class="sd">        filenames : :obj:`list` of :obj:`strings`</span>
221<span class="sd">             A list of filenames.</span>
222
223<span class="sd">        Return</span>
224<span class="sd">        ------</span>
225
226<span class="sd">        &#39;&#39;&#39;</span>
227
228        <span class="bp">self</span><span class="o">.</span><span class="n">filenames</span> <span class="o">=</span> <span class="n">filenames</span>
229
230        <span class="k">return</span>
231
232
233<div class="viewcode-block" id="GribUtil.get_keys"><a class="viewcode-back" href="../api.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>
234        <span class="sd">&#39;&#39;&#39;Get keyvalues for a given list of keynames a where statement</span>
235<span class="sd">        can be given (list of key and list of values)</span>
236
237<span class="sd">        Parameters</span>
238<span class="sd">        ----------</span>
239<span class="sd">        keynames : :obj:`list` of :obj:`string`</span>
240<span class="sd">            List of keynames.</span>
241
242<span class="sd">        wherekeynames : :obj:`list` of :obj:`string`, optional</span>
243<span class="sd">            Default value is an empty list.</span>
244
245<span class="sd">        wherekeyvalues : :obj:`list` of :obj:`string`, optional</span>
246<span class="sd">            Default value is an empty list.</span>
247
248<span class="sd">        Return</span>
249<span class="sd">        ------</span>
250<span class="sd">        return_list : :obj:`list` of :obj:`string`</span>
251<span class="sd">            List of keyvalues for given keynames.</span>
252<span class="sd">        &#39;&#39;&#39;</span>
253
254        <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>
255
256        <span class="n">return_list</span> <span class="o">=</span> <span class="p">[]</span>
257
258        <span class="k">while</span> <span class="mi">1</span><span class="p">:</span>
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>
260
261            <span class="k">if</span> <span class="n">gid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
262                <span class="k">break</span>
263
264            <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>
265                <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>
266<span class="s2">                                 the same. Give a value for each keyname!&quot;</span><span class="p">)</span>
267
268            <span class="n">select</span> <span class="o">=</span> <span class="kc">True</span>
269            <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span>
270            <span class="k">for</span> <span class="n">wherekey</span> <span class="ow">in</span> <span class="n">wherekeynames</span><span class="p">:</span>
271                <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>
272                    <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>
273
274                <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>
275                                      <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>
276                <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
277
278            <span class="k">if</span> <span class="n">select</span><span class="p">:</span>
279                <span class="n">llist</span> <span class="o">=</span> <span class="p">[]</span>
280                <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keynames</span><span class="p">:</span>
281                    <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>
282                <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>
283
284            <span class="n">codes_release</span><span class="p">(</span><span class="n">gid</span><span class="p">)</span>
285
286        <span class="n">fileid</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
287
288        <span class="k">return</span> <span class="n">return_list</span></div>
289
290
291<div class="viewcode-block" id="GribUtil.set_keys"><a class="viewcode-back" href="../api.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>
292                 <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>
293        <span class="sd">&#39;&#39;&#39;Opens the file to read the grib messages and then write</span>
294<span class="sd">        the selected messages (with wherekeys) to a new output file.</span>
295<span class="sd">        Also, the keyvalues of the passed list of keynames are set.</span>
296
297<span class="sd">        Parameters</span>
298<span class="sd">        ----------</span>
299<span class="sd">        fromfile : :obj:`string`</span>
300<span class="sd">            Filename of the input file to read the grib messages from.</span>
301
302<span class="sd">        keynames : :obj:`list` of :obj:`string`</span>
303<span class="sd">            List of keynames to set in the selected messages.</span>
304<span class="sd">            Default is an empty list.</span>
305
306<span class="sd">        keyvalues : :obj:`list` of :obj:`string`</span>
307<span class="sd">            List of keyvalues to set in the selected messages.</span>
308<span class="sd">            Default is an empty list.</span>
309
310<span class="sd">        wherekeynames : :obj:`list` of :obj:`string`, optional</span>
311<span class="sd">            List of keynames to select correct message.</span>
312<span class="sd">            Default value is an empty list.</span>
313
314<span class="sd">        wherekeyvalues : :obj:`list` of :obj:`string`, optional</span>
315<span class="sd">            List of keyvalues for keynames to select correct message.</span>
316<span class="sd">            Default value is an empty list.</span>
317
318<span class="sd">        strict : :obj:`boolean`, optional</span>
319<span class="sd">            Decides if everything from keynames and keyvalues</span>
320<span class="sd">            is written out the grib file (False) or only those</span>
321<span class="sd">            meeting the where statement (True). Default is False.</span>
322
323<span class="sd">        filemode : :obj:`string`, optional</span>
324<span class="sd">            Sets the mode for the output file. Default is &quot;w&quot;.</span>
325
326<span class="sd">        Return</span>
327<span class="sd">        ------</span>
328
329<span class="sd">        &#39;&#39;&#39;</span>
330        <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>
331            <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>
332
333        <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>
334        <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>
335
336        <span class="k">while</span> <span class="mi">1</span><span class="p">:</span>
337            <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>
338
339            <span class="k">if</span> <span class="n">gid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
340                <span class="k">break</span>
341
342            <span class="n">select</span> <span class="o">=</span> <span class="kc">True</span>
343            <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span>
344            <span class="k">for</span> <span class="n">wherekey</span> <span class="ow">in</span> <span class="n">wherekeynames</span><span class="p">:</span>
345                <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>
346                    <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>
347
348                <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>
349                                      <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>
350                <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
351
352            <span class="k">if</span> <span class="n">select</span><span class="p">:</span>
353                <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span>
354                <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keynames</span><span class="p">:</span>
355                    <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>
356                        <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>
357                    <span class="k">else</span><span class="p">:</span>
358                        <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>
359                    <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
360
361                <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>
362
363            <span class="n">codes_release</span><span class="p">(</span><span class="n">gid</span><span class="p">)</span>
364
365        <span class="n">fin</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
366        <span class="n">fout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
367
368        <span class="k">return</span></div>
369
370<div class="viewcode-block" id="GribUtil.copy_dummy_msg"><a class="viewcode-back" href="../api.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>
371                 <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>
372        <span class="sd">&#39;&#39;&#39;Add the content of another input grib file to the objects file but</span>
373<span class="sd">        only messages corresponding to keys/values passed to the function.</span>
374<span class="sd">        The selectWhere switch decides if to copy the keys equal to (True) or</span>
375<span class="sd">        different to (False) the keynames/keyvalues list passed to the function.</span>
376
377<span class="sd">        Parameters</span>
378<span class="sd">        ----------</span>
379<span class="sd">        filename_in : :obj:`string`</span>
380<span class="sd">            Filename of the input file to read the grib messages from.</span>
381
382<span class="sd">        selectWhere : :obj:`boolean`, optional</span>
383<span class="sd">            Decides if to copy the keynames and values equal to (True) or</span>
384<span class="sd">            different to (False) the keynames/keyvalues list passed to the</span>
385<span class="sd">            function. Default is True.</span>
386
387<span class="sd">        keynames : :obj:`list` of :obj:`string`, optional</span>
388<span class="sd">            List of keynames. Default is an empty list.</span>
389
390<span class="sd">        keyvalues : :obj:`list` of :obj:`string`, optional</span>
391<span class="sd">            List of keyvalues. Default is an empty list.</span>
392
393<span class="sd">        filemode : :obj:`string`, optional</span>
394<span class="sd">            Sets the mode for the output file. Default is &quot;w&quot;.</span>
395
396<span class="sd">        Return</span>
397<span class="sd">        ------</span>
398
399<span class="sd">        &#39;&#39;&#39;</span>
400        <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>
401            <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>
402
403        <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>
404        <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>
405
406        <span class="n">fields</span> <span class="o">=</span> <span class="mi">0</span>
407
408        <span class="k">while</span> <span class="n">fields</span> <span class="o">&lt;</span> <span class="mi">1</span><span class="p">:</span>
409            <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>
410
411            <span class="k">if</span> <span class="n">gid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
412                <span class="k">break</span>
413
414            <span class="n">select</span> <span class="o">=</span> <span class="kc">True</span>
415            <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span>
416            <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keynames</span><span class="p">:</span>
417                <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>
418                    <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>
419
420                <span class="k">if</span> <span class="n">selectWhere</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>
423                <span class="k">else</span><span class="p">:</span>
424                    <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>
425                                          <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>
426                <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
427
428            <span class="k">if</span> <span class="n">select</span><span class="p">:</span>
429                <span class="n">fields</span> <span class="o">=</span> <span class="n">fields</span> <span class="o">+</span> <span class="mi">1</span>
430                <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>
431
432            <span class="n">codes_release</span><span class="p">(</span><span class="n">gid</span><span class="p">)</span>
433
434        <span class="n">fin</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
435        <span class="n">fout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
436
437        <span class="k">return</span></div>
438
439<div class="viewcode-block" id="GribUtil.index"><a class="viewcode-back" href="../api.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>
440        <span class="sd">&#39;&#39;&#39;Create index file from a list of files if it does not exist or</span>
441<span class="sd">        read an index file.</span>
442
443<span class="sd">        Parameters</span>
444<span class="sd">        ----------</span>
445<span class="sd">        index_keys: :obj:`list` of :obj:`string`, optional</span>
446<span class="sd">            Contains the list of key parameter names from</span>
447<span class="sd">            which the index is to be created.</span>
448<span class="sd">            Default is a list with a single entry string &quot;mars&quot;.</span>
449
450<span class="sd">        index_file: :obj:`string`, optional</span>
451<span class="sd">            Filename where the indices are stored.</span>
452<span class="sd">            Default is &quot;my.idx&quot;.</span>
453
454<span class="sd">        Return</span>
455<span class="sd">        ------</span>
456<span class="sd">        iid: :obj:`integer`</span>
457<span class="sd">            Grib index id.</span>
458<span class="sd">        &#39;&#39;&#39;</span>
459        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;... index will be done&quot;</span><span class="p">)</span>
460        <span class="n">iid</span> <span class="o">=</span> <span class="kc">None</span>
461
462        <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>
463            <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>
464            <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>
465        <span class="k">else</span><span class="p">:</span>
466            <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>
467                <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>
468                <span class="k">if</span> <span class="n">iid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
469                    <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>
470                <span class="k">else</span><span class="p">:</span>
471                    <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>
472
473            <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>
474                <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>
475
476        <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;... index done&#39;</span><span class="p">)</span>
477
478        <span class="k">return</span> <span class="n">iid</span></div></div>
479</pre></div>
480
481           </div>
482           
483          </div>
484          <footer>
485 
486
487  <hr/>
488
489  <div role="contentinfo">
490    <p>
491        &copy; Copyright 2018, Anne Philipp and Leopold Haimberger.
492
493    </p>
494  </div>
495  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>.
496
497</footer>
498
499        </div>
500      </div>
501
502    </section>
503
504  </div>
505 
506
507
508 
509
510    <script type="text/javascript">
511        var DOCUMENTATION_OPTIONS = {
512            URL_ROOT:'../',
513            VERSION:'7.1 alpha',
514            LANGUAGE:'None',
515            COLLAPSE_INDEX:false,
516            FILE_SUFFIX:'.html',
517            HAS_SOURCE:  true,
518            SOURCELINK_SUFFIX: '.txt'
519        };
520    </script>
521      <script type="text/javascript" src="../_static/jquery.js"></script>
522      <script type="text/javascript" src="../_static/underscore.js"></script>
523      <script type="text/javascript" src="../_static/doctools.js"></script>
524      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
525
526 
527
528  <script type="text/javascript" src="../_static/js/theme.js"></script>
529
530  <script type="text/javascript">
531      jQuery(function () {
532          SphinxRtdTheme.Navigation.enable(true);
533      });
534  </script> 
535
536</body>
537</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG