source: flex_extract.git/Documentation/html/_modules/ControlFile.html @ 30f7911

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

reviewed installation section of online documentation; minor corrections
  • Property mode set to 100644
File size: 73.9 KB
Line 
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7  <meta charset="utf-8">
8 
9  <meta name="viewport" content="width=device-width, initial-scale=1.0">
10 
11  <title>ControlFile &mdash; flex_extract 7.1 alpha documentation</title>
12 
13
14 
15 
16 
17 
18
19 
20  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
21 
22   
23      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
24        <script type="text/javascript" src="../_static/jquery.js"></script>
25        <script type="text/javascript" src="../_static/underscore.js"></script>
26        <script type="text/javascript" src="../_static/doctools.js"></script>
27        <script type="text/javascript" src="../_static/language_data.js"></script>
28        <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
29   
30    <script type="text/javascript" src="../_static/js/theme.js"></script>
31
32   
33
34 
35  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
36  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
37  <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
38  <link rel="stylesheet" href="../_static/css/theme_overrides.css" type="text/css" />
39    <link rel="index" title="Index" href="../genindex.html" />
40    <link rel="search" title="Search" href="../search.html" /> 
41</head>
42
43<body class="wy-body-for-nav">
44
45   
46  <div class="wy-grid-for-nav">
47   
48    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
49      <div class="wy-side-scroll">
50        <div class="wy-side-nav-search" >
51         
52
53         
54            <a href="../index.html" class="icon icon-home"> flex_extract
55         
56
57         
58          </a>
59
60         
61           
62           
63              <div class="version">
64                7.1
65              </div>
66           
67         
68
69         
70<div role="search">
71  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
72    <input type="text" name="q" placeholder="Search docs" />
73    <input type="hidden" name="check_keywords" value="yes" />
74    <input type="hidden" name="area" value="default" />
75  </form>
76</div>
77
78         
79        </div>
80
81        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
82         
83           
84           
85             
86           
87           
88              <p class="caption"><span class="caption-text">Table of Contents:</span></p>
89<ul>
90<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
91<li class="toctree-l1"><a class="reference internal" href="../quick_start.html">Quick Start</a></li>
92<li class="toctree-l1"><a class="reference internal" href="../ecmwf_data.html">ECMWF Data</a></li>
93<li class="toctree-l1"><a class="reference internal" href="../documentation.html">Documentation</a></li>
94<li class="toctree-l1"><a class="reference internal" href="../evaluation.html">Evaluation</a></li>
95<li class="toctree-l1"><a class="reference internal" href="../dev_guide.html">Developer Guide</a></li>
96<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
97<li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li>
98<li class="toctree-l1"><a class="reference internal" href="../Support/faq.html">FAQ - Frequently asked questions</a></li>
99<li class="toctree-l1"><a class="reference internal" href="../authors.html">Developer Team</a></li>
100</ul>
101
102           
103         
104        </div>
105      </div>
106    </nav>
107
108    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
109
110     
111      <nav class="wy-nav-top" aria-label="top navigation">
112       
113          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
114          <a href="../index.html">flex_extract</a>
115       
116      </nav>
117
118
119      <div class="wy-nav-content">
120       
121        <div class="rst-content">
122       
123         
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139<div role="navigation" aria-label="breadcrumbs navigation">
140
141  <ul class="wy-breadcrumbs">
142   
143      <li><a href="../index.html">Docs</a> &raquo;</li>
144       
145          <li><a href="index.html">Module code</a> &raquo;</li>
146       
147      <li>ControlFile</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 ControlFile</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: Leopold Haimberger (University of Vienna)</span>
167<span class="c1">#</span>
168<span class="c1"># @Date: November 2015</span>
169<span class="c1">#</span>
170<span class="c1"># @Change History:</span>
171<span class="c1">#</span>
172<span class="c1">#   February 2018 - Anne Philipp (University of Vienna):</span>
173<span class="c1">#        - applied PEP8 style guide</span>
174<span class="c1">#        - added documentation</span>
175<span class="c1">#        - applied some minor modifications in programming style/structure</span>
176<span class="c1">#        - changed name of class Control to ControlFile for more</span>
177<span class="c1">#          self-explanation naming</span>
178<span class="c1">#        - outsource of class ControlFile</span>
179<span class="c1">#        - initialisation of class attributes ( to avoid high number of</span>
180<span class="c1">#          conditional statements and set default values )</span>
181<span class="c1">#        - divided assignment of attributes and the check of conditions</span>
182<span class="c1">#        - outsourced the commandline argument assignments to control attributes</span>
183<span class="c1">#</span>
184<span class="c1"># @License:</span>
185<span class="c1">#    (C) Copyright 2014-2019.</span>
186<span class="c1">#    Anne Philipp, Leopold Haimberger</span>
187<span class="c1">#</span>
188<span class="c1">#    SPDX-License-Identifier: CC-BY-4.0</span>
189<span class="c1">#</span>
190<span class="c1">#    This work is licensed under the Creative Commons Attribution 4.0</span>
191<span class="c1">#    International License. To view a copy of this license, visit</span>
192<span class="c1">#    http://creativecommons.org/licenses/by/4.0/ or send a letter to</span>
193<span class="c1">#    Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</span>
194<span class="c1">#*******************************************************************************</span>
195
196<span class="c1"># ------------------------------------------------------------------------------</span>
197<span class="c1"># MODULES</span>
198<span class="c1"># ------------------------------------------------------------------------------</span>
199<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span>
200
201<span class="kn">import</span> <span class="nn">os</span>
202<span class="kn">import</span> <span class="nn">re</span>
203<span class="kn">import</span> <span class="nn">sys</span>
204<span class="kn">import</span> <span class="nn">inspect</span>
205
206<span class="c1"># software specific classes and modules from flex_extract</span>
207<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s1">&#39;../&#39;</span><span class="p">)</span>
208<span class="kn">import</span> <span class="nn">_config</span>
209<span class="kn">from</span> <span class="nn">Mods.tools</span> <span class="k">import</span> <span class="n">my_error</span><span class="p">,</span> <span class="n">silent_remove</span>
210<span class="kn">from</span> <span class="nn">Mods.checks</span> <span class="k">import</span> <span class="p">(</span><span class="n">check_grid</span><span class="p">,</span> <span class="n">check_area</span><span class="p">,</span> <span class="n">check_levels</span><span class="p">,</span> <span class="n">check_purefc</span><span class="p">,</span>
211                         <span class="n">check_step</span><span class="p">,</span> <span class="n">check_mail</span><span class="p">,</span> <span class="n">check_queue</span><span class="p">,</span> <span class="n">check_pathes</span><span class="p">,</span>
212                         <span class="n">check_dates</span><span class="p">,</span> <span class="n">check_maxstep</span><span class="p">,</span> <span class="n">check_type</span><span class="p">,</span> <span class="n">check_request</span><span class="p">,</span>
213                         <span class="n">check_basetime</span><span class="p">,</span> <span class="n">check_public</span><span class="p">,</span> <span class="n">check_acctype</span><span class="p">,</span>
214                         <span class="n">check_acctime</span><span class="p">,</span> <span class="n">check_accmaxstep</span><span class="p">,</span> <span class="n">check_time</span><span class="p">,</span>
215                         <span class="n">check_logicals_type</span><span class="p">,</span> <span class="n">check_len_type_time_step</span><span class="p">,</span>
216                         <span class="n">check_addpar</span><span class="p">,</span> <span class="n">check_job_chunk</span><span class="p">,</span> <span class="n">check_number</span><span class="p">)</span>
217
218<span class="c1"># ------------------------------------------------------------------------------</span>
219<span class="c1"># CLASS</span>
220<span class="c1"># ------------------------------------------------------------------------------</span>
221<div class="viewcode-block" id="ControlFile"><a class="viewcode-back" href="../Documentation/Api/api_python.html#ControlFile.ControlFile">[docs]</a><span class="k">class</span> <span class="nc">ControlFile</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
222    <span class="sd">&#39;&#39;&#39;</span>
223<span class="sd">    Contains the information which are stored in the CONTROL files.</span>
224
225<span class="sd">    The CONTROL file is the steering part of the FLEXPART extraction</span>
226<span class="sd">    software. All necessary parameters needed to retrieve the data fields</span>
227<span class="sd">    from the MARS archive for driving FLEXPART are set in a CONTROL file.</span>
228<span class="sd">    Some specific parameters like the start and end dates can be overwritten</span>
229<span class="sd">    by the command line parameters, but in generel all parameters needed</span>
230<span class="sd">    for a complete set of fields for FLEXPART can be set in the CONTROL file.</span>
231
232<span class="sd">    Attributes</span>
233<span class="sd">    ----------</span>
234<span class="sd">    controlfile : str</span>
235<span class="sd">        The name of the control file to be processed. Default value is the</span>
236<span class="sd">        filename passed to the init function when initialised.</span>
237
238<span class="sd">    start_date : str</span>
239<span class="sd">        The first day of the retrieval period. Default value is None.</span>
240
241<span class="sd">    end_date :str</span>
242<span class="sd">        The last day of the retrieval period. Default value is None.</span>
243
244<span class="sd">    date_chunk : int</span>
245<span class="sd">        Length of period for a single mars retrieval. Default value is 3.</span>
246
247<span class="sd">    dtime :str</span>
248<span class="sd">        The time step in hours. Default value is None.</span>
249
250<span class="sd">    basetime : int</span>
251<span class="sd">        The time for a half day retrieval. The 12 hours upfront are to be</span>
252<span class="sd">        retrieved. Default value is None.</span>
253
254<span class="sd">    maxstep : int</span>
255<span class="sd">        The maximum forecast step for non flux data. Default value is None.</span>
256
257<span class="sd">    type : list of str</span>
258<span class="sd">        List of field type per retrieving hour. Default value is None.</span>
259
260<span class="sd">    time : list of str</span>
261<span class="sd">        List of retrieving times in hours. Default valuer is None.</span>
262
263<span class="sd">    step : list of str or str</span>
264<span class="sd">        List of forecast time steps in hours for non flux data.</span>
265<span class="sd">        Default value is None.</span>
266
267<span class="sd">    acctype : str</span>
268<span class="sd">        The field type for the accumulated forecast fields.</span>
269<span class="sd">        Default value is None.</span>
270
271<span class="sd">    acctime : str</span>
272<span class="sd">        The starting time of the accumulated forecasts. Default value is None.</span>
273
274<span class="sd">    accmaxstep : int</span>
275<span class="sd">        The maximum forecast step for the accumulated forecast fields</span>
276<span class="sd">        (flux data). Default value is None.</span>
277
278<span class="sd">    marsclass : str</span>
279<span class="sd">        Characterisation of dataset. Default value is None.</span>
280
281<span class="sd">    dataset : str</span>
282<span class="sd">        For public datasets there is the specific naming and parameter</span>
283<span class="sd">        dataset which has to be used to characterize the type of</span>
284<span class="sd">        data. Default value is None.</span>
285
286<span class="sd">    stream : str</span>
287<span class="sd">        Identifies the forecasting system used to generate the data.</span>
288<span class="sd">        Default value is None.</span>
289
290<span class="sd">    number : str</span>
291<span class="sd">        Selects the member in ensemble forecast run. Default value is &#39;OFF&#39;.</span>
292
293<span class="sd">    expver : str</span>
294<span class="sd">        The version number of the dataset. Default value is &#39;1&#39;.</span>
295
296<span class="sd">    gaussian : str</span>
297<span class="sd">        This parameter is deprecated and should no longer be used.</span>
298<span class="sd">        Specifies the desired type of Gaussian grid for the output.</span>
299<span class="sd">        Default value is an empty string &#39;&#39;.</span>
300
301<span class="sd">    grid : str</span>
302<span class="sd">        Specifies the output grid which can be either a Gaussian grid</span>
303<span class="sd">        or a Latitude/Longitude grid. Default value is None.</span>
304
305<span class="sd">    area : str</span>
306<span class="sd">        Specifies the desired sub-area of data to be extracted.</span>
307<span class="sd">        Default value is None.</span>
308
309<span class="sd">    left : str</span>
310<span class="sd">        The western most longitude of the area to be extracted.</span>
311<span class="sd">        Default value is None.</span>
312
313<span class="sd">    lower : str</span>
314<span class="sd">        The southern most latitude of the area to be extracted.</span>
315<span class="sd">        Default value is None.</span>
316
317<span class="sd">    upper : str</span>
318<span class="sd">        The northern most latitued of the area to be extracted.</span>
319<span class="sd">        Default value is None.</span>
320
321<span class="sd">    right : str</span>
322<span class="sd">        The eastern most longitude of the area to be extracted.</span>
323<span class="sd">        Default value is None.</span>
324
325<span class="sd">    level : str</span>
326<span class="sd">        Specifies the maximum level. Default value is None.</span>
327
328<span class="sd">    levelist : str</span>
329<span class="sd">        Specifies the required level list. Default value is None.</span>
330
331<span class="sd">    resol : str</span>
332<span class="sd">        Specifies the desired triangular truncation of retrieved data,</span>
333<span class="sd">        before carrying out any other selected post-processing.</span>
334<span class="sd">        Default value is None.</span>
335
336<span class="sd">    gauss : int</span>
337<span class="sd">        Switch to select gaussian fields (1) or regular lat/lon (0).</span>
338<span class="sd">        Default value is 0.</span>
339
340<span class="sd">    accuracy : int</span>
341<span class="sd">        Specifies the number of bits per value to be used in the</span>
342<span class="sd">        generated GRIB coded fields. Default value is 24.</span>
343
344<span class="sd">    omega : int</span>
345<span class="sd">       Switch to select omega retrieval (1) or not (0). Default value is 0.</span>
346
347<span class="sd">    omegadiff : int</span>
348<span class="sd">        Switch to decide to calculate Omega and Dps/Dt from continuity</span>
349<span class="sd">        equation for diagnostic purposes (1) or not (0). Default value is 0.</span>
350
351<span class="sd">    eta : int</span>
352<span class="sd">        Switch to select direct retrieval of etadot from MARS (1) or</span>
353<span class="sd">        wether it has to be calculated (0). Then Default value is 0.</span>
354
355<span class="sd">    etadiff : int</span>
356<span class="sd">        Switch to select calculation of etadot and Dps/Dt from continuity</span>
357<span class="sd">        equation for diagnostic purposes (1) or not (0). Default value is 0.</span>
358
359<span class="sd">    etapar : int</span>
360<span class="sd">        GRIB parameter Id for etadot fields. Default value is 77.</span>
361
362<span class="sd">    dpdeta : int</span>
363<span class="sd">        Switch to select multiplication of etadot with dpdeta.</span>
364<span class="sd">        Default value is 1.</span>
365
366<span class="sd">    smooth : int</span>
367<span class="sd">        Spectral truncation of ETADOT after calculation on Gaussian grid.</span>
368<span class="sd">        Default value is 0.</span>
369
370<span class="sd">    format : str</span>
371<span class="sd">        The format of the GRIB data. Default value is &#39;GRIB1&#39;.</span>
372
373<span class="sd">    addpar : str</span>
374<span class="sd">        List of additional surface level ECMWF parameter to be retrieved.</span>
375<span class="sd">        Default value is None.</span>
376
377<span class="sd">    prefix : str</span>
378<span class="sd">        Prefix string for the final FLEXPART/FLEXTRA ready input files.</span>
379<span class="sd">        Default value is &#39;EN&#39;.</span>
380
381<span class="sd">    cwc : int</span>
382<span class="sd">        Switch to select wether the sum of cloud liquid water content and</span>
383<span class="sd">        cloud ice water content should be retrieved. Default value is 0.</span>
384
385<span class="sd">    wrf : int</span>
386<span class="sd">        Switch to select further parameters for retrievment to support</span>
387<span class="sd">        WRF simulations. Default value is 0.</span>
388
389<span class="sd">    ecfsdir : str</span>
390<span class="sd">        Path to the ECMWF storage  &#39;ectmp:/${USER}/econdemand/&#39;</span>
391
392<span class="sd">    mailfail : list of str</span>
393<span class="sd">        Email list for sending error log files from ECMWF servers.</span>
394<span class="sd">        The email addresses should be seperated by a comma.</span>
395<span class="sd">        Default value is [&#39;${USER}&#39;].</span>
396
397<span class="sd">    mailops : list of str</span>
398<span class="sd">        Email list for sending operational log files from ECMWF servers.</span>
399<span class="sd">        The email addresses should be seperated by a comma.</span>
400<span class="sd">        Default value is [&#39;${USER}&#39;].</span>
401
402<span class="sd">    grib2flexpart : int 0</span>
403<span class="sd">        Switch to select generation of preprocessed FLEXPART files &quot;.fp&quot;.</span>
404<span class="sd">        If it is selected, the program grib2flexpart will try</span>
405<span class="sd">        to convert the flex_extract output files into &quot;.fp&quot; format.</span>
406
407<span class="sd">    ecstorage : int</span>
408<span class="sd">        Switch to select storage of FLEXPART ready output files</span>
409<span class="sd">        in the ECFS file system. Default value is 0.</span>
410
411<span class="sd">    ectrans : int</span>
412<span class="sd">        Switch to select the transfer of FLEXPART ready output files</span>
413<span class="sd">        to the gateway server. Default value is 0.</span>
414
415<span class="sd">    inputdir : str</span>
416<span class="sd">        Path to the temporary directory for the retrieval grib files and</span>
417<span class="sd">        other processing files. Default value is _config.PATH_INPUT_DIR.</span>
418
419<span class="sd">    outputdir : str</span>
420<span class="sd">        Path to the final directory where the final FLEXPART ready input</span>
421<span class="sd">        files are stored. Default value is None.</span>
422
423<span class="sd">    flexextractdir : str</span>
424<span class="sd">        Path to the flex_extract root directory. Default value is</span>
425<span class="sd">        _config.PATH_FLEXEXTRACT_DIR.</span>
426
427<span class="sd">    exedir : str</span>
428<span class="sd">        Path to the FORTRAN executable file. Default value is</span>
429<span class="sd">        _config.PATH_FORTRAN_SRC.</span>
430
431<span class="sd">    installdir : str</span>
432<span class="sd">        Path to a FLEXPART root directory. Default value is None.</span>
433
434<span class="sd">    makefile : str</span>
435<span class="sd">        Name of the makefile to be used for the Fortran program.</span>
436<span class="sd">        Default value is &#39;Makefile.gfortran&#39;.</span>
437
438<span class="sd">    destination : str</span>
439<span class="sd">        The remote destination which is used to transfer files</span>
440<span class="sd">        from ECMWF server to local gateway server. Default value is None.</span>
441
442<span class="sd">    gateway : str</span>
443<span class="sd">        The gateway server the user is using. Default value is None.</span>
444
445<span class="sd">    ecuid : str</span>
446<span class="sd">        The user id on ECMWF server. Default value is None.</span>
447
448<span class="sd">    ecgid : str</span>
449<span class="sd">        The group id on ECMWF server. Default value is None.</span>
450
451<span class="sd">    install_target : str</span>
452<span class="sd">        Defines the location where the installation is to be done.</span>
453<span class="sd">        Default value is None.</span>
454
455<span class="sd">    debug : int</span>
456<span class="sd">        Switch to keep temporary files at the end of postprocessing (1) or</span>
457<span class="sd">        to delete all temporary files except the final output files (0).</span>
458<span class="sd">        Default value is 0.</span>
459
460<span class="sd">    oper : int</span>
461<span class="sd">        Switch to prepare the operational job script. Start date, end date and</span>
462<span class="sd">        basetime will be prepared with environment variables.</span>
463<span class="sd">        Default value is 0.</span>
464
465<span class="sd">    request : int</span>
466<span class="sd">        Switch to select between just retrieving the data (0), writing the mars</span>
467<span class="sd">        parameter values to a csv file (1) or doing both (2).</span>
468<span class="sd">        Default value is 0.</span>
469
470<span class="sd">    public : int</span>
471<span class="sd">        Switch to select kind of ECMWF Web Api access and the</span>
472<span class="sd">        possible data sets. Public data sets (1) and Memberstate data sets (0).</span>
473<span class="sd">        Default value is 0.</span>
474
475<span class="sd">    ec_api : boolean</span>
476<span class="sd">        Tells wether the ECMWF Web API was able to load or not.</span>
477<span class="sd">        Default value is None.</span>
478
479<span class="sd">    cds_api : boolean</span>
480<span class="sd">        Tells wether the CDS API was able to load or not.</span>
481<span class="sd">        Default value is None.</span>
482
483<span class="sd">    purefc : int</span>
484<span class="sd">        Switch to decide wether the job is a pure forecast retrieval or</span>
485<span class="sd">        coupled with analysis data. Default value is 0.</span>
486
487<span class="sd">    rrint : int</span>
488<span class="sd">        Switch to select between old precipitation disaggregation method (0)</span>
489<span class="sd">        or the new IA3 disaggegration method (1). Default value is 0.</span>
490
491<span class="sd">    doubleelda : int</span>
492<span class="sd">        Switch to select the calculation of extra ensemble members for the</span>
493<span class="sd">        ELDA stream. It doubles the amount of retrieved ensemble members.</span>
494
495<span class="sd">    logicals : list of str</span>
496<span class="sd">        List of the names of logical switches which controls the flow</span>
497<span class="sd">        of the program. Default list is [&#39;gauss&#39;, &#39;omega&#39;, &#39;omegadiff&#39;, &#39;eta&#39;,</span>
498<span class="sd">        &#39;etadiff&#39;, &#39;dpdeta&#39;, &#39;cwc&#39;, &#39;wrf&#39;, &#39;grib2flexpart&#39;, &#39;ecstorage&#39;,</span>
499<span class="sd">        &#39;ectrans&#39;, &#39;debug&#39;, &#39;request&#39;, &#39;public&#39;, &#39;purefc&#39;, &#39;rrint&#39;, &#39;doubleelda&#39;]</span>
500<span class="sd">    &#39;&#39;&#39;</span>
501
502    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
503        <span class="sd">&#39;&#39;&#39;Initialises the instance of ControlFile class and defines</span>
504<span class="sd">        all class attributes with default values. Afterwards calls</span>
505<span class="sd">        function __read_controlfile__ to read parameter from Control file.</span>
506
507<span class="sd">        Parameters</span>
508<span class="sd">        ----------</span>
509<span class="sd">        filename : str</span>
510<span class="sd">            Name of CONTROL file.</span>
511
512<span class="sd">        Return</span>
513<span class="sd">        ------</span>
514
515<span class="sd">        &#39;&#39;&#39;</span>
516
517        <span class="c1"># list of all possible class attributes and their default values</span>
518        <span class="bp">self</span><span class="o">.</span><span class="n">controlfile</span> <span class="o">=</span> <span class="n">filename</span>
519        <span class="bp">self</span><span class="o">.</span><span class="n">start_date</span> <span class="o">=</span> <span class="kc">None</span>
520        <span class="bp">self</span><span class="o">.</span><span class="n">end_date</span> <span class="o">=</span> <span class="kc">None</span>
521        <span class="bp">self</span><span class="o">.</span><span class="n">date_chunk</span> <span class="o">=</span> <span class="mi">3</span>
522        <span class="bp">self</span><span class="o">.</span><span class="n">job_chunk</span> <span class="o">=</span> <span class="kc">None</span>
523        <span class="bp">self</span><span class="o">.</span><span class="n">dtime</span> <span class="o">=</span> <span class="kc">None</span>
524        <span class="bp">self</span><span class="o">.</span><span class="n">basetime</span> <span class="o">=</span> <span class="kc">None</span>
525        <span class="bp">self</span><span class="o">.</span><span class="n">maxstep</span> <span class="o">=</span> <span class="kc">None</span>
526        <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">=</span> <span class="kc">None</span>
527        <span class="bp">self</span><span class="o">.</span><span class="n">time</span> <span class="o">=</span> <span class="kc">None</span>
528        <span class="bp">self</span><span class="o">.</span><span class="n">step</span> <span class="o">=</span> <span class="kc">None</span>
529        <span class="bp">self</span><span class="o">.</span><span class="n">acctype</span> <span class="o">=</span> <span class="kc">None</span>
530        <span class="bp">self</span><span class="o">.</span><span class="n">acctime</span> <span class="o">=</span> <span class="kc">None</span>
531        <span class="bp">self</span><span class="o">.</span><span class="n">accmaxstep</span> <span class="o">=</span> <span class="kc">None</span>
532        <span class="bp">self</span><span class="o">.</span><span class="n">marsclass</span> <span class="o">=</span> <span class="kc">None</span>
533        <span class="bp">self</span><span class="o">.</span><span class="n">dataset</span> <span class="o">=</span> <span class="kc">None</span>
534        <span class="bp">self</span><span class="o">.</span><span class="n">stream</span> <span class="o">=</span> <span class="kc">None</span>
535        <span class="bp">self</span><span class="o">.</span><span class="n">number</span> <span class="o">=</span> <span class="s1">&#39;OFF&#39;</span>
536        <span class="bp">self</span><span class="o">.</span><span class="n">expver</span> <span class="o">=</span> <span class="s1">&#39;1&#39;</span>
537        <span class="bp">self</span><span class="o">.</span><span class="n">gaussian</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
538        <span class="bp">self</span><span class="o">.</span><span class="n">grid</span> <span class="o">=</span> <span class="kc">None</span>
539        <span class="bp">self</span><span class="o">.</span><span class="n">area</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
540        <span class="bp">self</span><span class="o">.</span><span class="n">left</span> <span class="o">=</span> <span class="kc">None</span>
541        <span class="bp">self</span><span class="o">.</span><span class="n">lower</span> <span class="o">=</span> <span class="kc">None</span>
542        <span class="bp">self</span><span class="o">.</span><span class="n">upper</span> <span class="o">=</span> <span class="kc">None</span>
543        <span class="bp">self</span><span class="o">.</span><span class="n">right</span> <span class="o">=</span> <span class="kc">None</span>
544        <span class="bp">self</span><span class="o">.</span><span class="n">level</span> <span class="o">=</span> <span class="kc">None</span>
545        <span class="bp">self</span><span class="o">.</span><span class="n">levelist</span> <span class="o">=</span> <span class="kc">None</span>
546        <span class="bp">self</span><span class="o">.</span><span class="n">resol</span> <span class="o">=</span> <span class="kc">None</span>
547        <span class="bp">self</span><span class="o">.</span><span class="n">gauss</span> <span class="o">=</span> <span class="mi">0</span>
548        <span class="bp">self</span><span class="o">.</span><span class="n">accuracy</span> <span class="o">=</span> <span class="mi">24</span>
549        <span class="bp">self</span><span class="o">.</span><span class="n">omega</span> <span class="o">=</span> <span class="mi">0</span>
550        <span class="bp">self</span><span class="o">.</span><span class="n">omegadiff</span> <span class="o">=</span> <span class="mi">0</span>
551        <span class="bp">self</span><span class="o">.</span><span class="n">eta</span> <span class="o">=</span> <span class="mi">0</span>
552        <span class="bp">self</span><span class="o">.</span><span class="n">etadiff</span> <span class="o">=</span> <span class="mi">0</span>
553        <span class="bp">self</span><span class="o">.</span><span class="n">etapar</span> <span class="o">=</span> <span class="mi">77</span>
554        <span class="bp">self</span><span class="o">.</span><span class="n">dpdeta</span> <span class="o">=</span> <span class="mi">1</span>
555        <span class="bp">self</span><span class="o">.</span><span class="n">smooth</span> <span class="o">=</span> <span class="mi">0</span>
556        <span class="bp">self</span><span class="o">.</span><span class="n">format</span> <span class="o">=</span> <span class="s1">&#39;GRIB1&#39;</span>
557        <span class="bp">self</span><span class="o">.</span><span class="n">addpar</span> <span class="o">=</span> <span class="kc">None</span>
558        <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span> <span class="o">=</span> <span class="s1">&#39;EN&#39;</span>
559        <span class="bp">self</span><span class="o">.</span><span class="n">cwc</span> <span class="o">=</span> <span class="mi">0</span>
560        <span class="bp">self</span><span class="o">.</span><span class="n">wrf</span> <span class="o">=</span> <span class="mi">0</span>
561        <span class="bp">self</span><span class="o">.</span><span class="n">ecfsdir</span> <span class="o">=</span> <span class="s1">&#39;ectmp:/$</span><span class="si">{USER}</span><span class="s1">/econdemand/&#39;</span>
562        <span class="bp">self</span><span class="o">.</span><span class="n">mailfail</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;$</span><span class="si">{USER}</span><span class="s1">&#39;</span><span class="p">]</span>
563        <span class="bp">self</span><span class="o">.</span><span class="n">mailops</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;$</span><span class="si">{USER}</span><span class="s1">&#39;</span><span class="p">]</span>
564        <span class="bp">self</span><span class="o">.</span><span class="n">grib2flexpart</span> <span class="o">=</span> <span class="mi">0</span>
565        <span class="bp">self</span><span class="o">.</span><span class="n">ecstorage</span> <span class="o">=</span> <span class="mi">0</span>
566        <span class="bp">self</span><span class="o">.</span><span class="n">ectrans</span> <span class="o">=</span> <span class="mi">0</span>
567        <span class="bp">self</span><span class="o">.</span><span class="n">inputdir</span> <span class="o">=</span> <span class="n">_config</span><span class="o">.</span><span class="n">PATH_INPUT_DIR</span>
568        <span class="bp">self</span><span class="o">.</span><span class="n">outputdir</span> <span class="o">=</span> <span class="kc">None</span>
569        <span class="bp">self</span><span class="o">.</span><span class="n">flexextractdir</span> <span class="o">=</span> <span class="n">_config</span><span class="o">.</span><span class="n">PATH_FLEXEXTRACT_DIR</span>
570        <span class="bp">self</span><span class="o">.</span><span class="n">exedir</span> <span class="o">=</span> <span class="n">_config</span><span class="o">.</span><span class="n">PATH_FORTRAN_SRC</span>
571        <span class="bp">self</span><span class="o">.</span><span class="n">installdir</span> <span class="o">=</span> <span class="kc">None</span>
572        <span class="bp">self</span><span class="o">.</span><span class="n">makefile</span> <span class="o">=</span> <span class="s1">&#39;Makefile.gfortran&#39;</span>
573        <span class="bp">self</span><span class="o">.</span><span class="n">destination</span> <span class="o">=</span> <span class="kc">None</span>
574        <span class="bp">self</span><span class="o">.</span><span class="n">gateway</span> <span class="o">=</span> <span class="kc">None</span>
575        <span class="bp">self</span><span class="o">.</span><span class="n">ecuid</span> <span class="o">=</span> <span class="kc">None</span>
576        <span class="bp">self</span><span class="o">.</span><span class="n">ecgid</span> <span class="o">=</span> <span class="kc">None</span>
577        <span class="bp">self</span><span class="o">.</span><span class="n">install_target</span> <span class="o">=</span> <span class="kc">None</span>
578        <span class="bp">self</span><span class="o">.</span><span class="n">debug</span> <span class="o">=</span> <span class="mi">0</span>
579        <span class="bp">self</span><span class="o">.</span><span class="n">oper</span> <span class="o">=</span> <span class="mi">0</span>
580        <span class="bp">self</span><span class="o">.</span><span class="n">request</span> <span class="o">=</span> <span class="mi">0</span>
581        <span class="bp">self</span><span class="o">.</span><span class="n">public</span> <span class="o">=</span> <span class="mi">0</span>
582        <span class="bp">self</span><span class="o">.</span><span class="n">ec_api</span> <span class="o">=</span> <span class="kc">None</span>
583        <span class="bp">self</span><span class="o">.</span><span class="n">cds_api</span> <span class="o">=</span> <span class="kc">None</span>
584        <span class="bp">self</span><span class="o">.</span><span class="n">purefc</span> <span class="o">=</span> <span class="mi">0</span>
585        <span class="bp">self</span><span class="o">.</span><span class="n">rrint</span> <span class="o">=</span> <span class="mi">0</span>
586        <span class="bp">self</span><span class="o">.</span><span class="n">doubleelda</span> <span class="o">=</span> <span class="mi">0</span>
587
588        <span class="bp">self</span><span class="o">.</span><span class="n">logicals</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;gauss&#39;</span><span class="p">,</span> <span class="s1">&#39;omega&#39;</span><span class="p">,</span> <span class="s1">&#39;omegadiff&#39;</span><span class="p">,</span> <span class="s1">&#39;eta&#39;</span><span class="p">,</span> <span class="s1">&#39;etadiff&#39;</span><span class="p">,</span>
589                         <span class="s1">&#39;dpdeta&#39;</span><span class="p">,</span> <span class="s1">&#39;cwc&#39;</span><span class="p">,</span> <span class="s1">&#39;wrf&#39;</span><span class="p">,</span> <span class="s1">&#39;grib2flexpart&#39;</span><span class="p">,</span> <span class="s1">&#39;ecstorage&#39;</span><span class="p">,</span>
590                         <span class="s1">&#39;ectrans&#39;</span><span class="p">,</span> <span class="s1">&#39;debug&#39;</span><span class="p">,</span> <span class="s1">&#39;oper&#39;</span><span class="p">,</span> <span class="s1">&#39;request&#39;</span><span class="p">,</span> <span class="s1">&#39;public&#39;</span><span class="p">,</span>
591                         <span class="s1">&#39;purefc&#39;</span><span class="p">,</span> <span class="s1">&#39;rrint&#39;</span><span class="p">,</span> <span class="s1">&#39;doubleelda&#39;</span><span class="p">]</span>
592
593        <span class="bp">self</span><span class="o">.</span><span class="n">_read_controlfile</span><span class="p">()</span>
594
595        <span class="k">return</span>
596
597    <span class="k">def</span> <span class="nf">_read_controlfile</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
598        <span class="sd">&#39;&#39;&#39;Read CONTROL file and assign all CONTROL file variables.</span>
599
600<span class="sd">        Parameters</span>
601<span class="sd">        ----------</span>
602
603<span class="sd">        Return</span>
604<span class="sd">        ------</span>
605
606<span class="sd">        &#39;&#39;&#39;</span>
607
608        <span class="k">try</span><span class="p">:</span>
609            <span class="n">cfile</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">join</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_CONTROLFILES</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">controlfile</span><span class="p">)</span>
610            <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">cfile</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
611                <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>
612        <span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
613            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Could not read CONTROL file &quot;&#39;</span> <span class="o">+</span> <span class="n">cfile</span> <span class="o">+</span> <span class="s1">&#39;&quot;&#39;</span><span class="p">)</span>
614            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Either it does not exist or its syntax is wrong.&#39;</span><span class="p">)</span>
615            <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Try &quot;&#39;</span> <span class="o">+</span> <span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">0</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><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">+</span> \
616                      <span class="s1">&#39; -h&quot; to print usage information&#39;</span><span class="p">)</span>
617            <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>
618
619        <span class="c1"># go through every line and store parameter</span>
620        <span class="k">for</span> <span class="n">ldata</span> <span class="ow">in</span> <span class="n">fdata</span><span class="p">:</span>
621            <span class="k">if</span> <span class="n">ldata</span> <span class="ow">and</span> <span class="n">ldata</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>
622                <span class="c1"># ignore comment line in control file</span>
623                <span class="k">continue</span>
624            <span class="k">if</span> <span class="s1">&#39;#&#39;</span> <span class="ow">in</span> <span class="n">ldata</span><span class="p">:</span>
625                <span class="c1"># cut off comment</span>
626                <span class="n">ldata</span> <span class="o">=</span> <span class="n">ldata</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">&#39;#&#39;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
627            <span class="n">data</span> <span class="o">=</span> <span class="n">ldata</span><span class="o">.</span><span class="n">split</span><span class="p">()</span>
628            <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
629                <span class="k">if</span> <span class="s1">&#39;m_&#39;</span> <span class="ow">in</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="n">lower</span><span class="p">():</span>
630                    <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">0</span><span class="p">][</span><span class="mi">2</span><span class="p">:]</span>
631                <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="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;class&#39;</span><span class="p">:</span>
632                    <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;marsclass&#39;</span>
633                <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="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;day1&#39;</span><span class="p">:</span>
634                    <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;start_date&#39;</span>
635                <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="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;day2&#39;</span><span class="p">:</span>
636                    <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;end_date&#39;</span>
637                <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
638                    <span class="k">if</span> <span class="s1">&#39;$&#39;</span> <span class="ow">in</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
639                        <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</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="n">lower</span><span class="p">(),</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
640                        <span class="k">while</span> <span class="s1">&#39;$&#39;</span> <span class="ow">in</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
641                            <span class="n">i</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="s1">&#39;$&#39;</span><span class="p">)</span>
642                            <span class="n">j</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">&#39;{&#39;</span><span class="p">)</span>
643                            <span class="n">k</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">&#39;}&#39;</span><span class="p">)</span>
644                            <span class="n">var</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="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">][</span><span class="n">j</span><span class="o">+</span><span class="mi">1</span><span class="p">:</span><span class="n">k</span><span class="p">])</span>
645                            <span class="k">if</span> <span class="n">var</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
646                                <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">=</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">][:</span><span class="n">i</span><span class="p">]</span> <span class="o">+</span> <span class="n">var</span> <span class="o">+</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">][</span><span class="n">k</span><span class="o">+</span><span class="mi">1</span><span class="p">:]</span>
647                            <span class="k">else</span><span class="p">:</span>
648                                <span class="n">my_error</span><span class="p">(</span><span class="s1">&#39;Could not find variable &#39;</span>
649                                         <span class="o">+</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">][</span><span class="n">j</span><span class="o">+</span><span class="mi">1</span><span class="p">:</span><span class="n">k</span><span class="p">]</span> <span class="o">+</span> <span class="s1">&#39; while reading &#39;</span> <span class="o">+</span>
650                                         <span class="bp">self</span><span class="o">.</span><span class="n">controlfile</span><span class="p">)</span>
651                        <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</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="n">lower</span><span class="p">()</span> <span class="o">+</span> <span class="s1">&#39;_expanded&#39;</span><span class="p">,</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
652                    <span class="k">else</span><span class="p">:</span>
653                        <span class="k">if</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">!=</span> <span class="s1">&#39;none&#39;</span><span class="p">:</span>
654                            <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</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="n">lower</span><span class="p">(),</span> <span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
655                        <span class="k">else</span><span class="p">:</span>
656                            <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</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="n">lower</span><span class="p">(),</span> <span class="kc">None</span><span class="p">)</span>
657                <span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">2</span><span class="p">:</span>
658                    <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</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="n">lower</span><span class="p">(),</span> <span class="p">(</span><span class="n">data</span><span class="p">[</span><span class="mi">1</span><span class="p">:]))</span>
659            <span class="k">else</span><span class="p">:</span>
660                <span class="k">pass</span>
661
662        <span class="k">return</span>
663
664    <span class="k">def</span> <span class="nf">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
665        <span class="sd">&#39;&#39;&#39;Prepares a string which have all the ControlFile class attributes</span>
666<span class="sd">        with its associated values. Each attribute is printed in one line and</span>
667<span class="sd">        in alphabetical order.</span>
668
669<span class="sd">        Example</span>
670<span class="sd">        -------</span>
671<span class="sd">        &#39;age&#39;: 10</span>
672<span class="sd">        &#39;color&#39;: &#39;Spotted&#39;</span>
673<span class="sd">        &#39;kids&#39;: 0</span>
674<span class="sd">        &#39;legs&#39;: 2</span>
675<span class="sd">        &#39;name&#39;: &#39;Dog&#39;</span>
676<span class="sd">        &#39;smell&#39;: &#39;Alot&#39;</span>
677
678<span class="sd">        Parameters</span>
679<span class="sd">        ----------</span>
680
681<span class="sd">        Return</span>
682<span class="sd">        ------</span>
683<span class="sd">        string</span>
684<span class="sd">            Single string of concatenated ControlFile class attributes</span>
685<span class="sd">            with their values</span>
686<span class="sd">        &#39;&#39;&#39;</span>
687        <span class="kn">import</span> <span class="nn">collections</span>
688
689        <span class="n">attrs</span> <span class="o">=</span> <span class="nb">vars</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
690        <span class="n">attrs</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">OrderedDict</span><span class="p">(</span><span class="nb">sorted</span><span class="p">(</span><span class="n">attrs</span><span class="o">.</span><span class="n">items</span><span class="p">()))</span>
691
692        <span class="k">return</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="s2">&quot;</span><span class="si">%s</span><span class="s2">: </span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">item</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">attrs</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
693
694<div class="viewcode-block" id="ControlFile.assign_args_to_control"><a class="viewcode-back" href="../Documentation/Api/api_python.html#ControlFile.ControlFile.assign_args_to_control">[docs]</a>    <span class="k">def</span> <span class="nf">assign_args_to_control</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">args</span><span class="p">):</span>
695        <span class="sd">&#39;&#39;&#39;Overwrites the existing ControlFile instance attributes with</span>
696<span class="sd">        the command line arguments.</span>
697
698<span class="sd">        Parameters</span>
699<span class="sd">        ----------</span>
700<span class="sd">        args : Namespace</span>
701<span class="sd">            Contains the commandline arguments from script/program call.</span>
702
703<span class="sd">        Return</span>
704<span class="sd">        ------</span>
705
706<span class="sd">        &#39;&#39;&#39;</span>
707
708        <span class="c1"># get dictionary of command line parameters and eliminate all</span>
709        <span class="c1"># parameters which are None (were not specified)</span>
710        <span class="n">args_dict</span> <span class="o">=</span> <span class="nb">vars</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
711        <span class="n">arguments</span> <span class="o">=</span> <span class="p">{</span><span class="n">k</span> <span class="p">:</span> <span class="n">args_dict</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">args_dict</span>
712                     <span class="k">if</span> <span class="n">args_dict</span><span class="p">[</span><span class="n">k</span><span class="p">]</span> <span class="o">!=</span> <span class="kc">None</span><span class="p">}</span>
713
714        <span class="c1"># assign all passed command line arguments to ControlFile instance</span>
715        <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">arguments</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
716            <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">k</span><span class="p">),</span> <span class="n">v</span><span class="p">)</span>
717
718        <span class="k">return</span></div>
719
720<div class="viewcode-block" id="ControlFile.assign_envs_to_control"><a class="viewcode-back" href="../Documentation/Api/api_python.html#ControlFile.ControlFile.assign_envs_to_control">[docs]</a>    <span class="k">def</span> <span class="nf">assign_envs_to_control</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">envs</span><span class="p">):</span>
721        <span class="sd">&#39;&#39;&#39;Assigns the ECMWF environment parameter.</span>
722
723<span class="sd">        Parameters</span>
724<span class="sd">        ----------</span>
725<span class="sd">        envs : dict of str</span>
726<span class="sd">            Contains the ECMWF environment parameternames &quot;ECUID&quot;, &quot;ECGID&quot;,</span>
727<span class="sd">            &quot;DESTINATION&quot; and &quot;GATEWAY&quot; with its corresponding values.</span>
728<span class="sd">            They were read from the file &quot;ECMWF_ENV&quot;.</span>
729
730<span class="sd">        Return</span>
731<span class="sd">        ------</span>
732
733<span class="sd">        &#39;&#39;&#39;</span>
734
735        <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">envs</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
736            <span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">k</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">(),</span> <span class="nb">str</span><span class="p">(</span><span class="n">v</span><span class="p">))</span>
737
738        <span class="k">return</span></div>
739
740<div class="viewcode-block" id="ControlFile.check_conditions"><a class="viewcode-back" href="../Documentation/Api/api_python.html#ControlFile.ControlFile.check_conditions">[docs]</a>    <span class="k">def</span> <span class="nf">check_conditions</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">queue</span><span class="p">):</span>
741        <span class="sd">&#39;&#39;&#39;Checks a couple of necessary attributes and conditions,</span>
742<span class="sd">        such as if they exist and contain values.</span>
743<span class="sd">        Otherwise set default values.</span>
744
745<span class="sd">        Parameters</span>
746<span class="sd">        ----------</span>
747<span class="sd">        queue : str</span>
748<span class="sd">            Name of the queue if submitted to the ECMWF servers.</span>
749<span class="sd">            Used to check if ecuid, ecgid, gateway and destination</span>
750<span class="sd">            are set correctly and are not empty.</span>
751
752<span class="sd">        Return</span>
753<span class="sd">        ------</span>
754
755<span class="sd">        &#39;&#39;&#39;</span>
756        <span class="n">check_logicals_type</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">logicals</span><span class="p">)</span>
757
758        <span class="bp">self</span><span class="o">.</span><span class="n">mailfail</span> <span class="o">=</span> <span class="n">check_mail</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">mailfail</span><span class="p">)</span>
759
760        <span class="bp">self</span><span class="o">.</span><span class="n">mailops</span> <span class="o">=</span> <span class="n">check_mail</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">mailops</span><span class="p">)</span>
761
762        <span class="n">check_queue</span><span class="p">(</span><span class="n">queue</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">gateway</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">destination</span><span class="p">,</span>
763                    <span class="bp">self</span><span class="o">.</span><span class="n">ecuid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">ecgid</span><span class="p">)</span>
764
765        <span class="bp">self</span><span class="o">.</span><span class="n">outputdir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">installdir</span> <span class="o">=</span> <span class="n">check_pathes</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">inputdir</span><span class="p">,</span>
766             <span class="bp">self</span><span class="o">.</span><span class="n">outputdir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">flexextractdir</span><span class="p">)</span>
767
768        <span class="bp">self</span><span class="o">.</span><span class="n">start_date</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">end_date</span> <span class="o">=</span> <span class="n">check_dates</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">start_date</span><span class="p">,</span>
769                                                     <span class="bp">self</span><span class="o">.</span><span class="n">end_date</span><span class="p">)</span>
770
771        <span class="bp">self</span><span class="o">.</span><span class="n">basetime</span> <span class="o">=</span> <span class="n">check_basetime</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">basetime</span><span class="p">)</span>
772
773        <span class="bp">self</span><span class="o">.</span><span class="n">levelist</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">level</span> <span class="o">=</span> <span class="n">check_levels</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">levelist</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">level</span><span class="p">)</span>
774
775        <span class="bp">self</span><span class="o">.</span><span class="n">step</span> <span class="o">=</span> <span class="n">check_step</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">step</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">mailfail</span><span class="p">)</span>
776
777        <span class="bp">self</span><span class="o">.</span><span class="n">maxstep</span> <span class="o">=</span> <span class="n">check_maxstep</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">maxstep</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">step</span><span class="p">)</span>
778
779        <span class="n">check_request</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">request</span><span class="p">,</span>
780                      <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="bp">self</span><span class="o">.</span><span class="n">inputdir</span><span class="p">,</span> <span class="n">_config</span><span class="o">.</span><span class="n">FILE_MARS_REQUESTS</span><span class="p">))</span>
781
782        <span class="n">check_public</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">public</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">dataset</span><span class="p">)</span>
783
784        <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">=</span> <span class="n">check_type</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">step</span><span class="p">)</span>
785
786        <span class="bp">self</span><span class="o">.</span><span class="n">time</span> <span class="o">=</span> <span class="n">check_time</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">time</span><span class="p">)</span>
787
788        <span class="bp">self</span><span class="o">.</span><span class="n">purefc</span> <span class="o">=</span> <span class="n">check_purefc</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">)</span>
789
790        <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">time</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">step</span> <span class="o">=</span> <span class="n">check_len_type_time_step</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">,</span>
791                                                                   <span class="bp">self</span><span class="o">.</span><span class="n">time</span><span class="p">,</span>
792                                                                   <span class="bp">self</span><span class="o">.</span><span class="n">step</span><span class="p">,</span>
793                                                                   <span class="bp">self</span><span class="o">.</span><span class="n">maxstep</span><span class="p">,</span>
794                                                                   <span class="bp">self</span><span class="o">.</span><span class="n">purefc</span><span class="p">)</span>
795
796        <span class="bp">self</span><span class="o">.</span><span class="n">acctype</span> <span class="o">=</span> <span class="n">check_acctype</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">acctype</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">)</span>
797
798        <span class="bp">self</span><span class="o">.</span><span class="n">acctime</span> <span class="o">=</span> <span class="n">check_acctime</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">acctime</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">marsclass</span><span class="p">,</span>
799                                     <span class="bp">self</span><span class="o">.</span><span class="n">purefc</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">time</span><span class="p">)</span>
800
801        <span class="bp">self</span><span class="o">.</span><span class="n">accmaxstep</span> <span class="o">=</span> <span class="n">check_accmaxstep</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">accmaxstep</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">marsclass</span><span class="p">,</span>
802                                           <span class="bp">self</span><span class="o">.</span><span class="n">purefc</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">maxstep</span><span class="p">)</span>
803
804        <span class="bp">self</span><span class="o">.</span><span class="n">grid</span> <span class="o">=</span> <span class="n">check_grid</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">grid</span><span class="p">)</span>
805
806        <span class="bp">self</span><span class="o">.</span><span class="n">area</span> <span class="o">=</span> <span class="n">check_area</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">grid</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">area</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">upper</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">lower</span><span class="p">,</span>
807                               <span class="bp">self</span><span class="o">.</span><span class="n">left</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">right</span><span class="p">)</span>
808
809        <span class="bp">self</span><span class="o">.</span><span class="n">addpar</span> <span class="o">=</span> <span class="n">check_addpar</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">addpar</span><span class="p">)</span>
810
811        <span class="bp">self</span><span class="o">.</span><span class="n">job_chunk</span> <span class="o">=</span> <span class="n">check_job_chunk</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">job_chunk</span><span class="p">)</span>
812
813        <span class="bp">self</span><span class="o">.</span><span class="n">number</span> <span class="o">=</span> <span class="n">check_number</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">number</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">mailfail</span><span class="p">)</span>
814
815        <span class="k">return</span></div>
816
817<div class="viewcode-block" id="ControlFile.to_list"><a class="viewcode-back" href="../Documentation/Api/api_python.html#ControlFile.ControlFile.to_list">[docs]</a>    <span class="k">def</span> <span class="nf">to_list</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
818        <span class="sd">&#39;&#39;&#39;Just generates a list of strings containing the attributes and</span>
819<span class="sd">        assigned values except the attributes &quot;_expanded&quot;, &quot;exedir&quot;,</span>
820<span class="sd">        &quot;flexextractdir&quot; and &quot;installdir&quot;.</span>
821
822<span class="sd">        Parameters</span>
823<span class="sd">        ----------</span>
824
825<span class="sd">        Return</span>
826<span class="sd">        ------</span>
827<span class="sd">        l : list of *</span>
828<span class="sd">            A sorted list of the all ControlFile class attributes with</span>
829<span class="sd">            their values except the attributes &quot;_expanded&quot;, &quot;exedir&quot;,</span>
830<span class="sd">            &quot;flexextractdir&quot; and &quot;installdir&quot;.</span>
831<span class="sd">        &#39;&#39;&#39;</span>
832
833        <span class="kn">import</span> <span class="nn">collections</span>
834
835        <span class="n">attrs</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">OrderedDict</span><span class="p">(</span><span class="nb">sorted</span><span class="p">(</span><span class="nb">vars</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span><span class="o">.</span><span class="n">items</span><span class="p">()))</span>
836
837        <span class="n">l</span> <span class="o">=</span> <span class="nb">list</span><span class="p">()</span>
838
839        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">attrs</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
840            <span class="k">if</span> <span class="s1">&#39;_expanded&#39;</span> <span class="ow">in</span> <span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
841                <span class="k">pass</span>
842            <span class="k">elif</span> <span class="s1">&#39;exedir&#39;</span> <span class="ow">in</span> <span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
843                <span class="k">pass</span>
844            <span class="k">elif</span> <span class="s1">&#39;installdir&#39;</span> <span class="ow">in</span> <span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
845                <span class="k">pass</span>
846            <span class="k">elif</span> <span class="s1">&#39;flexextractdir&#39;</span> <span class="ow">in</span> <span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
847                <span class="k">pass</span>
848            <span class="k">else</span><span class="p">:</span>
849                <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="nb">list</span><span class="p">):</span>
850                    <span class="n">stot</span> <span class="o">=</span> <span class="s1">&#39;&#39;</span>
851                    <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">item</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
852                        <span class="n">stot</span> <span class="o">+=</span> <span class="n">s</span> <span class="o">+</span> <span class="s1">&#39; &#39;</span>
853
854                    <span class="n">l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">stot</span><span class="p">))</span>
855                <span class="k">else</span><span class="p">:</span>
856                    <span class="n">l</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2"> </span><span class="si">%s</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="n">item</span><span class="p">)</span>
857
858        <span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">l</span><span class="p">)</span></div></div>
859
860</pre></div>
861
862           </div>
863           
864          </div>
865          <footer>
866 
867
868  <hr/>
869
870  <div role="contentinfo">
871    <p>
872        &copy; Copyright 2019, Anne Philipp and Leopold Haimberger
873
874    </p>
875  </div>
876  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>.
877
878</footer>
879
880        </div>
881      </div>
882
883    </section>
884
885  </div>
886 
887
888
889  <script type="text/javascript">
890      jQuery(function () {
891          SphinxRtdTheme.Navigation.enable(true);
892      });
893  </script>
894
895 
896 
897   
898   
899
900</body>
901</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG