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>GribTools — 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> »</li> |
---|
135 | |
---|
136 | <li><a href="index.html">Module code</a> »</li> |
---|
137 | |
---|
138 | <li>GribTools</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 GribTools</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</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 | <span class="kn">from</span> <span class="nn">gribapi</span> <span class="k">import</span> <span class="n">grib_new_from_file</span><span class="p">,</span> <span class="n">grib_is_defined</span><span class="p">,</span> <span class="n">grib_get</span><span class="p">,</span> \ |
---|
200 | <span class="n">grib_release</span><span class="p">,</span> <span class="n">grib_set</span><span class="p">,</span> <span class="n">grib_write</span><span class="p">,</span> <span class="n">grib_index_read</span><span class="p">,</span> \ |
---|
201 | <span class="n">grib_index_new_from_file</span><span class="p">,</span> <span class="n">grib_index_add_file</span><span class="p">,</span> \ |
---|
202 | <span class="n">grib_index_write</span> |
---|
203 | |
---|
204 | |
---|
205 | <span class="c1"># from eccodes import (codes_grib_new_from_file, codes_is_defined, codes_get,</span> |
---|
206 | <span class="c1"># codes_release, codes_set, codes_write, codes_index_read,</span> |
---|
207 | <span class="c1"># codes_index_new_from_file, codes_index_add_file,</span> |
---|
208 | <span class="c1"># codes_index_write)</span> |
---|
209 | |
---|
210 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
211 | <span class="c1"># CLASS</span> |
---|
212 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
213 | <div class="viewcode-block" id="GribTools"><a class="viewcode-back" href="../api.html#GribTools.GribTools">[docs]</a><span class="k">class</span> <span class="nc">GribTools</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
---|
214 | <span class="sd">'''</span> |
---|
215 | <span class="sd"> Class for GRIB utilities (new methods) based on GRIB API</span> |
---|
216 | <span class="sd"> '''</span> |
---|
217 | <span class="c1"># --------------------------------------------------------------------------</span> |
---|
218 | <span class="c1"># CLASS FUNCTIONS</span> |
---|
219 | <span class="c1"># --------------------------------------------------------------------------</span> |
---|
220 | <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> |
---|
221 | <span class="sd">'''Initialise an object of GribTools and assign a list of filenames.</span> |
---|
222 | |
---|
223 | <span class="sd"> Parameters</span> |
---|
224 | <span class="sd"> ----------</span> |
---|
225 | <span class="sd"> filenames : :obj:`list` of :obj:`strings`</span> |
---|
226 | <span class="sd"> A list of filenames.</span> |
---|
227 | |
---|
228 | <span class="sd"> Return</span> |
---|
229 | <span class="sd"> ------</span> |
---|
230 | |
---|
231 | <span class="sd"> '''</span> |
---|
232 | |
---|
233 | <span class="bp">self</span><span class="o">.</span><span class="n">filenames</span> <span class="o">=</span> <span class="n">filenames</span> |
---|
234 | |
---|
235 | <span class="k">return</span> |
---|
236 | |
---|
237 | |
---|
238 | <div class="viewcode-block" id="GribTools.get_keys"><a class="viewcode-back" href="../api.html#GribTools.GribTools.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> |
---|
239 | <span class="sd">'''Get keyvalues for a given list of keynames a where statement</span> |
---|
240 | <span class="sd"> can be given (list of key and list of values)</span> |
---|
241 | |
---|
242 | <span class="sd"> Parameters</span> |
---|
243 | <span class="sd"> ----------</span> |
---|
244 | <span class="sd"> keynames : :obj:`list` of :obj:`string`</span> |
---|
245 | <span class="sd"> List of keynames.</span> |
---|
246 | |
---|
247 | <span class="sd"> wherekeynames : :obj:`list` of :obj:`string`, optional</span> |
---|
248 | <span class="sd"> Default value is an empty list.</span> |
---|
249 | |
---|
250 | <span class="sd"> wherekeyvalues : :obj:`list` of :obj:`string`, optional</span> |
---|
251 | <span class="sd"> Default value is an empty list.</span> |
---|
252 | |
---|
253 | <span class="sd"> Return</span> |
---|
254 | <span class="sd"> ------</span> |
---|
255 | <span class="sd"> return_list : :obj:`list` of :obj:`string`</span> |
---|
256 | <span class="sd"> List of keyvalues for given keynames.</span> |
---|
257 | <span class="sd"> '''</span> |
---|
258 | |
---|
259 | <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">'r'</span><span class="p">)</span> |
---|
260 | |
---|
261 | <span class="n">return_list</span> <span class="o">=</span> <span class="p">[]</span> |
---|
262 | |
---|
263 | <span class="k">while</span> <span class="mi">1</span><span class="p">:</span> |
---|
264 | <span class="n">gid</span> <span class="o">=</span> <span class="n">grib_new_from_file</span><span class="p">(</span><span class="n">fileid</span><span class="p">)</span> |
---|
265 | |
---|
266 | <span class="k">if</span> <span class="n">gid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
---|
267 | <span class="k">break</span> |
---|
268 | |
---|
269 | <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> |
---|
270 | <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> |
---|
271 | <span class="s2"> the same. Give a value for each keyname!"</span><span class="p">)</span> |
---|
272 | |
---|
273 | <span class="n">select</span> <span class="o">=</span> <span class="kc">True</span> |
---|
274 | <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span> |
---|
275 | <span class="k">for</span> <span class="n">wherekey</span> <span class="ow">in</span> <span class="n">wherekeynames</span><span class="p">:</span> |
---|
276 | <span class="k">if</span> <span class="ow">not</span> <span class="n">grib_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> |
---|
277 | <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> |
---|
278 | |
---|
279 | <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> |
---|
280 | <span class="nb">str</span><span class="p">(</span><span class="n">grib_get</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">wherekey</span><span class="p">))))</span> |
---|
281 | <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> |
---|
282 | |
---|
283 | <span class="k">if</span> <span class="n">select</span><span class="p">:</span> |
---|
284 | <span class="n">llist</span> <span class="o">=</span> <span class="p">[]</span> |
---|
285 | <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keynames</span><span class="p">:</span> |
---|
286 | <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">grib_get</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">key</span><span class="p">))])</span> |
---|
287 | <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> |
---|
288 | |
---|
289 | <span class="n">grib_release</span><span class="p">(</span><span class="n">gid</span><span class="p">)</span> |
---|
290 | |
---|
291 | <span class="n">fileid</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
---|
292 | |
---|
293 | <span class="k">return</span> <span class="n">return_list</span></div> |
---|
294 | |
---|
295 | |
---|
296 | <div class="viewcode-block" id="GribTools.set_keys"><a class="viewcode-back" href="../api.html#GribTools.GribTools.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> |
---|
297 | <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">'w'</span><span class="p">):</span> |
---|
298 | <span class="sd">'''Opens the file to read the grib messages and then write</span> |
---|
299 | <span class="sd"> them to a new output file. By default all messages are</span> |
---|
300 | <span class="sd"> written out. Also, the keyvalues of the passed list of</span> |
---|
301 | <span class="sd"> keynames are set or only those meeting the where statement.</span> |
---|
302 | <span class="sd"> (list of key and list of values).</span> |
---|
303 | |
---|
304 | <span class="sd"> Parameters</span> |
---|
305 | <span class="sd"> ----------</span> |
---|
306 | <span class="sd"> fromfile : :obj:`string`</span> |
---|
307 | <span class="sd"> Filename of the input file to read the grib messages from.</span> |
---|
308 | |
---|
309 | <span class="sd"> keynames : :obj:`list` of :obj:`string`</span> |
---|
310 | <span class="sd"> List of keynames. Default is an empty list.</span> |
---|
311 | |
---|
312 | <span class="sd"> keyvalues : :obj:`list` of :obj:`string`</span> |
---|
313 | <span class="sd"> List of keynames. Default is an empty list.</span> |
---|
314 | |
---|
315 | <span class="sd"> wherekeynames : :obj:`list` of :obj:`string`, optional</span> |
---|
316 | <span class="sd"> Default value is an empty list.</span> |
---|
317 | |
---|
318 | <span class="sd"> wherekeyvalues : :obj:`list` of :obj:`string`, optional</span> |
---|
319 | <span class="sd"> Default value is an empty list.</span> |
---|
320 | |
---|
321 | <span class="sd"> strict : :obj:`boolean`, optional</span> |
---|
322 | <span class="sd"> Decides if everything from keynames and keyvalues</span> |
---|
323 | <span class="sd"> is written out the grib file (False) or only those</span> |
---|
324 | <span class="sd"> meeting the where statement (True). Default is False.</span> |
---|
325 | |
---|
326 | <span class="sd"> filemode : :obj:`string`, optional</span> |
---|
327 | <span class="sd"> Sets the mode for the output file. Default is "w".</span> |
---|
328 | |
---|
329 | <span class="sd"> Return</span> |
---|
330 | <span class="sd"> ------</span> |
---|
331 | |
---|
332 | <span class="sd"> '''</span> |
---|
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">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="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">"Give a value for each keyname!"</span><span class="p">)</span> |
---|
344 | |
---|
345 | <span class="n">select</span> <span class="o">=</span> <span class="kc">True</span> |
---|
346 | <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span> |
---|
347 | <span class="k">for</span> <span class="n">wherekey</span> <span class="ow">in</span> <span class="n">wherekeynames</span><span class="p">:</span> |
---|
348 | <span class="k">if</span> <span class="ow">not</span> <span class="n">grib_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> |
---|
349 | <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> |
---|
350 | |
---|
351 | <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> |
---|
352 | <span class="nb">str</span><span class="p">(</span><span class="n">grib_get</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">wherekey</span><span class="p">))))</span> |
---|
353 | <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> |
---|
354 | |
---|
355 | <span class="k">if</span> <span class="n">select</span><span class="p">:</span> |
---|
356 | <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span> |
---|
357 | <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keynames</span><span class="p">:</span> |
---|
358 | <span class="n">grib_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">grib_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">grib_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="GribTools.copy"><a class="viewcode-back" href="../api.html#GribTools.GribTools.copy">[docs]</a> <span class="k">def</span> <span class="nf">copy</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">'w'</span><span class="p">):</span> |
---|
372 | <span class="sd">'''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 keynames. 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 "w".</span> |
---|
395 | |
---|
396 | <span class="sd"> Return</span> |
---|
397 | <span class="sd"> ------</span> |
---|
398 | |
---|
399 | <span class="sd"> '''</span> |
---|
400 | |
---|
401 | <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> |
---|
402 | <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> |
---|
403 | |
---|
404 | <span class="k">while</span> <span class="mi">1</span><span class="p">:</span> |
---|
405 | <span class="n">gid</span> <span class="o">=</span> <span class="n">grib_new_from_file</span><span class="p">(</span><span class="n">fin</span><span class="p">)</span> |
---|
406 | |
---|
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> |
---|
409 | |
---|
410 | <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> |
---|
411 | <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> |
---|
412 | |
---|
413 | <span class="n">select</span> <span class="o">=</span> <span class="kc">True</span> |
---|
414 | <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span> |
---|
415 | <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keynames</span><span class="p">:</span> |
---|
416 | <span class="k">if</span> <span class="ow">not</span> <span class="n">grib_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> |
---|
417 | <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> |
---|
418 | |
---|
419 | <span class="k">if</span> <span class="n">selectWhere</span><span class="p">:</span> |
---|
420 | <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> |
---|
421 | <span class="nb">str</span><span class="p">(</span><span class="n">grib_get</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">key</span><span class="p">))))</span> |
---|
422 | <span class="k">else</span><span class="p">:</span> |
---|
423 | <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> |
---|
424 | <span class="nb">str</span><span class="p">(</span><span class="n">grib_get</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">key</span><span class="p">))))</span> |
---|
425 | <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span> |
---|
426 | |
---|
427 | <span class="k">if</span> <span class="n">select</span><span class="p">:</span> |
---|
428 | <span class="n">grib_write</span><span class="p">(</span><span class="n">gid</span><span class="p">,</span> <span class="n">fout</span><span class="p">)</span> |
---|
429 | |
---|
430 | <span class="n">grib_release</span><span class="p">(</span><span class="n">gid</span><span class="p">)</span> |
---|
431 | |
---|
432 | <span class="n">fin</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
---|
433 | <span class="n">fout</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
---|
434 | |
---|
435 | <span class="k">return</span></div> |
---|
436 | |
---|
437 | <div class="viewcode-block" id="GribTools.index"><a class="viewcode-back" href="../api.html#GribTools.GribTools.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">"mars"</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> |
---|
438 | <span class="sd">'''Create index file from a list of files if it does not exist or</span> |
---|
439 | <span class="sd"> read an index file.</span> |
---|
440 | |
---|
441 | <span class="sd"> Parameters</span> |
---|
442 | <span class="sd"> ----------</span> |
---|
443 | <span class="sd"> index_keys: :obj:`list` of :obj:`string`, optional</span> |
---|
444 | <span class="sd"> Contains the list of key parameter names from</span> |
---|
445 | <span class="sd"> which the index is to be created.</span> |
---|
446 | <span class="sd"> Default is a list with a single entry string "mars".</span> |
---|
447 | |
---|
448 | <span class="sd"> index_file: :obj:`string`, optional</span> |
---|
449 | <span class="sd"> Filename where the indices are stored.</span> |
---|
450 | <span class="sd"> Default is "my.idx".</span> |
---|
451 | |
---|
452 | <span class="sd"> Return</span> |
---|
453 | <span class="sd"> ------</span> |
---|
454 | <span class="sd"> iid: :obj:`integer`</span> |
---|
455 | <span class="sd"> Grib index id.</span> |
---|
456 | <span class="sd"> '''</span> |
---|
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">grib_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">grib_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">grib_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">grib_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> |
---|
489 | © Copyright 2018, Anne Philipp and Leopold Haimberger. |
---|
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 | |
---|
507 | |
---|
508 | <script type="text/javascript"> |
---|
509 | var DOCUMENTATION_OPTIONS = { |
---|
510 | URL_ROOT:'../', |
---|
511 | VERSION:'7.1 alpha', |
---|
512 | LANGUAGE:'None', |
---|
513 | COLLAPSE_INDEX:false, |
---|
514 | FILE_SUFFIX:'.html', |
---|
515 | HAS_SOURCE: true, |
---|
516 | SOURCELINK_SUFFIX: '.txt' |
---|
517 | }; |
---|
518 | </script> |
---|
519 | <script type="text/javascript" src="../_static/jquery.js"></script> |
---|
520 | <script type="text/javascript" src="../_static/underscore.js"></script> |
---|
521 | <script type="text/javascript" src="../_static/doctools.js"></script> |
---|
522 | <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script> |
---|
523 | |
---|
524 | |
---|
525 | |
---|
526 | <script type="text/javascript" src="../_static/js/theme.js"></script> |
---|
527 | |
---|
528 | <script type="text/javascript"> |
---|
529 | jQuery(function () { |
---|
530 | SphinxRtdTheme.Navigation.enable(true); |
---|
531 | }); |
---|
532 | </script> |
---|
533 | |
---|
534 | </body> |
---|
535 | </html> |
---|