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