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>tools — 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> »</li> |
---|
144 | |
---|
145 | <li><a href="index.html">Module code</a> »</li> |
---|
146 | |
---|
147 | <li>tools</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 tools</h1><div class="highlight"><pre> |
---|
163 | <span></span><span class="ch">#!/usr/bin/env python3</span> |
---|
164 | <span class="c1"># -*- coding: utf-8 -*-</span> |
---|
165 | <span class="c1">#*******************************************************************************</span> |
---|
166 | <span class="c1"># @Author: Anne Philipp (University of Vienna)</span> |
---|
167 | <span class="c1">#</span> |
---|
168 | <span class="c1"># @Date: May 2018</span> |
---|
169 | <span class="c1">#</span> |
---|
170 | <span class="c1"># @Change History:</span> |
---|
171 | <span class="c1"># October 2014 - Anne Fouilloux (University of Oslo)</span> |
---|
172 | <span class="c1"># - created functions silent_remove and product (taken from ECMWF)</span> |
---|
173 | <span class="c1">#</span> |
---|
174 | <span class="c1"># November 2015 - Leopold Haimberger (University of Vienna)</span> |
---|
175 | <span class="c1"># - created functions: interpret_args_and_control, clean_up</span> |
---|
176 | <span class="c1"># my_error, normal_exit, init128, to_param_id</span> |
---|
177 | <span class="c1">#</span> |
---|
178 | <span class="c1"># April - December 2018 - Anne Philipp (University of Vienna):</span> |
---|
179 | <span class="c1"># - applied PEP8 style guide</span> |
---|
180 | <span class="c1"># - added documentation</span> |
---|
181 | <span class="c1"># - moved all non class methods from former file Flexparttools in here</span> |
---|
182 | <span class="c1"># - seperated args and control interpretation</span> |
---|
183 | <span class="c1"># - added functions get_list_as_string, read_ecenv, send_mail, make_dir,</span> |
---|
184 | <span class="c1"># put_file_to_ecserver, submit_job_to_ecserver, get_informations,</span> |
---|
185 | <span class="c1"># get_dimensions, execute_subprocess, none_or_int, none_or_str</span> |
---|
186 | <span class="c1">#</span> |
---|
187 | <span class="c1"># @License:</span> |
---|
188 | <span class="c1"># (C) Copyright 2014-2019.</span> |
---|
189 | <span class="c1"># Anne Philipp, Leopold Haimberger</span> |
---|
190 | <span class="c1">#</span> |
---|
191 | <span class="c1"># SPDX-License-Identifier: CC-BY-4.0</span> |
---|
192 | <span class="c1">#</span> |
---|
193 | <span class="c1"># This work is licensed under the Creative Commons Attribution 4.0</span> |
---|
194 | <span class="c1"># International License. To view a copy of this license, visit</span> |
---|
195 | <span class="c1"># http://creativecommons.org/licenses/by/4.0/ or send a letter to</span> |
---|
196 | <span class="c1"># Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</span> |
---|
197 | <span class="c1">#</span> |
---|
198 | <span class="c1"># @Methods:</span> |
---|
199 | <span class="c1"># none_or_str</span> |
---|
200 | <span class="c1"># none_or_int</span> |
---|
201 | <span class="c1"># get_cmdline_args</span> |
---|
202 | <span class="c1"># read_ecenv</span> |
---|
203 | <span class="c1"># clean_up</span> |
---|
204 | <span class="c1"># my_error</span> |
---|
205 | <span class="c1"># send_mail</span> |
---|
206 | <span class="c1"># normal_exit</span> |
---|
207 | <span class="c1"># product</span> |
---|
208 | <span class="c1"># silent_remove</span> |
---|
209 | <span class="c1"># init128</span> |
---|
210 | <span class="c1"># to_param_id</span> |
---|
211 | <span class="c1"># get_list_as_string</span> |
---|
212 | <span class="c1"># make_dir</span> |
---|
213 | <span class="c1"># put_file_to_ecserver</span> |
---|
214 | <span class="c1"># submit_job_to_ecserver</span> |
---|
215 | <span class="c1"># get_informations</span> |
---|
216 | <span class="c1"># get_dimensions</span> |
---|
217 | <span class="c1"># execute_subprocess</span> |
---|
218 | <span class="c1">#*******************************************************************************</span> |
---|
219 | <span class="sd">'''This module contains a collection of diverse tasks within flex_extract.</span> |
---|
220 | <span class="sd">'''</span> |
---|
221 | |
---|
222 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
223 | <span class="c1"># MODULES</span> |
---|
224 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
225 | <span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span> |
---|
226 | |
---|
227 | <span class="kn">import</span> <span class="nn">os</span> |
---|
228 | <span class="kn">import</span> <span class="nn">errno</span> |
---|
229 | <span class="kn">import</span> <span class="nn">sys</span> |
---|
230 | <span class="kn">import</span> <span class="nn">glob</span> |
---|
231 | <span class="kn">import</span> <span class="nn">subprocess</span> |
---|
232 | <span class="kn">import</span> <span class="nn">traceback</span> |
---|
233 | <span class="k">try</span><span class="p">:</span> |
---|
234 | <span class="kn">import</span> <span class="nn">exceptions</span> |
---|
235 | <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> |
---|
236 | <span class="kn">import</span> <span class="nn">builtins</span> <span class="k">as</span> <span class="nn">exceptions</span> |
---|
237 | <span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timedelta</span> |
---|
238 | <span class="kn">from</span> <span class="nn">argparse</span> <span class="k">import</span> <span class="n">ArgumentParser</span><span class="p">,</span> <span class="n">ArgumentDefaultsHelpFormatter</span> |
---|
239 | |
---|
240 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
241 | <span class="c1"># METHODS</span> |
---|
242 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
243 | |
---|
244 | <div class="viewcode-block" id="setup_controldata"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.setup_controldata">[docs]</a><span class="k">def</span> <span class="nf">setup_controldata</span><span class="p">():</span> |
---|
245 | <span class="sd">'''Collects, stores and checks controlling arguments from command line,</span> |
---|
246 | <span class="sd"> CONTROL file and ECMWF_ENV file.</span> |
---|
247 | |
---|
248 | <span class="sd"> Parameters</span> |
---|
249 | <span class="sd"> ----------</span> |
---|
250 | |
---|
251 | <span class="sd"> Return</span> |
---|
252 | <span class="sd"> ------</span> |
---|
253 | <span class="sd"> c : ControlFile</span> |
---|
254 | <span class="sd"> Contains all the parameters of CONTROL file and</span> |
---|
255 | <span class="sd"> command line.</span> |
---|
256 | |
---|
257 | <span class="sd"> ppid : str</span> |
---|
258 | <span class="sd"> Parent process id.</span> |
---|
259 | |
---|
260 | <span class="sd"> queue : str</span> |
---|
261 | <span class="sd"> Name of queue for submission to ECMWF (e.g. ecgate or cca )</span> |
---|
262 | |
---|
263 | <span class="sd"> job_template : str</span> |
---|
264 | <span class="sd"> Name of the job template file for submission to ECMWF server.</span> |
---|
265 | <span class="sd"> '''</span> |
---|
266 | <span class="kn">import</span> <span class="nn">_config</span> |
---|
267 | <span class="kn">from</span> <span class="nn">Classes.ControlFile</span> <span class="k">import</span> <span class="n">ControlFile</span> |
---|
268 | |
---|
269 | <span class="n">args</span> <span class="o">=</span> <span class="n">get_cmdline_args</span><span class="p">()</span> |
---|
270 | <span class="n">c</span> <span class="o">=</span> <span class="n">ControlFile</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">controlfile</span><span class="p">)</span> |
---|
271 | <span class="n">c</span><span class="o">.</span><span class="n">assign_args_to_control</span><span class="p">(</span><span class="n">args</span><span class="p">)</span> |
---|
272 | <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">isfile</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_ECMWF_ENV</span><span class="p">):</span> |
---|
273 | <span class="n">env_parameter</span> <span class="o">=</span> <span class="n">read_ecenv</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_ECMWF_ENV</span><span class="p">)</span> |
---|
274 | <span class="n">c</span><span class="o">.</span><span class="n">assign_envs_to_control</span><span class="p">(</span><span class="n">env_parameter</span><span class="p">)</span> |
---|
275 | <span class="n">c</span><span class="o">.</span><span class="n">check_conditions</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">queue</span><span class="p">)</span> |
---|
276 | |
---|
277 | <span class="k">return</span> <span class="n">c</span><span class="p">,</span> <span class="n">args</span><span class="o">.</span><span class="n">ppid</span><span class="p">,</span> <span class="n">args</span><span class="o">.</span><span class="n">queue</span><span class="p">,</span> <span class="n">args</span><span class="o">.</span><span class="n">job_template</span></div> |
---|
278 | |
---|
279 | <div class="viewcode-block" id="none_or_str"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.none_or_str">[docs]</a><span class="k">def</span> <span class="nf">none_or_str</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> |
---|
280 | <span class="sd">'''Converts the input string into pythons None-type if the string</span> |
---|
281 | <span class="sd"> contains string "None".</span> |
---|
282 | |
---|
283 | <span class="sd"> Parameters</span> |
---|
284 | <span class="sd"> ----------</span> |
---|
285 | <span class="sd"> value : str</span> |
---|
286 | <span class="sd"> String to be checked for the "None" word.</span> |
---|
287 | |
---|
288 | <span class="sd"> Return</span> |
---|
289 | <span class="sd"> ------</span> |
---|
290 | <span class="sd"> None or value:</span> |
---|
291 | <span class="sd"> Return depends on the content of the input value. If it was "None",</span> |
---|
292 | <span class="sd"> then the python type None is returned. Otherwise the string itself.</span> |
---|
293 | <span class="sd"> '''</span> |
---|
294 | <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="s1">'None'</span><span class="p">:</span> |
---|
295 | <span class="k">return</span> <span class="kc">None</span> |
---|
296 | <span class="k">return</span> <span class="n">value</span></div> |
---|
297 | |
---|
298 | <div class="viewcode-block" id="none_or_int"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.none_or_int">[docs]</a><span class="k">def</span> <span class="nf">none_or_int</span><span class="p">(</span><span class="n">value</span><span class="p">):</span> |
---|
299 | <span class="sd">'''Converts the input string into pythons None-type if the string</span> |
---|
300 | <span class="sd"> contains string "None". Otherwise it is converted to an integer value.</span> |
---|
301 | |
---|
302 | <span class="sd"> Parameters</span> |
---|
303 | <span class="sd"> ----------</span> |
---|
304 | <span class="sd"> value : str</span> |
---|
305 | <span class="sd"> String to be checked for the "None" word.</span> |
---|
306 | |
---|
307 | <span class="sd"> Return</span> |
---|
308 | <span class="sd"> ------</span> |
---|
309 | <span class="sd"> None or int(value):</span> |
---|
310 | <span class="sd"> Return depends on the content of the input value. If it was "None",</span> |
---|
311 | <span class="sd"> then the python type None is returned. Otherwise the string is</span> |
---|
312 | <span class="sd"> converted into an integer value.</span> |
---|
313 | <span class="sd"> '''</span> |
---|
314 | <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="s1">'None'</span><span class="p">:</span> |
---|
315 | <span class="k">return</span> <span class="kc">None</span> |
---|
316 | <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span></div> |
---|
317 | |
---|
318 | <div class="viewcode-block" id="get_cmdline_args"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.get_cmdline_args">[docs]</a><span class="k">def</span> <span class="nf">get_cmdline_args</span><span class="p">():</span> |
---|
319 | <span class="sd">'''Decomposes the command line arguments and assigns them to variables.</span> |
---|
320 | <span class="sd"> Apply default values for non mentioned arguments.</span> |
---|
321 | |
---|
322 | <span class="sd"> Parameters</span> |
---|
323 | <span class="sd"> ----------</span> |
---|
324 | |
---|
325 | <span class="sd"> Return</span> |
---|
326 | <span class="sd"> ------</span> |
---|
327 | <span class="sd"> args : Namespace</span> |
---|
328 | <span class="sd"> Contains the commandline arguments from script/program call.</span> |
---|
329 | <span class="sd"> '''</span> |
---|
330 | |
---|
331 | <span class="n">parser</span> <span class="o">=</span> <span class="n">ArgumentParser</span><span class="p">(</span><span class="n">description</span><span class="o">=</span><span class="s1">'Retrieve FLEXPART input from </span><span class="se">\</span> |
---|
332 | <span class="s1"> ECMWF MARS archive'</span><span class="p">,</span> |
---|
333 | <span class="n">formatter_class</span><span class="o">=</span><span class="n">ArgumentDefaultsHelpFormatter</span><span class="p">)</span> |
---|
334 | |
---|
335 | <span class="c1"># control parameters that override control file values</span> |
---|
336 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--start_date"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"start_date"</span><span class="p">,</span> |
---|
337 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
338 | <span class="n">help</span><span class="o">=</span><span class="s2">"start date YYYYMMDD"</span><span class="p">)</span> |
---|
339 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--end_date"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"end_date"</span><span class="p">,</span> |
---|
340 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
341 | <span class="n">help</span><span class="o">=</span><span class="s2">"end_date YYYYMMDD"</span><span class="p">)</span> |
---|
342 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--date_chunk"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"date_chunk"</span><span class="p">,</span> |
---|
343 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
344 | <span class="n">help</span><span class="o">=</span><span class="s2">"# of days to be retrieved at once"</span><span class="p">)</span> |
---|
345 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--job_chunk"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"job_chunk"</span><span class="p">,</span> |
---|
346 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
347 | <span class="n">help</span><span class="o">=</span><span class="s2">"# of days to be retrieved within a single job"</span><span class="p">)</span> |
---|
348 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--controlfile"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"controlfile"</span><span class="p">,</span> |
---|
349 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">'CONTROL_EA5'</span><span class="p">,</span> |
---|
350 | <span class="n">help</span><span class="o">=</span><span class="s2">"The file with all CONTROL parameters."</span><span class="p">)</span> |
---|
351 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--basetime"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"basetime"</span><span class="p">,</span> |
---|
352 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
353 | <span class="n">help</span><span class="o">=</span><span class="s2">"base such as 0 or 12 (for half day retrievals)"</span><span class="p">)</span> |
---|
354 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--step"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"step"</span><span class="p">,</span> |
---|
355 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
356 | <span class="n">help</span><span class="o">=</span><span class="s2">"Forecast steps such as 00/to/48"</span><span class="p">)</span> |
---|
357 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--levelist"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"levelist"</span><span class="p">,</span> |
---|
358 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
359 | <span class="n">help</span><span class="o">=</span><span class="s2">"Vertical levels to be retrieved, e.g. 30/to/60"</span><span class="p">)</span> |
---|
360 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--area"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"area"</span><span class="p">,</span> |
---|
361 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
362 | <span class="n">help</span><span class="o">=</span><span class="s2">"area defined as north/west/south/east"</span><span class="p">)</span> |
---|
363 | |
---|
364 | <span class="c1"># some switches</span> |
---|
365 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--debug"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"debug"</span><span class="p">,</span> |
---|
366 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
367 | <span class="n">help</span><span class="o">=</span><span class="s2">"debug mode - leave temporary files intact"</span><span class="p">)</span> |
---|
368 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--oper"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"oper"</span><span class="p">,</span> |
---|
369 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
370 | <span class="n">help</span><span class="o">=</span><span class="s1">'operational mode - prepares dates with '</span> |
---|
371 | <span class="s1">'environment variables'</span><span class="p">)</span> |
---|
372 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--request"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"request"</span><span class="p">,</span> |
---|
373 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
374 | <span class="n">help</span><span class="o">=</span><span class="s2">"list all mars requests in file mars_requests.dat"</span><span class="p">)</span> |
---|
375 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--public"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"public"</span><span class="p">,</span> |
---|
376 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
377 | <span class="n">help</span><span class="o">=</span><span class="s2">"public mode - retrieves the public datasets"</span><span class="p">)</span> |
---|
378 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--rrint"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"rrint"</span><span class="p">,</span> |
---|
379 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_int</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
380 | <span class="n">help</span><span class="o">=</span><span class="s1">'Selection of old or new precipitation '</span> |
---|
381 | <span class="s1">'interpolation:</span><span class="se">\n</span><span class="s1">'</span> |
---|
382 | <span class="s1">' 0 - old method</span><span class="se">\n</span><span class="s1">'</span> |
---|
383 | <span class="s1">' 1 - new method (additional subgrid points)'</span><span class="p">)</span> |
---|
384 | |
---|
385 | <span class="c1"># set directories</span> |
---|
386 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--inputdir"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"inputdir"</span><span class="p">,</span> |
---|
387 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
388 | <span class="n">help</span><span class="o">=</span><span class="s1">'Path to the temporary directory for the '</span> |
---|
389 | <span class="s1">'retrieval grib files and other processing files.'</span><span class="p">)</span> |
---|
390 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--outputdir"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"outputdir"</span><span class="p">,</span> |
---|
391 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
392 | <span class="n">help</span><span class="o">=</span><span class="s1">'Path to the final directory where the final '</span> |
---|
393 | <span class="s1">'FLEXPART ready input files are stored.'</span><span class="p">)</span> |
---|
394 | |
---|
395 | <span class="c1"># this is only used by prepare_flexpart.py to rerun a postprocessing step</span> |
---|
396 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--ppid"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"ppid"</span><span class="p">,</span> |
---|
397 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
398 | <span class="n">help</span><span class="o">=</span><span class="s1">'This is the specify parent process id of a '</span> |
---|
399 | <span class="s1">'single flex_extract run to identify the files. '</span> |
---|
400 | <span class="s1">'It is the second number in the GRIB files.'</span><span class="p">)</span> |
---|
401 | |
---|
402 | <span class="c1"># arguments for job submission to ECMWF, only needed by submit.py</span> |
---|
403 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--job_template"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s1">'job_template'</span><span class="p">,</span> |
---|
404 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">"job.temp"</span><span class="p">,</span> |
---|
405 | <span class="n">help</span><span class="o">=</span><span class="s1">'The job template file which are adapted to be '</span> |
---|
406 | <span class="s1">'submitted to the batch system on ECMWF server.'</span><span class="p">)</span> |
---|
407 | <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--queue"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"queue"</span><span class="p">,</span> |
---|
408 | <span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
---|
409 | <span class="n">help</span><span class="o">=</span><span class="s1">'The ECMWF server name for submission of the '</span> |
---|
410 | <span class="s1">'job script to the batch system '</span> |
---|
411 | <span class="s1">'(e.g. ecgate | cca | ccb)'</span><span class="p">)</span> |
---|
412 | |
---|
413 | <span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()</span> |
---|
414 | |
---|
415 | <span class="k">return</span> <span class="n">args</span></div> |
---|
416 | |
---|
417 | <div class="viewcode-block" id="read_ecenv"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.read_ecenv">[docs]</a><span class="k">def</span> <span class="nf">read_ecenv</span><span class="p">(</span><span class="n">filepath</span><span class="p">):</span> |
---|
418 | <span class="sd">'''Reads the file into a dictionary where the key values are the parameter</span> |
---|
419 | <span class="sd"> names.</span> |
---|
420 | |
---|
421 | <span class="sd"> Parameters</span> |
---|
422 | <span class="sd"> ----------</span> |
---|
423 | <span class="sd"> filepath : str</span> |
---|
424 | <span class="sd"> Path to file where the ECMWF environment parameters are stored.</span> |
---|
425 | |
---|
426 | <span class="sd"> Return</span> |
---|
427 | <span class="sd"> ------</span> |
---|
428 | <span class="sd"> envs : dict</span> |
---|
429 | <span class="sd"> Contains the environment parameter ecuid, ecgid, gateway</span> |
---|
430 | <span class="sd"> and destination for ECMWF server environments.</span> |
---|
431 | <span class="sd"> '''</span> |
---|
432 | <span class="n">envs</span><span class="o">=</span> <span class="p">{}</span> |
---|
433 | <span class="k">try</span><span class="p">:</span> |
---|
434 | <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filepath</span><span class="p">,</span> <span class="s1">'r'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> |
---|
435 | <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">f</span><span class="p">:</span> |
---|
436 | <span class="n">data</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">()</span> |
---|
437 | <span class="n">envs</span><span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">])]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> |
---|
438 | <span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
439 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">errno</span><span class="p">))</span> |
---|
440 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">strerror</span><span class="p">))</span> |
---|
441 | |
---|
442 | <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... Error occured while trying to read ECMWF_ENV '</span> |
---|
443 | <span class="s1">'file: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">filepath</span><span class="p">))</span> |
---|
444 | |
---|
445 | <span class="k">return</span> <span class="n">envs</span></div> |
---|
446 | |
---|
447 | <div class="viewcode-block" id="clean_up"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.clean_up">[docs]</a><span class="k">def</span> <span class="nf">clean_up</span><span class="p">(</span><span class="n">c</span><span class="p">):</span> |
---|
448 | <span class="sd">'''Remove files from the intermediate directory (inputdir).</span> |
---|
449 | |
---|
450 | <span class="sd"> It keeps the final FLEXPART input files if program runs without</span> |
---|
451 | <span class="sd"> ECMWF Api and keywords "ectrans" or "ecstorage" are set to "1".</span> |
---|
452 | |
---|
453 | <span class="sd"> Parameters</span> |
---|
454 | <span class="sd"> ----------</span> |
---|
455 | <span class="sd"> c : ControlFile</span> |
---|
456 | <span class="sd"> Contains all the parameters of CONTROL file and</span> |
---|
457 | <span class="sd"> command line.</span> |
---|
458 | |
---|
459 | <span class="sd"> Return</span> |
---|
460 | <span class="sd"> ------</span> |
---|
461 | |
---|
462 | <span class="sd"> '''</span> |
---|
463 | |
---|
464 | <span class="nb">print</span><span class="p">(</span><span class="s2">"... clean inputdir!"</span><span class="p">)</span> |
---|
465 | |
---|
466 | <span class="n">cleanlist</span> <span class="o">=</span> <span class="p">[</span><span class="n">file</span> <span class="k">for</span> <span class="n">file</span> <span class="ow">in</span> <span class="n">glob</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">inputdir</span><span class="p">,</span> <span class="s2">"*"</span><span class="p">))</span> |
---|
467 | <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">file</span><span class="p">)</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">prefix</span><span class="p">)]</span> |
---|
468 | |
---|
469 | <span class="k">if</span> <span class="n">cleanlist</span><span class="p">:</span> |
---|
470 | <span class="k">for</span> <span class="n">element</span> <span class="ow">in</span> <span class="n">cleanlist</span><span class="p">:</span> |
---|
471 | <span class="n">silent_remove</span><span class="p">(</span><span class="n">element</span><span class="p">)</span> |
---|
472 | <span class="nb">print</span><span class="p">(</span><span class="s2">"... done!"</span><span class="p">)</span> |
---|
473 | <span class="k">else</span><span class="p">:</span> |
---|
474 | <span class="nb">print</span><span class="p">(</span><span class="s2">"... nothing to clean!"</span><span class="p">)</span> |
---|
475 | |
---|
476 | <span class="k">return</span></div> |
---|
477 | |
---|
478 | |
---|
479 | <div class="viewcode-block" id="my_error"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.my_error">[docs]</a><span class="k">def</span> <span class="nf">my_error</span><span class="p">(</span><span class="n">message</span><span class="o">=</span><span class="s1">'ERROR'</span><span class="p">):</span> |
---|
480 | <span class="sd">'''Prints a specified error message which can be passed to the function</span> |
---|
481 | <span class="sd"> before exiting the program.</span> |
---|
482 | |
---|
483 | <span class="sd"> Parameters</span> |
---|
484 | <span class="sd"> ----------</span> |
---|
485 | <span class="sd"> message : str, optional</span> |
---|
486 | <span class="sd"> Error message. Default value is "ERROR".</span> |
---|
487 | |
---|
488 | <span class="sd"> Return</span> |
---|
489 | <span class="sd"> ------</span> |
---|
490 | |
---|
491 | <span class="sd"> '''</span> |
---|
492 | |
---|
493 | <span class="n">trace</span> <span class="o">=</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">traceback</span><span class="o">.</span><span class="n">format_stack</span><span class="p">())</span> |
---|
494 | <span class="n">full_message</span> <span class="o">=</span> <span class="n">message</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n\n</span><span class="s1">'</span> <span class="o">+</span> <span class="n">trace</span> |
---|
495 | |
---|
496 | <span class="nb">print</span><span class="p">(</span><span class="n">full_message</span><span class="p">)</span> |
---|
497 | |
---|
498 | <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> |
---|
499 | |
---|
500 | <span class="k">return</span></div> |
---|
501 | |
---|
502 | |
---|
503 | <div class="viewcode-block" id="send_mail"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.send_mail">[docs]</a><span class="k">def</span> <span class="nf">send_mail</span><span class="p">(</span><span class="n">users</span><span class="p">,</span> <span class="n">success_mode</span><span class="p">,</span> <span class="n">message</span><span class="p">):</span> |
---|
504 | <span class="sd">'''Prints a specific exit message which can be passed to the function.</span> |
---|
505 | |
---|
506 | <span class="sd"> Parameters</span> |
---|
507 | <span class="sd"> ----------</span> |
---|
508 | <span class="sd"> users : list of str</span> |
---|
509 | <span class="sd"> Contains all email addresses which should be notified.</span> |
---|
510 | <span class="sd"> It might also contain just the ecmwf user name which wil trigger</span> |
---|
511 | <span class="sd"> mailing to the associated email address for this user.</span> |
---|
512 | |
---|
513 | <span class="sd"> success_mode : str</span> |
---|
514 | <span class="sd"> States the exit mode of the program to put into</span> |
---|
515 | <span class="sd"> the mail subject line.</span> |
---|
516 | |
---|
517 | <span class="sd"> message : str, optional</span> |
---|
518 | <span class="sd"> Message for exiting program. Default value is "Done!".</span> |
---|
519 | |
---|
520 | <span class="sd"> Return</span> |
---|
521 | <span class="sd"> ------</span> |
---|
522 | |
---|
523 | <span class="sd"> '''</span> |
---|
524 | |
---|
525 | <span class="k">for</span> <span class="n">user</span> <span class="ow">in</span> <span class="n">users</span><span class="p">:</span> |
---|
526 | <span class="k">if</span> <span class="s1">'$</span><span class="si">{USER}</span><span class="s1">'</span> <span class="ow">in</span> <span class="n">user</span><span class="p">:</span> |
---|
527 | <span class="n">user</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s1">'USER'</span><span class="p">)</span> |
---|
528 | <span class="k">try</span><span class="p">:</span> |
---|
529 | <span class="n">p</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">([</span><span class="s1">'mail'</span><span class="p">,</span> <span class="s1">'-s flex_extract_v7.1 '</span> <span class="o">+</span> |
---|
530 | <span class="n">success_mode</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expandvars</span><span class="p">(</span><span class="n">user</span><span class="p">)],</span> |
---|
531 | <span class="n">stdin</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span> |
---|
532 | <span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span> |
---|
533 | <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span> |
---|
534 | <span class="n">bufsize</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> |
---|
535 | <span class="n">pout</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">communicate</span><span class="p">(</span><span class="nb">input</span><span class="o">=</span><span class="n">message</span><span class="o">.</span><span class="n">encode</span><span class="p">()</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n\n</span><span class="s1">'</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> |
---|
536 | <span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
537 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span> |
---|
538 | <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'... Email could not be sent!'</span><span class="p">)</span> |
---|
539 | <span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
540 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">errno</span><span class="p">))</span> |
---|
541 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">strerror</span><span class="p">))</span> |
---|
542 | <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'... Email could not be sent!'</span><span class="p">)</span> |
---|
543 | <span class="k">else</span><span class="p">:</span> |
---|
544 | <span class="nb">print</span><span class="p">(</span><span class="s1">'Email sent to '</span> <span class="o">+</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expandvars</span><span class="p">(</span><span class="n">user</span><span class="p">))</span> |
---|
545 | |
---|
546 | <span class="k">return</span></div> |
---|
547 | |
---|
548 | |
---|
549 | <div class="viewcode-block" id="normal_exit"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.normal_exit">[docs]</a><span class="k">def</span> <span class="nf">normal_exit</span><span class="p">(</span><span class="n">message</span><span class="o">=</span><span class="s1">'Done!'</span><span class="p">):</span> |
---|
550 | <span class="sd">'''Prints a specific exit message which can be passed to the function.</span> |
---|
551 | |
---|
552 | <span class="sd"> Parameters</span> |
---|
553 | <span class="sd"> ----------</span> |
---|
554 | <span class="sd"> message : str, optional</span> |
---|
555 | <span class="sd"> Message for exiting program. Default value is "Done!".</span> |
---|
556 | |
---|
557 | <span class="sd"> Return</span> |
---|
558 | <span class="sd"> ------</span> |
---|
559 | |
---|
560 | <span class="sd"> '''</span> |
---|
561 | |
---|
562 | <span class="nb">print</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">message</span><span class="p">))</span> |
---|
563 | |
---|
564 | <span class="k">return</span></div> |
---|
565 | |
---|
566 | |
---|
567 | <div class="viewcode-block" id="product"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.product">[docs]</a><span class="k">def</span> <span class="nf">product</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwds</span><span class="p">):</span> |
---|
568 | <span class="sd">'''Creates combinations of all passed arguments.</span> |
---|
569 | |
---|
570 | <span class="sd"> This method combines the single characters of the passed arguments</span> |
---|
571 | <span class="sd"> with each other. So that each character of each argument value</span> |
---|
572 | <span class="sd"> will be combined with each character of the other arguments as a tuple.</span> |
---|
573 | |
---|
574 | <span class="sd"> Note</span> |
---|
575 | <span class="sd"> ----</span> |
---|
576 | <span class="sd"> This method is taken from an example at the ECMWF wiki website.</span> |
---|
577 | <span class="sd"> https://software.ecmwf.int/wiki/display/GRIB/index.py; 2018-03-16</span> |
---|
578 | |
---|
579 | <span class="sd"> Example</span> |
---|
580 | <span class="sd"> -------</span> |
---|
581 | <span class="sd"> product('ABCD', 'xy') --> Ax Ay Bx By Cx Cy Dx Dy</span> |
---|
582 | |
---|
583 | <span class="sd"> product(range(2), repeat = 3) --> 000 001 010 011 100 101 110 111</span> |
---|
584 | |
---|
585 | <span class="sd"> Parameters</span> |
---|
586 | <span class="sd"> ----------</span> |
---|
587 | <span class="sd"> \*args : list or str</span> |
---|
588 | <span class="sd"> Positional arguments (arbitrary number).</span> |
---|
589 | |
---|
590 | <span class="sd"> \*\*kwds : dict</span> |
---|
591 | <span class="sd"> Contains all the keyword arguments from \*args.</span> |
---|
592 | |
---|
593 | <span class="sd"> Return</span> |
---|
594 | <span class="sd"> ------</span> |
---|
595 | <span class="sd"> prod : :obj:`tuple`</span> |
---|
596 | <span class="sd"> Return will be done with "yield". A tuple of combined arguments.</span> |
---|
597 | <span class="sd"> See example in description above.</span> |
---|
598 | <span class="sd"> '''</span> |
---|
599 | <span class="k">try</span><span class="p">:</span> |
---|
600 | <span class="n">pools</span> <span class="o">=</span> <span class="p">[</span><span class="nb">tuple</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">args</span><span class="p">]</span> <span class="o">*</span> <span class="n">kwds</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'repeat'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> |
---|
601 | <span class="n">result</span> <span class="o">=</span> <span class="p">[[]]</span> |
---|
602 | <span class="k">for</span> <span class="n">pool</span> <span class="ow">in</span> <span class="n">pools</span><span class="p">:</span> |
---|
603 | <span class="n">result</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span> <span class="o">+</span> <span class="p">[</span><span class="n">y</span><span class="p">]</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">result</span> <span class="k">for</span> <span class="n">y</span> <span class="ow">in</span> <span class="n">pool</span><span class="p">]</span> |
---|
604 | <span class="k">for</span> <span class="n">prod</span> <span class="ow">in</span> <span class="n">result</span><span class="p">:</span> |
---|
605 | <span class="k">yield</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">prod</span><span class="p">)</span> |
---|
606 | <span class="k">except</span> <span class="ne">TypeError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
607 | <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'... PRODUCT GENERATION FAILED!'</span><span class="p">)</span> |
---|
608 | |
---|
609 | <span class="k">return</span></div> |
---|
610 | |
---|
611 | |
---|
612 | <div class="viewcode-block" id="silent_remove"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.silent_remove">[docs]</a><span class="k">def</span> <span class="nf">silent_remove</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span> |
---|
613 | <span class="sd">'''Remove file if it exists.</span> |
---|
614 | <span class="sd"> The function does not fail if the file does not exist.</span> |
---|
615 | |
---|
616 | <span class="sd"> Parameters</span> |
---|
617 | <span class="sd"> ----------</span> |
---|
618 | <span class="sd"> filename : str</span> |
---|
619 | <span class="sd"> The name of the file to be removed without notification.</span> |
---|
620 | |
---|
621 | <span class="sd"> Return</span> |
---|
622 | <span class="sd"> ------</span> |
---|
623 | |
---|
624 | <span class="sd"> '''</span> |
---|
625 | <span class="k">try</span><span class="p">:</span> |
---|
626 | <span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> |
---|
627 | <span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
628 | <span class="c1"># errno.ENOENT = no such file or directory</span> |
---|
629 | <span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="o">==</span> <span class="n">errno</span><span class="o">.</span><span class="n">ENOENT</span><span class="p">:</span> |
---|
630 | <span class="k">pass</span> |
---|
631 | <span class="k">else</span><span class="p">:</span> |
---|
632 | <span class="k">raise</span> <span class="c1"># re-raise exception if a different error occured</span> |
---|
633 | |
---|
634 | <span class="k">return</span></div> |
---|
635 | |
---|
636 | |
---|
637 | <div class="viewcode-block" id="init128"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.init128">[docs]</a><span class="k">def</span> <span class="nf">init128</span><span class="p">(</span><span class="n">filepath</span><span class="p">):</span> |
---|
638 | <span class="sd">'''Opens and reads the grib file with table 128 information.</span> |
---|
639 | |
---|
640 | <span class="sd"> Parameters</span> |
---|
641 | <span class="sd"> ----------</span> |
---|
642 | <span class="sd"> filepath : str</span> |
---|
643 | <span class="sd"> Path to file of ECMWF grib table number 128.</span> |
---|
644 | |
---|
645 | <span class="sd"> Return</span> |
---|
646 | <span class="sd"> ------</span> |
---|
647 | <span class="sd"> table128 : dict</span> |
---|
648 | <span class="sd"> Contains the ECMWF grib table 128 information.</span> |
---|
649 | <span class="sd"> The key is the parameter number and the value is the</span> |
---|
650 | <span class="sd"> short name of the parameter.</span> |
---|
651 | <span class="sd"> '''</span> |
---|
652 | <span class="n">table128</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span> |
---|
653 | <span class="k">try</span><span class="p">:</span> |
---|
654 | <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filepath</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> |
---|
655 | <span class="n">fdata</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span> |
---|
656 | <span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
657 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">errno</span><span class="p">))</span> |
---|
658 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">strerror</span><span class="p">))</span> |
---|
659 | |
---|
660 | <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... Error occured while trying to read parameter '</span> |
---|
661 | <span class="s1">'table file: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">filepath</span><span class="p">))</span> |
---|
662 | <span class="k">else</span><span class="p">:</span> |
---|
663 | <span class="k">for</span> <span class="n">data</span> <span class="ow">in</span> <span class="n">fdata</span><span class="p">:</span> |
---|
664 | <span class="k">if</span> <span class="n">data</span> <span class="o">!=</span> <span class="s1">''</span> <span class="ow">and</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">'!'</span><span class="p">:</span> |
---|
665 | <span class="n">table128</span><span class="p">[</span><span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="mi">3</span><span class="p">]]</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">59</span><span class="p">:</span><span class="mi">65</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> |
---|
666 | |
---|
667 | <span class="k">return</span> <span class="n">table128</span></div> |
---|
668 | |
---|
669 | |
---|
670 | <div class="viewcode-block" id="to_param_id"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.to_param_id">[docs]</a><span class="k">def</span> <span class="nf">to_param_id</span><span class="p">(</span><span class="n">pars</span><span class="p">,</span> <span class="n">table</span><span class="p">):</span> |
---|
671 | <span class="sd">'''Transform parameter names to parameter ids with ECMWF grib table 128.</span> |
---|
672 | |
---|
673 | <span class="sd"> Parameters</span> |
---|
674 | <span class="sd"> ----------</span> |
---|
675 | <span class="sd"> pars : str</span> |
---|
676 | <span class="sd"> Addpar argument from CONTROL file in the format of</span> |
---|
677 | <span class="sd"> parameter names instead of ids. The parameter short</span> |
---|
678 | <span class="sd"> names are sepearted with "/" and they are passed as</span> |
---|
679 | <span class="sd"> one single string.</span> |
---|
680 | |
---|
681 | <span class="sd"> table : dict</span> |
---|
682 | <span class="sd"> Contains the ECMWF grib table 128 information.</span> |
---|
683 | <span class="sd"> The key is the parameter number and the value is the</span> |
---|
684 | <span class="sd"> short name of the parameter.</span> |
---|
685 | |
---|
686 | <span class="sd"> Return</span> |
---|
687 | <span class="sd"> ------</span> |
---|
688 | <span class="sd"> ipar : list of int</span> |
---|
689 | <span class="sd"> List of addpar parameters from CONTROL file transformed to</span> |
---|
690 | <span class="sd"> parameter ids in the format of integer.</span> |
---|
691 | <span class="sd"> '''</span> |
---|
692 | <span class="k">if</span> <span class="ow">not</span> <span class="n">pars</span><span class="p">:</span> |
---|
693 | <span class="k">return</span> <span class="p">[]</span> |
---|
694 | <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">pars</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span> |
---|
695 | <span class="n">pars</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">pars</span><span class="p">)</span> |
---|
696 | |
---|
697 | <span class="n">cpar</span> <span class="o">=</span> <span class="n">pars</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'/'</span><span class="p">)</span> |
---|
698 | <span class="n">ipar</span> <span class="o">=</span> <span class="p">[]</span> |
---|
699 | <span class="k">for</span> <span class="n">par</span> <span class="ow">in</span> <span class="n">cpar</span><span class="p">:</span> |
---|
700 | <span class="n">par</span> <span class="o">=</span> <span class="n">par</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> |
---|
701 | <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">table</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
---|
702 | <span class="k">if</span> <span class="n">par</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span> |
---|
703 | <span class="n">par</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">par</span><span class="p">))</span><span class="o">.</span><span class="n">zfill</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> |
---|
704 | <span class="k">if</span> <span class="n">par</span> <span class="o">==</span> <span class="n">k</span> <span class="ow">or</span> <span class="n">par</span> <span class="o">==</span> <span class="n">v</span><span class="p">:</span> |
---|
705 | <span class="n">ipar</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">k</span><span class="p">))</span> |
---|
706 | <span class="k">break</span> |
---|
707 | <span class="k">else</span><span class="p">:</span> |
---|
708 | <span class="nb">print</span><span class="p">(</span><span class="s1">'Warning: par '</span> <span class="o">+</span> <span class="n">par</span> <span class="o">+</span> <span class="s1">' not found in table 128'</span><span class="p">)</span> |
---|
709 | |
---|
710 | <span class="k">return</span> <span class="n">ipar</span></div> |
---|
711 | |
---|
712 | <div class="viewcode-block" id="to_param_id_with_tablenumber"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.to_param_id_with_tablenumber">[docs]</a><span class="k">def</span> <span class="nf">to_param_id_with_tablenumber</span><span class="p">(</span><span class="n">pars</span><span class="p">,</span> <span class="n">table</span><span class="p">):</span> |
---|
713 | <span class="sd">'''Transform parameter names to parameter ids and add table id.</span> |
---|
714 | |
---|
715 | <span class="sd"> Conversion with ECMWF grib table 128.</span> |
---|
716 | |
---|
717 | <span class="sd"> Parameters</span> |
---|
718 | <span class="sd"> ----------</span> |
---|
719 | <span class="sd"> pars : str</span> |
---|
720 | <span class="sd"> Addpar argument from CONTROL file in the format of</span> |
---|
721 | <span class="sd"> parameter names instead of ids. The parameter short</span> |
---|
722 | <span class="sd"> names are sepearted with "/" and they are passed as</span> |
---|
723 | <span class="sd"> one single string.</span> |
---|
724 | |
---|
725 | <span class="sd"> table : dict</span> |
---|
726 | <span class="sd"> Contains the ECMWF grib table 128 information.</span> |
---|
727 | <span class="sd"> The key is the parameter number and the value is the</span> |
---|
728 | <span class="sd"> short name of the parameter.</span> |
---|
729 | |
---|
730 | <span class="sd"> Return</span> |
---|
731 | <span class="sd"> ------</span> |
---|
732 | <span class="sd"> spar : str</span> |
---|
733 | <span class="sd"> List of addpar parameters from CONTROL file transformed to</span> |
---|
734 | <span class="sd"> parameter ids in the format of integer.</span> |
---|
735 | <span class="sd"> '''</span> |
---|
736 | <span class="k">if</span> <span class="ow">not</span> <span class="n">pars</span><span class="p">:</span> |
---|
737 | <span class="k">return</span> <span class="p">[]</span> |
---|
738 | <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">pars</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span> |
---|
739 | <span class="n">pars</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">pars</span><span class="p">)</span> |
---|
740 | |
---|
741 | <span class="n">cpar</span> <span class="o">=</span> <span class="n">pars</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'/'</span><span class="p">)</span> |
---|
742 | <span class="n">spar</span> <span class="o">=</span> <span class="p">[]</span> |
---|
743 | <span class="k">for</span> <span class="n">par</span> <span class="ow">in</span> <span class="n">cpar</span><span class="p">:</span> |
---|
744 | <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">table</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
---|
745 | <span class="k">if</span> <span class="n">par</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span> |
---|
746 | <span class="n">par</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">par</span><span class="p">))</span><span class="o">.</span><span class="n">zfill</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span> |
---|
747 | <span class="k">if</span> <span class="n">par</span> <span class="o">==</span> <span class="n">k</span> <span class="ow">or</span> <span class="n">par</span> <span class="o">==</span> <span class="n">v</span><span class="p">:</span> |
---|
748 | <span class="n">spar</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">k</span> <span class="o">+</span> <span class="s1">'.128'</span><span class="p">)</span> |
---|
749 | <span class="k">break</span> |
---|
750 | <span class="k">else</span><span class="p">:</span> |
---|
751 | <span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n\n\t\t</span><span class="s1">Warning: par '</span> <span class="o">+</span> <span class="n">par</span> <span class="o">+</span> <span class="s1">' not found in table 128</span><span class="se">\n\n</span><span class="s1">'</span><span class="p">)</span> |
---|
752 | |
---|
753 | <span class="k">return</span> <span class="s1">'/'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">spar</span><span class="p">)</span></div> |
---|
754 | |
---|
755 | <div class="viewcode-block" id="get_list_as_string"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.get_list_as_string">[docs]</a><span class="k">def</span> <span class="nf">get_list_as_string</span><span class="p">(</span><span class="n">list_obj</span><span class="p">,</span> <span class="n">concatenate_sign</span><span class="o">=</span><span class="s1">', '</span><span class="p">):</span> |
---|
756 | <span class="sd">'''Converts a list of arbitrary content into a single string.</span> |
---|
757 | |
---|
758 | <span class="sd"> Parameters</span> |
---|
759 | <span class="sd"> ----------</span> |
---|
760 | <span class="sd"> list_obj : list of *</span> |
---|
761 | <span class="sd"> A list with arbitrary content.</span> |
---|
762 | |
---|
763 | <span class="sd"> concatenate_sign : str, optional</span> |
---|
764 | <span class="sd"> A string which is used to concatenate the single</span> |
---|
765 | <span class="sd"> list elements. Default value is ", ".</span> |
---|
766 | |
---|
767 | <span class="sd"> Return</span> |
---|
768 | <span class="sd"> ------</span> |
---|
769 | <span class="sd"> str_of_list : str</span> |
---|
770 | <span class="sd"> The content of the list as a single string.</span> |
---|
771 | <span class="sd"> '''</span> |
---|
772 | |
---|
773 | <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">list_obj</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span> |
---|
774 | <span class="n">list_obj</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">list_obj</span><span class="p">)</span> |
---|
775 | <span class="n">str_of_list</span> <span class="o">=</span> <span class="n">concatenate_sign</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">l</span><span class="p">)</span> <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="n">list_obj</span><span class="p">)</span> |
---|
776 | |
---|
777 | <span class="k">return</span> <span class="n">str_of_list</span></div> |
---|
778 | |
---|
779 | <div class="viewcode-block" id="make_dir"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.make_dir">[docs]</a><span class="k">def</span> <span class="nf">make_dir</span><span class="p">(</span><span class="n">directory</span><span class="p">):</span> |
---|
780 | <span class="sd">'''Creates a directory.</span> |
---|
781 | |
---|
782 | <span class="sd"> It gives a warning if the directory already exists and skips process.</span> |
---|
783 | <span class="sd"> The program stops only if there is another problem.</span> |
---|
784 | |
---|
785 | <span class="sd"> Parameters</span> |
---|
786 | <span class="sd"> ----------</span> |
---|
787 | <span class="sd"> directory : str</span> |
---|
788 | <span class="sd"> The path to directory which should be created.</span> |
---|
789 | |
---|
790 | <span class="sd"> Return</span> |
---|
791 | <span class="sd"> ------</span> |
---|
792 | |
---|
793 | <span class="sd"> '''</span> |
---|
794 | <span class="k">try</span><span class="p">:</span> |
---|
795 | <span class="n">os</span><span class="o">.</span><span class="n">makedirs</span><span class="p">(</span><span class="n">directory</span><span class="p">)</span> |
---|
796 | <span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
797 | <span class="c1"># errno.EEXIST = directory already exists</span> |
---|
798 | <span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="o">==</span> <span class="n">errno</span><span class="o">.</span><span class="n">EEXIST</span><span class="p">:</span> |
---|
799 | <span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Directory </span><span class="si">{0}</span><span class="s1"> already exists!'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">directory</span><span class="p">))</span> |
---|
800 | <span class="k">else</span><span class="p">:</span> |
---|
801 | <span class="k">raise</span> <span class="c1"># re-raise exception if a different error occured</span> |
---|
802 | |
---|
803 | <span class="k">return</span></div> |
---|
804 | |
---|
805 | <div class="viewcode-block" id="put_file_to_ecserver"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.put_file_to_ecserver">[docs]</a><span class="k">def</span> <span class="nf">put_file_to_ecserver</span><span class="p">(</span><span class="n">ecd</span><span class="p">,</span> <span class="n">filename</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span> <span class="n">ecuid</span><span class="p">,</span> <span class="n">ecgid</span><span class="p">):</span> |
---|
806 | <span class="sd">'''Uses the ecaccess-file-put command to send a file to the ECMWF servers.</span> |
---|
807 | |
---|
808 | <span class="sd"> Note</span> |
---|
809 | <span class="sd"> ----</span> |
---|
810 | <span class="sd"> The return value is just for testing reasons. It does not have</span> |
---|
811 | <span class="sd"> to be used from the calling function since the whole error handling</span> |
---|
812 | <span class="sd"> is done in here.</span> |
---|
813 | |
---|
814 | <span class="sd"> Parameters</span> |
---|
815 | <span class="sd"> ----------</span> |
---|
816 | <span class="sd"> ecd : str</span> |
---|
817 | <span class="sd"> The path were the file is stored.</span> |
---|
818 | |
---|
819 | <span class="sd"> filename : str</span> |
---|
820 | <span class="sd"> The name of the file to send to the ECMWF server.</span> |
---|
821 | |
---|
822 | <span class="sd"> target : str</span> |
---|
823 | <span class="sd"> The target queue where the file should be sent to.</span> |
---|
824 | |
---|
825 | <span class="sd"> ecuid : str</span> |
---|
826 | <span class="sd"> The user id on ECMWF server.</span> |
---|
827 | |
---|
828 | <span class="sd"> ecgid : str</span> |
---|
829 | <span class="sd"> The group id on ECMWF server.</span> |
---|
830 | |
---|
831 | <span class="sd"> Return</span> |
---|
832 | <span class="sd"> ------</span> |
---|
833 | |
---|
834 | <span class="sd"> '''</span> |
---|
835 | |
---|
836 | <span class="k">try</span><span class="p">:</span> |
---|
837 | <span class="n">subprocess</span><span class="o">.</span><span class="n">check_output</span><span class="p">([</span><span class="s1">'ecaccess-file-put'</span><span class="p">,</span> |
---|
838 | <span class="n">ecd</span> <span class="o">+</span> <span class="s1">'/'</span> <span class="o">+</span> <span class="n">filename</span><span class="p">,</span> |
---|
839 | <span class="n">target</span> <span class="o">+</span> <span class="s1">':/home/ms/'</span> <span class="o">+</span> |
---|
840 | <span class="n">ecgid</span> <span class="o">+</span> <span class="s1">'/'</span> <span class="o">+</span> <span class="n">ecuid</span> <span class="o">+</span> |
---|
841 | <span class="s1">'/'</span> <span class="o">+</span> <span class="n">filename</span><span class="p">],</span> |
---|
842 | <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">STDOUT</span><span class="p">)</span> |
---|
843 | <span class="k">except</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">CalledProcessError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
844 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">returncode</span><span class="p">))</span> |
---|
845 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span> |
---|
846 | |
---|
847 | <span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... Do you have a valid ecaccess certification key?'</span><span class="p">)</span> |
---|
848 | <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'... ECACCESS-FILE-PUT FAILED!'</span><span class="p">)</span> |
---|
849 | <span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
850 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">errno</span><span class="p">))</span> |
---|
851 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">strerror</span><span class="p">))</span> |
---|
852 | |
---|
853 | <span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... Most likely the ECACCESS library is not available!'</span><span class="p">)</span> |
---|
854 | <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'... ECACCESS-FILE-PUT FAILED!'</span><span class="p">)</span> |
---|
855 | |
---|
856 | <span class="k">return</span></div> |
---|
857 | |
---|
858 | <div class="viewcode-block" id="submit_job_to_ecserver"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.submit_job_to_ecserver">[docs]</a><span class="k">def</span> <span class="nf">submit_job_to_ecserver</span><span class="p">(</span><span class="n">target</span><span class="p">,</span> <span class="n">jobname</span><span class="p">):</span> |
---|
859 | <span class="sd">'''Uses ecaccess-job-submit command to submit a job to the ECMWF server.</span> |
---|
860 | |
---|
861 | <span class="sd"> Note</span> |
---|
862 | <span class="sd"> ----</span> |
---|
863 | <span class="sd"> The return value is just for testing reasons. It does not have</span> |
---|
864 | <span class="sd"> to be used from the calling function since the whole error handling</span> |
---|
865 | <span class="sd"> is done in here.</span> |
---|
866 | |
---|
867 | <span class="sd"> Parameters</span> |
---|
868 | <span class="sd"> ----------</span> |
---|
869 | <span class="sd"> target : str</span> |
---|
870 | <span class="sd"> The target where the file should be sent to, e.g. the queue.</span> |
---|
871 | |
---|
872 | <span class="sd"> jobname : str</span> |
---|
873 | <span class="sd"> The name of the jobfile to be submitted to the ECMWF server.</span> |
---|
874 | |
---|
875 | <span class="sd"> Return</span> |
---|
876 | <span class="sd"> ------</span> |
---|
877 | <span class="sd"> job_id : int</span> |
---|
878 | <span class="sd"> The id number of the job as a reference at the ecmwf server.</span> |
---|
879 | <span class="sd"> '''</span> |
---|
880 | |
---|
881 | <span class="k">try</span><span class="p">:</span> |
---|
882 | <span class="n">job_id</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">check_output</span><span class="p">([</span><span class="s1">'ecaccess-job-submit'</span><span class="p">,</span> <span class="s1">'-queueName'</span><span class="p">,</span> |
---|
883 | <span class="n">target</span><span class="p">,</span> <span class="n">jobname</span><span class="p">])</span> |
---|
884 | |
---|
885 | <span class="k">except</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">CalledProcessError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
886 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">returncode</span><span class="p">))</span> |
---|
887 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span> |
---|
888 | |
---|
889 | <span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... Do you have a valid ecaccess certification key?'</span><span class="p">)</span> |
---|
890 | <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'... ECACCESS-JOB-SUBMIT FAILED!'</span><span class="p">)</span> |
---|
891 | <span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
892 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">errno</span><span class="p">))</span> |
---|
893 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">strerror</span><span class="p">))</span> |
---|
894 | |
---|
895 | <span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... Most likely the ECACCESS library is not available!'</span><span class="p">)</span> |
---|
896 | <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'... ECACCESS-JOB-SUBMIT FAILED!'</span><span class="p">)</span> |
---|
897 | |
---|
898 | <span class="k">return</span> <span class="n">job_id</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span></div> |
---|
899 | |
---|
900 | |
---|
901 | <div class="viewcode-block" id="get_informations"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.get_informations">[docs]</a><span class="k">def</span> <span class="nf">get_informations</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span> |
---|
902 | <span class="sd">'''Gets basic information from an example grib file.</span> |
---|
903 | |
---|
904 | <span class="sd"> These information are important for later use and the</span> |
---|
905 | <span class="sd"> initialization of numpy arrays for data storing.</span> |
---|
906 | |
---|
907 | <span class="sd"> Parameters</span> |
---|
908 | <span class="sd"> ----------</span> |
---|
909 | <span class="sd"> filename : str</span> |
---|
910 | <span class="sd"> Name of the file which will be opened to extract basic information.</span> |
---|
911 | |
---|
912 | <span class="sd"> Return</span> |
---|
913 | <span class="sd"> ------</span> |
---|
914 | <span class="sd"> data : dict</span> |
---|
915 | <span class="sd"> Contains basic informations of the ECMWF grib files, e.g.</span> |
---|
916 | <span class="sd"> 'Ni', 'Nj', 'latitudeOfFirstGridPointInDegrees',</span> |
---|
917 | <span class="sd"> 'longitudeOfFirstGridPointInDegrees', 'latitudeOfLastGridPointInDegrees',</span> |
---|
918 | <span class="sd"> 'longitudeOfLastGridPointInDegrees', 'jDirectionIncrementInDegrees',</span> |
---|
919 | <span class="sd"> 'iDirectionIncrementInDegrees', 'missingValue'</span> |
---|
920 | <span class="sd"> '''</span> |
---|
921 | <span class="kn">from</span> <span class="nn">eccodes</span> <span class="k">import</span> <span class="n">codes_grib_new_from_file</span><span class="p">,</span> <span class="n">codes_get</span><span class="p">,</span> <span class="n">codes_release</span> |
---|
922 | |
---|
923 | <span class="n">data</span> <span class="o">=</span> <span class="p">{}</span> |
---|
924 | |
---|
925 | <span class="c1"># --- open file ---</span> |
---|
926 | <span class="nb">print</span><span class="p">(</span><span class="s2">"Opening file for getting information data --- </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">filename</span><span class="p">)</span> |
---|
927 | <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> |
---|
928 | <span class="c1"># load first message from file</span> |
---|
929 | <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">f</span><span class="p">)</span> |
---|
930 | |
---|
931 | <span class="c1"># information needed from grib message</span> |
---|
932 | <span class="n">keys</span> <span class="o">=</span> <span class="p">[</span> |
---|
933 | <span class="s1">'Ni'</span><span class="p">,</span> |
---|
934 | <span class="s1">'Nj'</span><span class="p">,</span> |
---|
935 | <span class="s1">'latitudeOfFirstGridPointInDegrees'</span><span class="p">,</span> |
---|
936 | <span class="s1">'longitudeOfFirstGridPointInDegrees'</span><span class="p">,</span> |
---|
937 | <span class="s1">'latitudeOfLastGridPointInDegrees'</span><span class="p">,</span> |
---|
938 | <span class="s1">'longitudeOfLastGridPointInDegrees'</span><span class="p">,</span> |
---|
939 | <span class="s1">'jDirectionIncrementInDegrees'</span><span class="p">,</span> |
---|
940 | <span class="s1">'iDirectionIncrementInDegrees'</span><span class="p">,</span> |
---|
941 | <span class="s1">'missingValue'</span><span class="p">,</span> |
---|
942 | <span class="p">]</span> |
---|
943 | |
---|
944 | <span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">Informations are: '</span><span class="p">)</span> |
---|
945 | <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">keys</span><span class="p">:</span> |
---|
946 | <span class="c1"># Get the value of the key in a grib message.</span> |
---|
947 | <span class="n">data</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</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> |
---|
948 | <span class="nb">print</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2"> = </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span><span class="n">key</span><span class="p">,</span><span class="n">data</span><span class="p">[</span><span class="n">key</span><span class="p">]))</span> |
---|
949 | |
---|
950 | <span class="c1"># Free the memory for the message referred as gribid.</span> |
---|
951 | <span class="n">codes_release</span><span class="p">(</span><span class="n">gid</span><span class="p">)</span> |
---|
952 | |
---|
953 | <span class="k">return</span> <span class="n">data</span></div> |
---|
954 | |
---|
955 | |
---|
956 | <div class="viewcode-block" id="get_dimensions"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.get_dimensions">[docs]</a><span class="k">def</span> <span class="nf">get_dimensions</span><span class="p">(</span><span class="n">info</span><span class="p">,</span> <span class="n">purefc</span><span class="p">,</span> <span class="n">dtime</span><span class="p">,</span> <span class="n">index_vals</span><span class="p">,</span> <span class="n">start_date</span><span class="p">,</span> <span class="n">end_date</span><span class="p">):</span> |
---|
957 | <span class="sd">'''This function specifies the correct dimensions for x, y and t.</span> |
---|
958 | |
---|
959 | <span class="sd"> Parameters</span> |
---|
960 | <span class="sd"> ----------</span> |
---|
961 | <span class="sd"> info : dict</span> |
---|
962 | <span class="sd"> Contains basic informations of the ECMWF grib files, e.g.</span> |
---|
963 | <span class="sd"> 'Ni', 'Nj', 'latitudeOfFirstGridPointInDegrees',</span> |
---|
964 | <span class="sd"> 'longitudeOfFirstGridPointInDegrees', 'latitudeOfLastGridPointInDegrees',</span> |
---|
965 | <span class="sd"> 'longitudeOfLastGridPointInDegrees', 'jDirectionIncrementInDegrees',</span> |
---|
966 | <span class="sd"> 'iDirectionIncrementInDegrees', 'missingValue'</span> |
---|
967 | |
---|
968 | <span class="sd"> purefc : int</span> |
---|
969 | <span class="sd"> Switch for definition of pure forecast mode or not.</span> |
---|
970 | |
---|
971 | <span class="sd"> dtime : str</span> |
---|
972 | <span class="sd"> Time step in hours.</span> |
---|
973 | |
---|
974 | <span class="sd"> index_vals : list of list of str</span> |
---|
975 | <span class="sd"> Contains the values from the keys used for a distinct selection</span> |
---|
976 | <span class="sd"> of grib messages in processing the grib files.</span> |
---|
977 | <span class="sd"> Content looks like e.g.:</span> |
---|
978 | <span class="sd"> index_vals[0]: ('20171106', '20171107', '20171108') ; date</span> |
---|
979 | <span class="sd"> index_vals[1]: ('0', '1200', '1800', '600') ; time</span> |
---|
980 | <span class="sd"> index_vals[2]: ('0', '12', '3', '6', '9') ; stepRange</span> |
---|
981 | |
---|
982 | <span class="sd"> start_date : str</span> |
---|
983 | <span class="sd"> The start date of the retrieval job.</span> |
---|
984 | |
---|
985 | <span class="sd"> end_date : str</span> |
---|
986 | <span class="sd"> The end date of the retrieval job.</span> |
---|
987 | |
---|
988 | <span class="sd"> Return</span> |
---|
989 | <span class="sd"> ------</span> |
---|
990 | <span class="sd"> (ix, jy, it) : tuple of int</span> |
---|
991 | <span class="sd"> Dimension in x-direction, y-direction and in time.</span> |
---|
992 | <span class="sd"> '''</span> |
---|
993 | |
---|
994 | <span class="n">ix</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s1">'Ni'</span><span class="p">]</span> |
---|
995 | |
---|
996 | <span class="n">jy</span> <span class="o">=</span> <span class="n">info</span><span class="p">[</span><span class="s1">'Nj'</span><span class="p">]</span> |
---|
997 | |
---|
998 | <span class="k">if</span> <span class="ow">not</span> <span class="n">purefc</span><span class="p">:</span> |
---|
999 | <span class="n">it</span> <span class="o">=</span> <span class="p">((</span><span class="n">end_date</span> <span class="o">-</span> <span class="n">start_date</span><span class="p">)</span><span class="o">.</span><span class="n">days</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span> <span class="o">*</span> <span class="mi">24</span> <span class="o">//</span> <span class="nb">int</span><span class="p">(</span><span class="n">dtime</span><span class="p">)</span> |
---|
1000 | <span class="k">else</span><span class="p">:</span> |
---|
1001 | <span class="c1"># #no of step * #no of times * #no of days</span> |
---|
1002 | <span class="n">it</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">index_vals</span><span class="p">[</span><span class="mi">2</span><span class="p">])</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">index_vals</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">index_vals</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> |
---|
1003 | |
---|
1004 | <span class="k">return</span> <span class="p">(</span><span class="n">ix</span><span class="p">,</span> <span class="n">jy</span><span class="p">,</span> <span class="n">it</span><span class="p">)</span></div> |
---|
1005 | |
---|
1006 | |
---|
1007 | <div class="viewcode-block" id="execute_subprocess"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.execute_subprocess">[docs]</a><span class="k">def</span> <span class="nf">execute_subprocess</span><span class="p">(</span><span class="n">cmd_list</span><span class="p">,</span> <span class="n">error_msg</span><span class="o">=</span><span class="s1">'SUBPROCESS FAILED!'</span><span class="p">):</span> |
---|
1008 | <span class="sd">'''Executes a command line instruction via a subprocess.</span> |
---|
1009 | |
---|
1010 | <span class="sd"> Error handling is done if an error occures.</span> |
---|
1011 | |
---|
1012 | <span class="sd"> Parameters</span> |
---|
1013 | <span class="sd"> ----------</span> |
---|
1014 | <span class="sd"> cmd_list : list of str</span> |
---|
1015 | <span class="sd"> A list of the components for the command line execution. Each</span> |
---|
1016 | <span class="sd"> list entry is a single part of the command which is seperated from</span> |
---|
1017 | <span class="sd"> the rest by a blank space.</span> |
---|
1018 | <span class="sd"> E.g. ['mv', file1, file2]</span> |
---|
1019 | |
---|
1020 | <span class="sd"> Return</span> |
---|
1021 | <span class="sd"> ------</span> |
---|
1022 | <span class="sd"> error_msg : str, optional</span> |
---|
1023 | <span class="sd"> The possible error message if the subprocess failed.</span> |
---|
1024 | <span class="sd"> By default it will just tell "SUBPROCESS FAILED!".</span> |
---|
1025 | <span class="sd"> '''</span> |
---|
1026 | |
---|
1027 | <span class="k">try</span><span class="p">:</span> |
---|
1028 | <span class="n">subprocess</span><span class="o">.</span><span class="n">check_call</span><span class="p">(</span><span class="n">cmd_list</span><span class="p">)</span> |
---|
1029 | <span class="k">except</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">CalledProcessError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
1030 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">returncode</span><span class="p">))</span> |
---|
1031 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span> |
---|
1032 | |
---|
1033 | <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'... '</span> <span class="o">+</span> <span class="n">error_msg</span><span class="p">)</span> |
---|
1034 | <span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
1035 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">errno</span><span class="p">))</span> |
---|
1036 | <span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">strerror</span><span class="p">))</span> |
---|
1037 | |
---|
1038 | <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'... '</span> <span class="o">+</span> <span class="n">error_msg</span><span class="p">)</span> |
---|
1039 | |
---|
1040 | <span class="k">return</span></div> |
---|
1041 | |
---|
1042 | |
---|
1043 | <div class="viewcode-block" id="generate_retrieval_period_boundary"><a class="viewcode-back" href="../Documentation/Api/api_python.html#tools.generate_retrieval_period_boundary">[docs]</a><span class="k">def</span> <span class="nf">generate_retrieval_period_boundary</span><span class="p">(</span><span class="n">c</span><span class="p">):</span> |
---|
1044 | <span class="sd">'''Generates retrieval period boundary datetimes from CONTROL information.</span> |
---|
1045 | |
---|
1046 | <span class="sd"> Parameters</span> |
---|
1047 | <span class="sd"> ----------</span> |
---|
1048 | <span class="sd"> c : ControlFile</span> |
---|
1049 | <span class="sd"> Contains all the parameters of CONTROL file and</span> |
---|
1050 | <span class="sd"> command line.</span> |
---|
1051 | |
---|
1052 | <span class="sd"> Return</span> |
---|
1053 | <span class="sd"> ------</span> |
---|
1054 | <span class="sd"> start_period : datetime</span> |
---|
1055 | <span class="sd"> The first timestamp of the actual retrieval period disregarding</span> |
---|
1056 | <span class="sd"> the temporary times which were used for processing reasons.</span> |
---|
1057 | |
---|
1058 | <span class="sd"> end_period : datetime</span> |
---|
1059 | <span class="sd"> The last timestamp of the actual retrieval period disregarding</span> |
---|
1060 | <span class="sd"> the temporary times which were used for processing reasons.</span> |
---|
1061 | <span class="sd"> '''</span> |
---|
1062 | <span class="c1"># generate start and end timestamp of the retrieval period</span> |
---|
1063 | <span class="n">start_period</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">start_date</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">time</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="s1">'%Y%m</span><span class="si">%d</span><span class="s1">%H'</span><span class="p">)</span> |
---|
1064 | <span class="n">start_period</span> <span class="o">=</span> <span class="n">start_period</span> <span class="o">+</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">hours</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">step</span><span class="p">[</span><span class="mi">0</span><span class="p">]))</span> |
---|
1065 | <span class="n">end_period</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">end_date</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">time</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">],</span> <span class="s1">'%Y%m</span><span class="si">%d</span><span class="s1">%H'</span><span class="p">)</span> |
---|
1066 | <span class="n">end_period</span> <span class="o">=</span> <span class="n">end_period</span> <span class="o">+</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">hours</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">step</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]))</span> |
---|
1067 | |
---|
1068 | |
---|
1069 | <span class="k">return</span> <span class="n">start_period</span><span class="p">,</span> <span class="n">end_period</span></div> |
---|
1070 | </pre></div> |
---|
1071 | |
---|
1072 | </div> |
---|
1073 | |
---|
1074 | </div> |
---|
1075 | <footer> |
---|
1076 | |
---|
1077 | |
---|
1078 | <hr/> |
---|
1079 | |
---|
1080 | <div role="contentinfo"> |
---|
1081 | <p> |
---|
1082 | © Copyright 2019, Anne Philipp and Leopold Haimberger |
---|
1083 | |
---|
1084 | </p> |
---|
1085 | </div> |
---|
1086 | 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>. |
---|
1087 | |
---|
1088 | </footer> |
---|
1089 | |
---|
1090 | </div> |
---|
1091 | </div> |
---|
1092 | |
---|
1093 | </section> |
---|
1094 | |
---|
1095 | </div> |
---|
1096 | |
---|
1097 | |
---|
1098 | |
---|
1099 | <script type="text/javascript"> |
---|
1100 | jQuery(function () { |
---|
1101 | SphinxRtdTheme.Navigation.enable(true); |
---|
1102 | }); |
---|
1103 | </script> |
---|
1104 | |
---|
1105 | |
---|
1106 | |
---|
1107 | |
---|
1108 | |
---|
1109 | |
---|
1110 | </body> |
---|
1111 | </html> |
---|