source: flex_extract.git/documentation/Sphinx/build/html/_modules/tools.html @ 0629ba8

ctbtodev
Last change on this file since 0629ba8 was 274f9ef, checked in by Anne Philipp <anne.philipp@…>, 6 years ago

Converted docstrings to numpy style and build first structure for sphinxdocumentation (incl API)
  • Property mode set to 100644
File size: 62.1 KB
Line 
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7  <meta charset="utf-8">
8 
9  <meta name="viewport" content="width=device-width, initial-scale=1.0">
10 
11  <title>tools &mdash; flex_extract 7.1 alpha documentation</title>
12 
13
14 
15 
16 
17 
18
19 
20
21 
22 
23   
24
25 
26
27  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
28  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
29    <link rel="index" title="Index" href="../genindex.html" />
30    <link rel="search" title="Search" href="../search.html" /> 
31
32 
33  <script src="../_static/js/modernizr.min.js"></script>
34
35</head>
36
37<body class="wy-body-for-nav">
38
39   
40  <div class="wy-grid-for-nav">
41
42   
43    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
44      <div class="wy-side-scroll">
45        <div class="wy-side-nav-search">
46         
47
48         
49            <a href="../index.html" class="icon icon-home"> flex_extract
50         
51
52         
53          </a>
54
55         
56           
57           
58              <div class="version">
59                7.1
60              </div>
61           
62         
63
64         
65<div role="search">
66  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
67    <input type="text" name="q" placeholder="Search docs" />
68    <input type="hidden" name="check_keywords" value="yes" />
69    <input type="hidden" name="area" value="default" />
70  </form>
71</div>
72
73         
74        </div>
75
76        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
77         
78           
79           
80             
81           
82           
83              <p class="caption"><span class="caption-text">Table of Contents:</span></p>
84<ul>
85<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>
86<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
87<li class="toctree-l1"><a class="reference internal" href="../program_structure.html">Program Structure</a></li>
88<li class="toctree-l1"><a class="reference internal" href="../user_guide.html">User Guide</a></li>
89<li class="toctree-l1"><a class="reference internal" href="../api.html">Auto Generated Documentation</a></li>
90<li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li>
91</ul>
92
93           
94         
95        </div>
96      </div>
97    </nav>
98
99    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
100
101     
102      <nav class="wy-nav-top" aria-label="top navigation">
103       
104          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
105          <a href="../index.html">flex_extract</a>
106       
107      </nav>
108
109
110      <div class="wy-nav-content">
111       
112        <div class="rst-content">
113       
114         
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130<div role="navigation" aria-label="breadcrumbs navigation">
131
132  <ul class="wy-breadcrumbs">
133   
134      <li><a href="../index.html">Docs</a> &raquo;</li>
135       
136          <li><a href="index.html">Module code</a> &raquo;</li>
137       
138      <li>tools</li>
139   
140   
141      <li class="wy-breadcrumbs-aside">
142       
143      </li>
144   
145  </ul>
146
147 
148  <hr/>
149</div>
150          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
151           <div itemprop="articleBody">
152           
153  <h1>Source code for tools</h1><div class="highlight"><pre>
154<span></span><span class="ch">#!/usr/bin/env python</span>
155<span class="c1"># -*- coding: utf-8 -*-</span>
156<span class="c1">#*******************************************************************************</span>
157<span class="c1"># @Author: Anne Philipp (University of Vienna)</span>
158<span class="c1">#</span>
159<span class="c1"># @Date: May 2018</span>
160<span class="c1">#</span>
161<span class="c1"># @Change History:</span>
162<span class="c1">#    October 2014 - Anne Fouilloux (University of Oslo)</span>
163<span class="c1">#        - created functions silent_remove and product (taken from ECMWF)</span>
164<span class="c1">#</span>
165<span class="c1">#    November 2015 - Leopold Haimberger (University of Vienna)</span>
166<span class="c1">#        - created functions: interpret_args_and_control, clean_up</span>
167<span class="c1">#          my_error, normal_exit, init128, to_param_id</span>
168<span class="c1">#</span>
169<span class="c1">#    April 2018 - Anne Philipp (University of Vienna):</span>
170<span class="c1">#        - applied PEP8 style guide</span>
171<span class="c1">#        - added documentation</span>
172<span class="c1">#        - moved all functions from file Flexparttools to this file tools</span>
173<span class="c1">#        - added function get_list_as_string</span>
174<span class="c1">#        - seperated args and control interpretation</span>
175<span class="c1">#</span>
176<span class="c1"># @License:</span>
177<span class="c1">#    (C) Copyright 2014-2018.</span>
178<span class="c1">#</span>
179<span class="c1">#    This software is licensed under the terms of the Apache Licence Version 2.0</span>
180<span class="c1">#    which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.</span>
181<span class="c1">#</span>
182<span class="c1"># @Modul Description:</span>
183<span class="c1">#    This module contains a couple of helpful functions which are</span>
184<span class="c1">#    used in different places in flex_extract.</span>
185<span class="c1">#</span>
186<span class="c1"># @Module Content:</span>
187<span class="c1">#    - get_cmdline_arguments</span>
188<span class="c1">#    - clean_up</span>
189<span class="c1">#    - my_error</span>
190<span class="c1">#    - normal_exit</span>
191<span class="c1">#    - product</span>
192<span class="c1">#    - silent_remove</span>
193<span class="c1">#    - init128</span>
194<span class="c1">#    - to_param_id</span>
195<span class="c1">#    - get_list_as_string</span>
196<span class="c1">#    - make_dir</span>
197<span class="c1">#</span>
198<span class="c1">#*******************************************************************************</span>
199
200<span class="c1"># ------------------------------------------------------------------------------</span>
201<span class="c1"># MODULES</span>
202<span class="c1"># ------------------------------------------------------------------------------</span>
203<span class="kn">import</span> <span class="nn">os</span>
204<span class="kn">import</span> <span class="nn">errno</span>
205<span class="kn">import</span> <span class="nn">sys</span>
206<span class="kn">import</span> <span class="nn">glob</span>
207<span class="kn">import</span> <span class="nn">subprocess</span>
208<span class="kn">import</span> <span class="nn">traceback</span>
209<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>
210
211<span class="c1"># ------------------------------------------------------------------------------</span>
212<span class="c1"># FUNCTIONS</span>
213<span class="c1"># ------------------------------------------------------------------------------</span>
214
215<div class="viewcode-block" id="none_or_str"><a class="viewcode-back" href="../api.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>
216    <span class="sd">&#39;&#39;&#39;Converts the input string into pythons None-type if the string</span>
217<span class="sd">    contains string &quot;None&quot;.</span>
218
219<span class="sd">    Parameters</span>
220<span class="sd">    ----------</span>
221<span class="sd">    value : :obj:`string`</span>
222<span class="sd">        String to be checked for the &quot;None&quot; word.</span>
223
224<span class="sd">    Return</span>
225<span class="sd">    ------</span>
226<span class="sd">    None or value:</span>
227<span class="sd">        Return depends on the content of the input value. If it was &quot;None&quot;,</span>
228<span class="sd">        then the python type None is returned. Otherwise the string itself.</span>
229<span class="sd">    &#39;&#39;&#39;</span>
230    <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="s1">&#39;None&#39;</span><span class="p">:</span>
231        <span class="k">return</span> <span class="kc">None</span>
232    <span class="k">return</span> <span class="n">value</span></div>
233
234<div class="viewcode-block" id="none_or_int"><a class="viewcode-back" href="../api.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>
235    <span class="sd">&#39;&#39;&#39;Converts the input string into pythons None-type if the string</span>
236<span class="sd">    contains string &quot;None&quot;. Otherwise it is converted to an integer value.</span>
237
238<span class="sd">    Parameters</span>
239<span class="sd">    ----------</span>
240<span class="sd">    value : :obj:`string`</span>
241<span class="sd">        String to be checked for the &quot;None&quot; word.</span>
242
243<span class="sd">    Return</span>
244<span class="sd">    ------</span>
245<span class="sd">    None or int(value):</span>
246<span class="sd">        Return depends on the content of the input value. If it was &quot;None&quot;,</span>
247<span class="sd">        then the python type None is returned. Otherwise the string is</span>
248<span class="sd">        converted into an integer value.</span>
249<span class="sd">    &#39;&#39;&#39;</span>
250    <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="s1">&#39;None&#39;</span><span class="p">:</span>
251        <span class="k">return</span> <span class="kc">None</span>
252    <span class="k">return</span> <span class="nb">int</span><span class="p">(</span><span class="n">value</span><span class="p">)</span></div>
253
254<div class="viewcode-block" id="get_cmdline_arguments"><a class="viewcode-back" href="../api.html#tools.get_cmdline_arguments">[docs]</a><span class="k">def</span> <span class="nf">get_cmdline_arguments</span><span class="p">():</span>
255    <span class="sd">&#39;&#39;&#39;Decomposes the command line arguments and assigns them to variables.</span>
256<span class="sd">    Apply default values for non mentioned arguments.</span>
257
258<span class="sd">    Parameters</span>
259<span class="sd">    ----------</span>
260
261<span class="sd">    Return</span>
262<span class="sd">    ------</span>
263<span class="sd">    args : :obj:`Namespace`</span>
264<span class="sd">        Contains the commandline arguments from script/program call.</span>
265<span class="sd">    &#39;&#39;&#39;</span>
266
267    <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">&#39;Retrieve FLEXPART input from </span><span class="se">\</span>
268<span class="s1">                                ECMWF MARS archive&#39;</span><span class="p">,</span>
269                            <span class="n">formatter_class</span><span class="o">=</span><span class="n">ArgumentDefaultsHelpFormatter</span><span class="p">)</span>
270
271    <span class="c1"># the most important arguments</span>
272    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--start_date&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;start_date&quot;</span><span class="p">,</span>
273                        <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>
274                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;start date YYYYMMDD&quot;</span><span class="p">)</span>
275    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--end_date&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;end_date&quot;</span><span class="p">,</span>
276                        <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>
277                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;end_date YYYYMMDD&quot;</span><span class="p">)</span>
278    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--date_chunk&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;date_chunk&quot;</span><span class="p">,</span>
279                        <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>
280                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;# of days to be retrieved at once&quot;</span><span class="p">)</span>
281    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--controlfile&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;controlfile&quot;</span><span class="p">,</span>
282                        <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">&#39;CONTROL.temp&#39;</span><span class="p">,</span>
283                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;file with CONTROL parameters&quot;</span><span class="p">)</span>
284
285    <span class="c1"># parameter for extra output information</span>
286    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--debug&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;debug&quot;</span><span class="p">,</span>
287                        <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>
288                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;debug mode - leave temporary files intact&quot;</span><span class="p">)</span>
289    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--request&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;request&quot;</span><span class="p">,</span>
290                        <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>
291                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;list all mars request in file mars_requests.dat </span><span class="se">\</span>
292<span class="s2">                        and skip submission to mars&quot;</span><span class="p">)</span>
293    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--public&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;public&quot;</span><span class="p">,</span>
294                        <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>
295                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;public mode - retrieves the public datasets&quot;</span><span class="p">)</span>
296
297    <span class="c1"># some arguments that override the default in the CONTROL file</span>
298    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--basetime&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;basetime&quot;</span><span class="p">,</span>
299                        <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>
300                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;base such as 00 or 12 (for half day retrievals)&quot;</span><span class="p">)</span>
301    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--step&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;step&quot;</span><span class="p">,</span>
302                        <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>
303                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;steps such as 00/to/48&quot;</span><span class="p">)</span>
304    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--levelist&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;levelist&quot;</span><span class="p">,</span>
305                        <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>
306                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;Vertical levels to be retrieved, e.g. 30/to/60&quot;</span><span class="p">)</span>
307    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--area&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;area&quot;</span><span class="p">,</span>
308                        <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>
309                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;area defined as north/west/south/east&quot;</span><span class="p">)</span>
310
311    <span class="c1"># set the working directories</span>
312    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--inputdir&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;inputdir&quot;</span><span class="p">,</span>
313                        <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>
314                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;root directory for storing intermediate files&quot;</span><span class="p">)</span>
315    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--outputdir&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;outputdir&quot;</span><span class="p">,</span>
316                        <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>
317                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;root directory for storing output files&quot;</span><span class="p">)</span>
318    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--flexpart_root_scripts&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;flexpart_root_scripts&quot;</span><span class="p">,</span>
319                        <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>
320                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;FLEXPART root directory (to find grib2flexpart </span><span class="se">\</span>
321<span class="s2">                        and COMMAND file)</span><span class="se">\n</span><span class="s2"> Normally flex_extract resides in </span><span class="se">\</span>
322<span class="s2">                        the scripts directory of the FLEXPART distribution&quot;</span><span class="p">)</span>
323
324    <span class="c1"># this is only used by prepare_flexpart.py to rerun a postprocessing step</span>
325    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--ppid&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;ppid&quot;</span><span class="p">,</span>
326                        <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>
327                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;specify parent process id for </span><span class="se">\</span>
328<span class="s2">                        rerun of prepare_flexpart&quot;</span><span class="p">)</span>
329
330    <span class="c1"># arguments for job submission to ECMWF, only needed by submit.py</span>
331    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--job_template&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s1">&#39;job_template&#39;</span><span class="p">,</span>
332                        <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">&quot;job.temp&quot;</span><span class="p">,</span>
333                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;job template file for submission to ECMWF&quot;</span><span class="p">)</span>
334    <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">&quot;--queue&quot;</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">&quot;queue&quot;</span><span class="p">,</span>
335                        <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>
336                        <span class="n">help</span><span class="o">=</span><span class="s2">&quot;queue for submission to ECMWF </span><span class="se">\</span>
337<span class="s2">                        (e.g. ecgate or cca )&quot;</span><span class="p">)</span>
338
339    <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>
340
341    <span class="k">return</span> <span class="n">args</span></div>
342
343<div class="viewcode-block" id="read_ecenv"><a class="viewcode-back" href="../api.html#tools.read_ecenv">[docs]</a><span class="k">def</span> <span class="nf">read_ecenv</span><span class="p">(</span><span class="n">filename</span><span class="p">):</span>
344    <span class="sd">&#39;&#39;&#39;Reads the file into a dictionary where the key values are the parameter</span>
345<span class="sd">    names.</span>
346
347<span class="sd">    Parameters</span>
348<span class="sd">    ----------</span>
349<span class="sd">    filename : :obj:`string`</span>
350<span class="sd">        Path to file where the ECMWF environment parameters are stored.</span>
351
352<span class="sd">    Return</span>
353<span class="sd">    ------</span>
354<span class="sd">    envs : :obj:`dictionary`</span>
355<span class="sd">        Contains the environment parameter ecuid, ecgid, gateway</span>
356<span class="sd">        and destination for ECMWF server environments.</span>
357<span class="sd">    &#39;&#39;&#39;</span>
358    <span class="n">envs</span><span class="o">=</span> <span class="p">{}</span>
359
360    <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">&#39;r&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
361        <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">f</span><span class="p">:</span>
362            <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>
363            <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>
364
365    <span class="k">return</span> <span class="n">envs</span></div>
366
367<div class="viewcode-block" id="clean_up"><a class="viewcode-back" href="../api.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>
368    <span class="sd">&#39;&#39;&#39;Remove all files from intermediate directory (inputdir).</span>
369
370<span class="sd">    Parameters</span>
371<span class="sd">    ----------</span>
372<span class="sd">    c : :obj:`ControlFile`</span>
373<span class="sd">        Contains all the parameters of CONTROL file and</span>
374<span class="sd">        command line.</span>
375
376<span class="sd">    Return</span>
377<span class="sd">    ------</span>
378
379<span class="sd">    &#39;&#39;&#39;</span>
380
381    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;clean_up&quot;</span><span class="p">)</span>
382
383    <span class="n">cleanlist</span> <span class="o">=</span> <span class="n">glob</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">inputdir</span> <span class="o">+</span> <span class="s2">&quot;/*&quot;</span><span class="p">)</span>
384    <span class="k">for</span> <span class="n">clist</span> <span class="ow">in</span> <span class="n">cleanlist</span><span class="p">:</span>
385        <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">prefix</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">clist</span><span class="p">:</span>
386            <span class="n">silent_remove</span><span class="p">(</span><span class="n">clist</span><span class="p">)</span>
387        <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">ecapi</span> <span class="ow">is</span> <span class="kc">False</span> <span class="ow">and</span> <span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">ectrans</span> <span class="o">==</span> <span class="s1">&#39;1&#39;</span> <span class="ow">or</span> <span class="n">c</span><span class="o">.</span><span class="n">ecstorage</span> <span class="o">==</span> <span class="s1">&#39;1&#39;</span><span class="p">):</span>
388            <span class="n">silent_remove</span><span class="p">(</span><span class="n">clist</span><span class="p">)</span>
389
390    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Done&quot;</span><span class="p">)</span>
391
392    <span class="k">return</span></div>
393
394
395<div class="viewcode-block" id="my_error"><a class="viewcode-back" href="../api.html#tools.my_error">[docs]</a><span class="k">def</span> <span class="nf">my_error</span><span class="p">(</span><span class="n">users</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="s1">&#39;ERROR&#39;</span><span class="p">):</span>
396    <span class="sd">&#39;&#39;&#39;Prints a specified error message which can be passed to the function</span>
397<span class="sd">    before exiting the program.</span>
398
399<span class="sd">    Parameters</span>
400<span class="sd">    ----------</span>
401<span class="sd">    user : :obj:`list` of :obj:`string`</span>
402<span class="sd">        Contains all email addresses which should be notified.</span>
403<span class="sd">        It might also contain just the ecmwf user name which wil trigger</span>
404<span class="sd">        mailing to the associated email address for this user.</span>
405
406<span class="sd">    message : :obj:`string`, optional</span>
407<span class="sd">        Error message. Default value is &quot;ERROR&quot;.</span>
408
409<span class="sd">    Return</span>
410<span class="sd">    ------</span>
411
412<span class="sd">    &#39;&#39;&#39;</span>
413
414    <span class="nb">print</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
415
416    <span class="c1"># comment if user does not want email notification directly from python</span>
417    <span class="k">for</span> <span class="n">user</span> <span class="ow">in</span> <span class="n">users</span><span class="p">:</span>
418        <span class="k">if</span> <span class="s1">&#39;$</span><span class="si">{USER}</span><span class="s1">&#39;</span> <span class="ow">in</span> <span class="n">user</span><span class="p">:</span>
419            <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">&#39;USER&#39;</span><span class="p">)</span>
420        <span class="k">try</span><span class="p">:</span>
421            <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">&#39;mail&#39;</span><span class="p">,</span> <span class="s1">&#39;-s flex_extract_v7.1 ERROR&#39;</span><span class="p">,</span>
422                                  <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>
423                                 <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>
424                                 <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>
425                                 <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>
426                                 <span class="n">bufsize</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
427            <span class="n">trace</span> <span class="o">=</span> <span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</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>
428            <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="s1">&#39;</span><span class="se">\n\n</span><span class="s1">&#39;</span> <span class="o">+</span> <span class="n">trace</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
429        <span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
430            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;ERROR: &#39;</span><span class="p">,</span> <span class="n">e</span><span class="p">)</span>
431            <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">&#39;Email could not be sent!&#39;</span><span class="p">)</span>
432        <span class="k">else</span><span class="p">:</span>
433            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Email sent to &#39;</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> <span class="o">+</span> <span class="s1">&#39; &#39;</span> <span class="o">+</span>
434                  <span class="n">pout</span><span class="o">.</span><span class="n">decode</span><span class="p">())</span>
435
436    <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>
437
438    <span class="k">return</span></div>
439
440
441<div class="viewcode-block" id="normal_exit"><a class="viewcode-back" href="../api.html#tools.normal_exit">[docs]</a><span class="k">def</span> <span class="nf">normal_exit</span><span class="p">(</span><span class="n">users</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="s1">&#39;Done!&#39;</span><span class="p">):</span>
442    <span class="sd">&#39;&#39;&#39;Prints a specific exit message which can be passed to the function.</span>
443
444<span class="sd">    Parameters</span>
445<span class="sd">    ----------</span>
446<span class="sd">    user : :obj:`list` of :obj:`string`</span>
447<span class="sd">        Contains all email addresses which should be notified.</span>
448<span class="sd">        It might also contain just the ecmwf user name which wil trigger</span>
449<span class="sd">        mailing to the associated email address for this user.</span>
450
451<span class="sd">    message : :obj:`string`, optional</span>
452<span class="sd">        Message for exiting program. Default value is &quot;Done!&quot;.</span>
453
454<span class="sd">    Return</span>
455<span class="sd">    ------</span>
456
457<span class="sd">    &#39;&#39;&#39;</span>
458    <span class="nb">print</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
459
460    <span class="c1"># comment if user does not want notification directly from python</span>
461    <span class="k">for</span> <span class="n">user</span> <span class="ow">in</span> <span class="n">users</span><span class="p">:</span>
462        <span class="k">if</span> <span class="s1">&#39;$</span><span class="si">{USER}</span><span class="s1">&#39;</span> <span class="ow">in</span> <span class="n">user</span><span class="p">:</span>
463            <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">&#39;USER&#39;</span><span class="p">)</span>
464        <span class="k">try</span><span class="p">:</span>
465            <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">&#39;mail&#39;</span><span class="p">,</span> <span class="s1">&#39;-s flex_extract_v7.1 normal exit&#39;</span><span class="p">,</span>
466                                  <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>
467                                 <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>
468                                 <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>
469                                 <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>
470                                 <span class="n">bufsize</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
471            <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="s1">&#39;</span><span class="se">\n\n</span><span class="s1">&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
472        <span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
473            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;ERROR: &#39;</span><span class="p">,</span> <span class="n">e</span><span class="p">)</span>
474            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Email could not be sent!&#39;</span><span class="p">)</span>
475        <span class="k">else</span><span class="p">:</span>
476            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Email sent to &#39;</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> <span class="o">+</span> <span class="s1">&#39; &#39;</span> <span class="o">+</span>
477                  <span class="n">pout</span><span class="o">.</span><span class="n">decode</span><span class="p">())</span>
478
479    <span class="k">return</span></div>
480
481
482<div class="viewcode-block" id="product"><a class="viewcode-back" href="../api.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>
483    <span class="sd">&#39;&#39;&#39;This method combines the single characters of the passed arguments</span>
484<span class="sd">    with each other. So that each character of each argument value</span>
485<span class="sd">    will be combined with each character of the other arguments as a tuple.</span>
486
487<span class="sd">    Note</span>
488<span class="sd">    ----</span>
489<span class="sd">    This method is taken from an example at the ECMWF wiki website.</span>
490<span class="sd">    https://software.ecmwf.int/wiki/display/GRIB/index.py; 2018-03-16</span>
491
492<span class="sd">    Example</span>
493<span class="sd">    -------</span>
494<span class="sd">    product(&#39;ABCD&#39;, &#39;xy&#39;) --&gt; Ax Ay Bx By Cx Cy Dx Dy</span>
495
496<span class="sd">    product(range(2), repeat = 3) --&gt; 000 001 010 011 100 101 110 111</span>
497
498<span class="sd">    Parameters</span>
499<span class="sd">    ----------</span>
500<span class="sd">    \*args : :obj:`tuple`</span>
501<span class="sd">        Positional arguments (arbitrary number).</span>
502
503<span class="sd">    \*\*kwds : :obj:`dictionary`</span>
504<span class="sd">        Contains all the keyword arguments from \*args.</span>
505
506<span class="sd">    Return</span>
507<span class="sd">    ------</span>
508<span class="sd">    prod : :obj:`tuple`</span>
509<span class="sd">        Return will be done with &quot;yield&quot;. A tuple of combined arguments.</span>
510<span class="sd">        See example in description above.</span>
511<span class="sd">    &#39;&#39;&#39;</span>
512    <span class="n">pools</span> <span class="o">=</span> <span class="nb">map</span><span class="p">(</span><span class="nb">tuple</span><span class="p">,</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">&#39;repeat&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
513    <span class="n">result</span> <span class="o">=</span> <span class="p">[[]]</span>
514    <span class="k">for</span> <span class="n">pool</span> <span class="ow">in</span> <span class="n">pools</span><span class="p">:</span>
515        <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>
516    <span class="k">for</span> <span class="n">prod</span> <span class="ow">in</span> <span class="n">result</span><span class="p">:</span>
517        <span class="k">yield</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">prod</span><span class="p">)</span>
518
519    <span class="k">return</span></div>
520
521
522<div class="viewcode-block" id="silent_remove"><a class="viewcode-back" href="../api.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>
523    <span class="sd">&#39;&#39;&#39;Remove file if it exists.</span>
524<span class="sd">    The function does not fail if the file does not exist.</span>
525
526<span class="sd">    Parameters</span>
527<span class="sd">    ----------</span>
528<span class="sd">    filename : :obj:`string`</span>
529<span class="sd">        The name of the file to be removed without notification.</span>
530
531<span class="sd">    Return</span>
532<span class="sd">    ------</span>
533
534<span class="sd">    &#39;&#39;&#39;</span>
535    <span class="k">try</span><span class="p">:</span>
536        <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>
537    <span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
538        <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>
539            <span class="c1"># errno.ENOENT  =  no such file or directory</span>
540            <span class="k">raise</span>  <span class="c1"># re-raise exception if a different error occured</span>
541
542    <span class="k">return</span></div>
543
544
545<div class="viewcode-block" id="init128"><a class="viewcode-back" href="../api.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>
546    <span class="sd">&#39;&#39;&#39;Opens and reads the grib file with table 128 information.</span>
547
548<span class="sd">    Parameters</span>
549<span class="sd">    ----------</span>
550<span class="sd">    filepath : :obj:`string`</span>
551<span class="sd">        Path to file of ECMWF grib table number 128.</span>
552
553<span class="sd">    Return</span>
554<span class="sd">    ------</span>
555<span class="sd">    table128 : :obj:`dictionary`</span>
556<span class="sd">        Contains the ECMWF grib table 128 information.</span>
557<span class="sd">        The key is the parameter number and the value is the</span>
558<span class="sd">        short name of the parameter.</span>
559<span class="sd">    &#39;&#39;&#39;</span>
560    <span class="n">table128</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">()</span>
561    <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>
562        <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">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>
563    <span class="k">for</span> <span class="n">data</span> <span class="ow">in</span> <span class="n">fdata</span><span class="p">:</span>
564        <span class="k">if</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">&#39;!&#39;</span><span class="p">:</span>
565            <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">64</span><span class="p">]</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span>
566
567    <span class="k">return</span> <span class="n">table128</span></div>
568
569
570<div class="viewcode-block" id="to_param_id"><a class="viewcode-back" href="../api.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>
571    <span class="sd">&#39;&#39;&#39;Transform parameter names to parameter ids with ECMWF grib table 128.</span>
572
573<span class="sd">    Parameters</span>
574<span class="sd">    ----------</span>
575<span class="sd">    pars : :obj:`string`</span>
576<span class="sd">        Addpar argument from CONTROL file in the format of</span>
577<span class="sd">        parameter names instead of ids. The parameter short</span>
578<span class="sd">        names are sepearted with &quot;/&quot; and they are passed as</span>
579<span class="sd">        one single string.</span>
580
581<span class="sd">    table : :obj:`dictionary`</span>
582<span class="sd">        Contains the ECMWF grib table 128 information.</span>
583<span class="sd">        The key is the parameter number and the value is the</span>
584<span class="sd">        short name of the parameter.</span>
585
586<span class="sd">    Return</span>
587<span class="sd">    ------</span>
588<span class="sd">    ipar : :obj:`list` of :obj:`integer`</span>
589<span class="sd">        List of addpar parameters from CONTROL file transformed to</span>
590<span class="sd">        parameter ids in the format of integer.</span>
591<span class="sd">    &#39;&#39;&#39;</span>
592    <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">&#39;/&#39;</span><span class="p">)</span>
593    <span class="n">ipar</span> <span class="o">=</span> <span class="p">[]</span>
594    <span class="k">for</span> <span class="n">par</span> <span class="ow">in</span> <span class="n">cpar</span><span class="p">:</span>
595        <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">iteritems</span><span class="p">():</span>
596            <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>
597                <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>
598                <span class="k">break</span>
599        <span class="k">else</span><span class="p">:</span>
600            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Warning: par &#39;</span> <span class="o">+</span> <span class="n">par</span> <span class="o">+</span> <span class="s1">&#39; not found in table 128&#39;</span><span class="p">)</span>
601
602    <span class="k">return</span> <span class="n">ipar</span></div>
603
604<div class="viewcode-block" id="get_list_as_string"><a class="viewcode-back" href="../api.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">&#39;, &#39;</span><span class="p">):</span>
605    <span class="sd">&#39;&#39;&#39;Converts a list of arbitrary content into a single string.</span>
606
607<span class="sd">    Parameters</span>
608<span class="sd">    ----------</span>
609<span class="sd">    list_obj : :obj:`list`</span>
610<span class="sd">        A list with arbitrary content.</span>
611
612<span class="sd">    concatenate_sign : :obj:`string`, optional</span>
613<span class="sd">        A string which is used to concatenate the single</span>
614<span class="sd">        list elements. Default value is &quot;, &quot;.</span>
615
616<span class="sd">    Return</span>
617<span class="sd">    ------</span>
618<span class="sd">    str_of_list : :obj:`string`</span>
619<span class="sd">        The content of the list as a single string.</span>
620<span class="sd">    &#39;&#39;&#39;</span>
621
622    <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>
623
624    <span class="k">return</span> <span class="n">str_of_list</span></div>
625
626<div class="viewcode-block" id="make_dir"><a class="viewcode-back" href="../api.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>
627    <span class="sd">&#39;&#39;&#39;Creates a directory and gives a warning if the directory</span>
628<span class="sd">    already exists. The program stops only if there is another problem.</span>
629
630<span class="sd">    Parameters</span>
631<span class="sd">    ----------</span>
632<span class="sd">    directory : :obj:`string`</span>
633<span class="sd">        The directory name including the path which should be created.</span>
634
635<span class="sd">    Return</span>
636<span class="sd">    ------</span>
637
638<span class="sd">    &#39;&#39;&#39;</span>
639    <span class="k">try</span><span class="p">:</span>
640        <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>
641    <span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
642        <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>
643            <span class="c1"># errno.EEXIST = directory already exists</span>
644            <span class="k">raise</span> <span class="c1"># re-raise exception if a different error occured</span>
645        <span class="k">else</span><span class="p">:</span>
646            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;WARNING: Directory </span><span class="si">{0}</span><span class="s1"> already exists!&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">directory</span><span class="p">))</span>
647
648    <span class="k">return</span></div>
649
650<div class="viewcode-block" id="put_file_to_ecserver"><a class="viewcode-back" href="../api.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>
651    <span class="sd">&#39;&#39;&#39;Uses the ecaccess-file-put command to send a file to the ECMWF servers.</span>
652
653<span class="sd">    Note</span>
654<span class="sd">    ----</span>
655<span class="sd">    The return value is just for testing reasons. It does not have</span>
656<span class="sd">    to be used from the calling function since the whole error handling</span>
657<span class="sd">    is done in here.</span>
658
659<span class="sd">    Parameters</span>
660<span class="sd">    ----------</span>
661<span class="sd">    ecd : :obj:`string`</span>
662<span class="sd">        The path were the file is stored.</span>
663
664<span class="sd">    filename : :obj:`string`</span>
665<span class="sd">        The name of the file to send to the ECMWF server.</span>
666
667<span class="sd">    target : :obj:`string`</span>
668<span class="sd">        The target queue where the file should be sent to.</span>
669
670<span class="sd">    ecuid : :obj:`string`</span>
671<span class="sd">        The user id on ECMWF server.</span>
672
673<span class="sd">    ecgid : :obj:`string`</span>
674<span class="sd">        The group id on ECMWF server.</span>
675
676<span class="sd">    Return</span>
677<span class="sd">    ------</span>
678<span class="sd">    rcode : :obj:`string`</span>
679<span class="sd">        Resulting code of command execution. If successful the string</span>
680<span class="sd">        will be empty.</span>
681<span class="sd">    &#39;&#39;&#39;</span>
682
683    <span class="k">try</span><span class="p">:</span>
684        <span class="n">rcode</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">&#39;ecaccess-file-put&#39;</span><span class="p">,</span>
685                                          <span class="n">ecd</span> <span class="o">+</span> <span class="s1">&#39;/&#39;</span> <span class="o">+</span> <span class="n">filename</span><span class="p">,</span>
686                                          <span class="n">target</span> <span class="o">+</span> <span class="s1">&#39;:/home/ms/&#39;</span> <span class="o">+</span>
687                                          <span class="n">ecgid</span> <span class="o">+</span> <span class="s1">&#39;/&#39;</span> <span class="o">+</span> <span class="n">ecuid</span> <span class="o">+</span>
688                                          <span class="s1">&#39;/&#39;</span> <span class="o">+</span> <span class="n">filename</span><span class="p">],</span>
689                                         <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>
690    <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>
691        <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;... ERROR CODE:</span><span class="se">\n</span><span class="s1"> ... &#39;</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>
692        <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> ... &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
693
694        <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">... Do you have a valid ecaccess certification key?&#39;</span><span class="p">)</span>
695        <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">&#39;... ECACCESS-FILE-PUT FAILED!&#39;</span><span class="p">)</span>
696
697    <span class="k">return</span> <span class="n">rcode</span></div>
698
699<div class="viewcode-block" id="submit_job_to_ecserver"><a class="viewcode-back" href="../api.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>
700    <span class="sd">&#39;&#39;&#39;Uses ecaccess-job-submit command to submit a job to the ECMWF server.</span>
701
702<span class="sd">    Note</span>
703<span class="sd">    ----</span>
704<span class="sd">    The return value is just for testing reasons. It does not have</span>
705<span class="sd">    to be used from the calling function since the whole error handling</span>
706<span class="sd">    is done in here.</span>
707
708<span class="sd">    Parameters</span>
709<span class="sd">    ----------</span>
710<span class="sd">    target : :obj:`string`</span>
711<span class="sd">        The target where the file should be sent to, e.g. the queue.</span>
712
713<span class="sd">    jobname : :obj:`string`</span>
714<span class="sd">        The name of the jobfile to be submitted to the ECMWF server.</span>
715
716<span class="sd">    Return</span>
717<span class="sd">    ------</span>
718<span class="sd">    rcode : :obj:`string`</span>
719<span class="sd">        Resulting code of command execution. If successful the string</span>
720<span class="sd">        will contain an integer number, representing the id of the job</span>
721<span class="sd">        at the ecmwf server.</span>
722<span class="sd">    &#39;&#39;&#39;</span>
723
724    <span class="k">try</span><span class="p">:</span>
725        <span class="n">rcode</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">&#39;ecaccess-job-submit&#39;</span><span class="p">,</span>
726                                         <span class="s1">&#39;-queueName&#39;</span><span class="p">,</span> <span class="n">target</span><span class="p">,</span>
727                                         <span class="n">jobname</span><span class="p">])</span>
728    <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>
729        <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;... ERROR CODE:</span><span class="se">\n</span><span class="s1"> ... &#39;</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>
730        <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> ... &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
731
732
733        <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">... Do you have a valid ecaccess certification key?&#39;</span><span class="p">)</span>
734        <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">&#39;... ECACCESS-JOB-SUBMIT FAILED!&#39;</span><span class="p">)</span>
735
736    <span class="k">return</span> <span class="n">rcode</span></div>
737</pre></div>
738
739           </div>
740           
741          </div>
742          <footer>
743 
744
745  <hr/>
746
747  <div role="contentinfo">
748    <p>
749        &copy; Copyright 2018, Anne Philipp and Leopold Haimberger.
750
751    </p>
752  </div>
753  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>.
754
755</footer>
756
757        </div>
758      </div>
759
760    </section>
761
762  </div>
763 
764
765
766 
767
768    <script type="text/javascript">
769        var DOCUMENTATION_OPTIONS = {
770            URL_ROOT:'../',
771            VERSION:'7.1 alpha',
772            LANGUAGE:'None',
773            COLLAPSE_INDEX:false,
774            FILE_SUFFIX:'.html',
775            HAS_SOURCE:  true,
776            SOURCELINK_SUFFIX: '.txt'
777        };
778    </script>
779      <script type="text/javascript" src="../_static/jquery.js"></script>
780      <script type="text/javascript" src="../_static/underscore.js"></script>
781      <script type="text/javascript" src="../_static/doctools.js"></script>
782      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
783
784 
785
786  <script type="text/javascript" src="../_static/js/theme.js"></script>
787
788  <script type="text/javascript">
789      jQuery(function () {
790          SphinxRtdTheme.Navigation.enable(true);
791      });
792  </script> 
793
794</body>
795</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG