Context Navigation

source: flex_extract.git/Documentation/html/_modules/install.html @ 47be2684

ctbtodev

Last change on this file since 47be2684 was 47be2684, checked in by Leopold Haimberger <leopold.haimberger@…>, 4 years ago
Adaptations to allow for a system installation with separate user and system path. Updated documentation
Property mode set to `100644`
File size: 115.0 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>install — 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>install</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 install</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"># - moved install_args_and_control in here</span>
176	<span class="c1"># - splitted code in smaller functions</span>
177	<span class="c1"># - delete fortran build files in here instead of compile job script</span>
178	<span class="c1"># - changed static path names to variables from config file</span>
179	<span class="c1"># - splitted install function into several smaller pieces</span>
180	<span class="c1"># - use of tarfile package in python</span>
181	<span class="c1"># June 2020 - Anne Philipp</span>
182	<span class="c1"># - renamed "convert" functions to "fortran" functions</span>
183	<span class="c1"># - reconfigured mk_tarball to select *.template files instead</span>
184	<span class="c1"># of .nl and .temp</span>
185	<span class="c1"># - added check for makefile settings</span>
186	<span class="c1">#</span>
187	<span class="c1"># @License:</span>
188	<span class="c1"># (C) Copyright 2014-2020.</span>
189	<span class="c1"># Anne Philipp, Leopold Haimberger</span>
190	<span class="c1">#</span>
191	<span class="c1"># SPDX-License-Identifier: CC-BY-4.0</span>
192	<span class="c1">#</span>
193	<span class="c1"># This work is licensed under the Creative Commons Attribution 4.0</span>
194	<span class="c1"># International License. To view a copy of this license, visit</span>
195	<span class="c1"># http://creativecommons.org/licenses/by/4.0/ or send a letter to</span>
196	<span class="c1"># Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</span>
197	<span class="c1">#</span>
198	<span class="c1"># @Methods:</span>
199	<span class="c1"># main</span>
200	<span class="c1"># get_install_cmdline_args</span>
201	<span class="c1"># install_via_gateway</span>
202	<span class="c1"># check_install_conditions</span>
203	<span class="c1"># mk_tarball</span>
204	<span class="c1"># un_tarball</span>
205	<span class="c1"># mk_env_vars</span>
206	<span class="c1"># mk_compilejob</span>
207	<span class="c1"># mk_job_template</span>
208	<span class="c1"># del_fortran_build</span>
209	<span class="c1"># mk_fortran_build</span>
210	<span class="c1">#</span>
211	<span class="c1">#*******************************************************************************</span>
212	<span class="sd">'''This script installs the flex_extract program.</span>
213
214	<span class="sd">Depending on the selected installation environment (locally or on the</span>
215	<span class="sd">ECMWF server ecgate or cca) the program extracts the command line</span>
216	<span class="sd">arguments and the CONTROL file parameter and prepares the corresponding</span>
217	<span class="sd">environment.</span>
218	<span class="sd">The necessary files are collected in a tar ball and placed</span>
219	<span class="sd">at the target location. There, is is untared, the environment variables are</span>
220	<span class="sd">set, and the Fortran code is compiled.</span>
221	<span class="sd">If the ECMWF environment is selected, a job script is prepared and submitted</span>
222	<span class="sd">for the remaining configurations after putting the tar ball on the</span>
223	<span class="sd">target ECMWF server.</span>
224
225	<span class="sd">Type: install.py --help</span>
226	<span class="sd">to get information about command line parameters.</span>
227	<span class="sd">Read the documentation for usage instructions.</span>
228	<span class="sd">'''</span>
229
230	<span class="c1"># ------------------------------------------------------------------------------</span>
231	<span class="c1"># MODULES</span>
232	<span class="c1"># ------------------------------------------------------------------------------</span>
233	<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">print_function</span>
234
235	<span class="kn">import</span> <span class="nn">os</span>
236	<span class="kn">import</span> <span class="nn">sys</span>
237	<span class="kn">import</span> <span class="nn">subprocess</span>
238	<span class="kn">import</span> <span class="nn">tarfile</span>
239	<span class="kn">import</span> <span class="nn">shutil</span>
240	<span class="kn">from</span> <span class="nn">argparse</span> <span class="kn">import</span> <span class="n">ArgumentParser</span><span class="p">,</span> <span class="n">ArgumentDefaultsHelpFormatter</span>
241
242	<span class="c1"># software specific classes and modules from flex_extract</span>
243	<span class="kn">import</span> <span class="nn">_config</span>
244	<span class="kn">from</span> <span class="nn">Classes.ControlFile</span> <span class="kn">import</span> <span class="n">ControlFile</span>
245	<span class="kn">from</span> <span class="nn">Classes.UioFiles</span> <span class="kn">import</span> <span class="n">UioFiles</span>
246	<span class="kn">from</span> <span class="nn">Mods.tools</span> <span class="kn">import</span> <span class="p">(</span><span class="n">make_dir</span><span class="p">,</span> <span class="n">put_file_to_ecserver</span><span class="p">,</span> <span class="n">submit_job_to_ecserver</span><span class="p">,</span>
247	<span class="n">silent_remove</span><span class="p">,</span> <span class="n">execute_subprocess</span><span class="p">,</span> <span class="n">none_or_str</span><span class="p">,</span>
248	<span class="n">overwrite_lines_in_file</span><span class="p">,</span> <span class="n">check_for_string_in_file</span><span class="p">)</span>
249
250	<span class="c1"># ------------------------------------------------------------------------------</span>
251	<span class="c1"># FUNCTIONS</span>
252	<span class="c1"># ------------------------------------------------------------------------------</span>
253	<div class="viewcode-block" id="main"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.main">[docs]</a><span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
254	<span class="sd">'''Controls the installation process. Calls the installation function</span>
255	<span class="sd"> if target is specified.</span>
256
257	<span class="sd"> Parameters</span>
258	<span class="sd"> ----------</span>
259
260	<span class="sd"> Return</span>
261	<span class="sd"> ------</span>
262	<span class="sd"> '''</span>
263
264	<span class="n">args</span> <span class="o">=</span> <span class="n">get_install_cmdline_args</span><span class="p">()</span>
265	<span class="n">c</span> <span class="o">=</span> <span class="n">ControlFile</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">controlfile</span><span class="p">)</span>
266	<span class="n">c</span><span class="o">.</span><span class="n">assign_args_to_control</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
267	<span class="n">check_install_conditions</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
268
269	<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'local'</span><span class="p">,</span> <span class="s1">'syslocal'</span><span class="p">]:</span> <span class="c1"># ecgate or cca</span>
270	<span class="n">install_via_gateway</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
271	<span class="k">else</span><span class="p">:</span> <span class="c1"># local</span>
272	<span class="n">install_local</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
273
274	<span class="nb">print</span><span class="p">(</span><span class="s2">"SUCCESS: INSTALLATION FINISHED!"</span><span class="p">)</span>
275
276	<span class="k">return</span></div>
277
278	<div class="viewcode-block" id="get_install_cmdline_args"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.get_install_cmdline_args">[docs]</a><span class="k">def</span> <span class="nf">get_install_cmdline_args</span><span class="p">():</span>
279	<span class="sd">'''Decomposes the command line arguments and assigns them to variables.</span>
280	<span class="sd"> Apply default values for arguments not present.</span>
281
282	<span class="sd"> Parameters</span>
283	<span class="sd"> ----------</span>
284
285	<span class="sd"> Return</span>
286	<span class="sd"> ------</span>
287	<span class="sd"> args : Namespace</span>
288	<span class="sd"> Contains the commandline arguments from script/program call.</span>
289	<span class="sd"> '''</span>
290	<span class="n">parser</span> <span class="o">=</span> <span class="n">ArgumentParser</span><span class="p">(</span><span class="n">description</span><span class="o">=</span><span class="s1">'Install flex_extract software '</span>
291	<span class="s1">'locally or on ECMWF machines'</span><span class="p">,</span>
292	<span class="n">formatter_class</span><span class="o">=</span><span class="n">ArgumentDefaultsHelpFormatter</span><span class="p">)</span>
293
294	<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">'--target'</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s1">'install_target'</span><span class="p">,</span>
295	<span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
296	<span class="n">help</span><span class="o">=</span><span class="s2">"Valid targets: syslocal \| local \| ecgate \| cca , </span><span class="se">\</span>
297	<span class="s2"> the latter two are at ECMWF"</span><span class="p">)</span>
298	<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--makefile"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"makefile"</span><span class="p">,</span>
299	<span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
300	<span class="n">help</span><span class="o">=</span><span class="s1">'Name of makefile for compiling the '</span>
301	<span class="s1">'Fortran program'</span><span class="p">)</span>
302	<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--ecuid"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"ecuid"</span><span class="p">,</span>
303	<span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
304	<span class="n">help</span><span class="o">=</span><span class="s1">'User id at ECMWF'</span><span class="p">)</span>
305	<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--ecgid"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"ecgid"</span><span class="p">,</span>
306	<span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
307	<span class="n">help</span><span class="o">=</span><span class="s1">'Group id at ECMWF'</span><span class="p">)</span>
308	<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--gateway"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"gateway"</span><span class="p">,</span>
309	<span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
310	<span class="n">help</span><span class="o">=</span><span class="s1">'Name of the local gateway server'</span><span class="p">)</span>
311	<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--destination"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"destination"</span><span class="p">,</span>
312	<span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
313	<span class="n">help</span><span class="o">=</span><span class="s1">'ecaccess association, e.g. '</span>
314	<span class="s1">'myUser@genericSftp'</span><span class="p">)</span>
315
316	<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--installdir"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"installdir"</span><span class="p">,</span>
317	<span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
318	<span class="n">help</span><span class="o">=</span><span class="s1">'Root (user) directory of the '</span>
319	<span class="s1">'flex_extract installation'</span><span class="p">)</span>
320	<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--sysinstalldir"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"sysinstalldir"</span><span class="p">,</span>
321	<span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
322	<span class="n">help</span><span class="o">=</span><span class="s1">'System installation path; where '</span>
323	<span class="s1">'executables are stored.'</span><span class="p">)</span>
324
325	<span class="c1"># arguments for job submission to ECMWF, only needed by submit.py</span>
326	<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--job_template"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s1">'job_template'</span><span class="p">,</span>
327	<span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">"job.template"</span><span class="p">,</span>
328	<span class="n">help</span><span class="o">=</span><span class="s1">'Rudimentary template file to create a batch '</span>
329	<span class="s1">'job template for submission to ECMWF servers'</span><span class="p">)</span>
330
331	<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--controlfile"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"controlfile"</span><span class="p">,</span>
332	<span class="nb">type</span><span class="o">=</span><span class="n">none_or_str</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">'CONTROL_EA5'</span><span class="p">,</span>
333	<span class="n">help</span><span class="o">=</span><span class="s2">"A file that contains all CONTROL parameters."</span><span class="p">)</span>
334
335	<span class="n">args</span> <span class="o">=</span> <span class="n">parser</span><span class="o">.</span><span class="n">parse_args</span><span class="p">()</span>
336
337	<span class="k">return</span> <span class="n">args</span></div>
338
339
340	<div class="viewcode-block" id="install_via_gateway"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.install_via_gateway">[docs]</a><span class="k">def</span> <span class="nf">install_via_gateway</span><span class="p">(</span><span class="n">c</span><span class="p">):</span>
341	<span class="sd">'''Prepare data transfer to remote gateway and submit a job script which will</span>
342	<span class="sd"> install everything on the remote gateway.</span>
343
344	<span class="sd"> Parameters</span>
345	<span class="sd"> ----------</span>
346	<span class="sd"> c : ControlFile</span>
347	<span class="sd"> Contains all the parameters of CONTROL file and</span>
348	<span class="sd"> command line.</span>
349
350	<span class="sd"> Return</span>
351	<span class="sd"> ------</span>
352
353	<span class="sd"> '''</span>
354
355	<span class="n">tarball_name</span> <span class="o">=</span> <span class="n">_config</span><span class="o">.</span><span class="n">FLEXEXTRACT_DIRNAME</span> <span class="o">+</span> <span class="s1">'.tar'</span>
356	<span class="n">tar_file</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_FLEXEXTRACT_DIR</span><span class="p">,</span> <span class="n">tarball_name</span><span class="p">)</span>
357
358	<span class="n">mk_compilejob</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">makefile</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">ecuid</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">ecgid</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">)</span>
359
360	<span class="n">mk_job_template</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">ecuid</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">ecgid</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">)</span>
361
362	<span class="n">mk_env_vars</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">ecuid</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">ecgid</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">gateway</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">destination</span><span class="p">)</span>
363
364	<span class="n">mk_tarball</span><span class="p">(</span><span class="n">tar_file</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span><span class="p">)</span>
365
366	<span class="n">put_file_to_ecserver</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_FLEXEXTRACT_DIR</span><span class="p">,</span> <span class="n">tarball_name</span><span class="p">,</span>
367	<span class="n">c</span><span class="o">.</span><span class="n">install_target</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">ecuid</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">ecgid</span><span class="p">)</span>
368
369	<span class="n">submit_job_to_ecserver</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">install_target</span><span class="p">,</span>
370	<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_REL_JOBSCRIPTS</span><span class="p">,</span>
371	<span class="n">_config</span><span class="o">.</span><span class="n">FILE_INSTALL_COMPILEJOB</span><span class="p">))</span>
372
373	<span class="n">silent_remove</span><span class="p">(</span><span class="n">tar_file</span><span class="p">)</span>
374
375	<span class="nb">print</span><span class="p">(</span><span class="s1">'Job compilation script has been submitted to ecgate for '</span> <span class="o">+</span>
376	<span class="s1">'installation in '</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">installdir</span> <span class="o">+</span>
377	<span class="s1">'/'</span> <span class="o">+</span> <span class="n">_config</span><span class="o">.</span><span class="n">FLEXEXTRACT_DIRNAME</span><span class="p">)</span>
378	<span class="nb">print</span><span class="p">(</span><span class="s1">'You should get an email with subject "flexcompile" within '</span> <span class="o">+</span>
379	<span class="s1">'the next few minutes!'</span><span class="p">)</span>
380
381	<span class="k">return</span></div>
382
383	<div class="viewcode-block" id="install_local"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.install_local">[docs]</a><span class="k">def</span> <span class="nf">install_local</span><span class="p">(</span><span class="n">c</span><span class="p">):</span>
384	<span class="sd">'''Perform the actual installation on a local machine.</span>
385
386	<span class="sd"> Parameters</span>
387	<span class="sd"> ----------</span>
388	<span class="sd"> c : ControlFile</span>
389	<span class="sd"> Contains all the parameters of CONTROL file and</span>
390	<span class="sd"> command line.</span>
391
392	<span class="sd"> Return</span>
393	<span class="sd"> ------</span>
394
395	<span class="sd"> '''</span>
396
397	<span class="n">tar_file</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_FLEXEXTRACT_DIR</span><span class="p">,</span>
398	<span class="n">_config</span><span class="o">.</span><span class="n">FLEXEXTRACT_DIRNAME</span> <span class="o">+</span> <span class="s1">'.tar'</span><span class="p">)</span>
399
400	<span class="n">c</span><span class="o">.</span><span class="n">installdir</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">abspath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expandvars</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span>
401	<span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">)))</span>
402	<span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</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">abspath</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expandvars</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">expanduser</span><span class="p">(</span>
403	<span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</span><span class="p">)))</span>
404
405	<span class="c1"># this is standard installation into a single directory</span>
406	<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="o">==</span> <span class="s1">'local'</span><span class="p">:</span>
407
408	<span class="c1"># installation into the current directory</span>
409	<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_FLEXEXTRACT_DIR</span><span class="p">)</span> <span class="o">==</span> <span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">:</span>
410	<span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: installdir has not been specified'</span><span class="p">)</span>
411	<span class="nb">print</span><span class="p">(</span><span class="s1">'flex_extract will be installed in current dir by compiling the '</span> <span class="o">+</span>
412	<span class="s1">'Fortran source in '</span> <span class="o">+</span> <span class="n">_config</span><span class="o">.</span><span class="n">PATH_FORTRAN_SRC</span><span class="p">)</span>
413	<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_FORTRAN_SRC</span><span class="p">)</span>
414	<span class="c1"># installation into a different path</span>
415	<span class="k">elif</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_FLEXEXTRACT_DIR</span><span class="p">)</span> <span class="o">!=</span> <span class="n">c</span><span class="o">.</span><span class="n">installdir</span> <span class="p">:</span>
416
417	<span class="c1"># creates the target working directory for flex_extract</span>
418	<span class="n">mk_tarball</span><span class="p">(</span><span class="n">tar_file</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span><span class="p">)</span>
419	<span class="n">make_dir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span>
420	<span class="n">_config</span><span class="o">.</span><span class="n">FLEXEXTRACT_DIRNAME</span><span class="p">))</span>
421	<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span>
422	<span class="n">_config</span><span class="o">.</span><span class="n">FLEXEXTRACT_DIRNAME</span><span class="p">))</span>
423	<span class="n">un_tarball</span><span class="p">(</span><span class="n">tar_file</span><span class="p">)</span>
424	<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span>
425	<span class="n">_config</span><span class="o">.</span><span class="n">FLEXEXTRACT_DIRNAME</span><span class="p">,</span>
426	<span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_FORTRAN_SRC</span><span class="p">))</span>
427
428	<span class="c1"># Create Fortran executable</span>
429	<span class="nb">print</span><span class="p">(</span><span class="s1">'Install '</span> <span class="o">+</span> <span class="n">_config</span><span class="o">.</span><span class="n">FLEXEXTRACT_DIRNAME</span> <span class="o">+</span> <span class="s1">' software at '</span> <span class="o">+</span>
430	<span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="o">+</span> <span class="s1">' in directory '</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">installdir</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
431
432	<span class="n">del_fortran_build</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span>
433	<span class="n">mk_fortran_build</span><span class="p">(</span><span class="s1">'.'</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">makefile</span><span class="p">)</span>
434	<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="s1">'../../'</span><span class="p">)</span>
435	<span class="c1"># make sure that the correct calling of submit.py script is in run_local.sh</span>
436	<span class="n">overwrite_lines_in_file</span><span class="p">(</span><span class="s1">'Run/run_local.sh'</span><span class="p">,</span>
437	<span class="s1">'pyscript='</span><span class="p">,</span> <span class="s1">'pyscript=../Source/Python/submit.py</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
438
439	<span class="c1"># this is system installation were executables and user files are separated</span>
440	<span class="k">elif</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="o">==</span> <span class="s1">'syslocal'</span><span class="p">:</span>
441	<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_FLEXEXTRACT_DIR</span><span class="p">)</span> <span class="o">==</span> <span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</span> <span class="p">:</span>
442	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'ERROR: System installation path is equal to user '</span>
443	<span class="s1">'installation path.</span><span class="se">\n</span><span class="s1"> Please change either the system '</span>
444	<span class="s1">'installation path or use installation target "local".'</span><span class="p">)</span>
445	<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_FLEXEXTRACT_DIR</span><span class="p">)</span> <span class="o">==</span> <span class="n">c</span><span class="o">.</span><span class="n">installdir</span> <span class="p">:</span>
446	<span class="nb">print</span><span class="p">(</span><span class="s1">'Flex_extract will be installed in current directory!'</span><span class="p">)</span>
447	<span class="k">else</span><span class="p">:</span> <span class="c1"># install user part in different dir</span>
448	<span class="nb">print</span><span class="p">(</span><span class="s1">'Flex_extract will be installed in '</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">installdir</span> <span class="p">)</span>
449
450	<span class="n">c</span><span class="o">.</span><span class="n">installdir</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">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span><span class="n">_config</span><span class="o">.</span><span class="n">FLEXEXTRACT_DIRNAME</span><span class="p">)</span>
451	<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">):</span>
452	<span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">)</span>
453
454	<span class="c1"># copy all files except Python and Fortranfiles to this dir</span>
455	<span class="n">shutil</span><span class="o">.</span><span class="n">copytree</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_FLEXEXTRACT_DIR</span><span class="p">,</span>
456	<span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span> <span class="n">symlinks</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
457	<span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span><span class="s1">'Source'</span><span class="p">))</span>
458	<span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span><span class="s1">'.git'</span><span class="p">))</span>
459	<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span> <span class="s1">'*~'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">:</span>
460	<span class="n">silent_remove</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
461
462	<span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span><span class="s1">'setup.sh'</span><span class="p">))</span>
463	<span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span><span class="s1">'setup_local.sh'</span><span class="p">))</span>
464
465	<span class="c1"># configure run_local script correctly</span>
466	<span class="c1"># check if source of system config file is already in run_local.sh,</span>
467	<span class="c1"># if not, add it</span>
468	<span class="k">if</span> <span class="ow">not</span> <span class="n">check_for_string_in_file</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span><span class="s1">'Run/run_local.sh'</span><span class="p">),</span>
469	<span class="s1">'source .setup.rc'</span><span class="p">):</span>
470	<span class="n">overwrite_lines_in_file</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span><span class="s1">'Run/run_local.sh'</span><span class="p">),</span>
471	<span class="s1">'# PATH TO SUBMISSION SCRIPT'</span><span class="p">,</span>
472	<span class="s1">'# PATH TO SUBMISSION SCRIPT</span><span class="se">\n</span><span class="s1">source '</span><span class="o">+</span><span class="n">_config</span><span class="o">.</span><span class="n">FILE_SYS_CONFIG</span><span class="o">+</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
473	<span class="c1"># make sure that the correct calling of submit.py script is in run_local.sh</span>
474	<span class="n">overwrite_lines_in_file</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">,</span><span class="s1">'Run/run_local.sh'</span><span class="p">),</span>
475	<span class="s1">'pyscript='</span><span class="p">,</span> <span class="s1">'pyscript=submit.py</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
476
477	<span class="c1"># change permission for file to executable</span>
478	<span class="n">execute_subprocess</span><span class="p">([</span><span class="s1">'chmod'</span><span class="p">,</span> <span class="s1">'0775'</span><span class="p">,</span>
479	<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">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">),</span><span class="s1">'Run/run_local.sh'</span><span class="p">)])</span>
480
481
482	<span class="c1"># create systemdir</span>
483	<span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</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">c</span><span class="o">.</span><span class="n">sysinstalldir</span><span class="p">,</span><span class="n">_config</span><span class="o">.</span><span class="n">FLEXEXTRACT_DIRNAME</span><span class="p">)</span>
484	<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</span><span class="p">):</span>
485	<span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</span><span class="p">)</span>
486
487	<span class="c1"># create setup file for running flex_extract with system installation</span>
488	<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">),</span><span class="s1">'Run/.setup.rc'</span><span class="p">),</span><span class="s1">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">fio</span><span class="p">:</span>
489	<span class="n">fio</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'#!/bin/bash </span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
490	<span class="n">fio</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'export FLEXEXTRACT_USER_DIR='</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">abspath</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">)</span><span class="o">+</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
491	<span class="n">fio</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'export PATH='</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">abspath</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</span><span class="p">)</span><span class="o">+</span><span class="s1">'/Python:$</span><span class="si">{PATH}</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
492	<span class="n">fio</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'export PATH='</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">abspath</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</span><span class="p">)</span><span class="o">+</span><span class="s1">':$</span><span class="si">{PATH}</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
493
494	<span class="c1"># copy all Python and Fortranfiles to this dir</span>
495	<span class="n">shutil</span><span class="o">.</span><span class="n">copytree</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_SOURCES</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</span><span class="p">,</span> <span class="n">symlinks</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
496
497	<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</span><span class="p">,</span><span class="s1">'Fortran'</span><span class="p">))</span>
498	<span class="c1"># Create Fortran executable</span>
499	<span class="nb">print</span><span class="p">(</span><span class="s1">'Install '</span> <span class="o">+</span> <span class="n">_config</span><span class="o">.</span><span class="n">FLEXEXTRACT_DIRNAME</span> <span class="o">+</span> <span class="s1">' software as '</span> <span class="o">+</span>
500	<span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="o">+</span> <span class="s1">' in directory '</span> <span class="o">+</span>
501	<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</span><span class="p">)</span> <span class="o">+</span> <span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
502
503	<span class="n">del_fortran_build</span><span class="p">(</span><span class="s1">'.'</span><span class="p">)</span>
504	<span class="n">mk_fortran_build</span><span class="p">(</span><span class="s1">'.'</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">makefile</span><span class="p">)</span>
505
506	<span class="n">outfile</span> <span class="o">=</span> <span class="p">[</span><span class="n">x</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="s1">'.'</span><span class="p">,</span><span class="s1">'*.out'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
507	<span class="n">test</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">c</span><span class="o">.</span><span class="n">sysinstalldir</span><span class="p">,</span><span class="s1">'calc_etadot'</span><span class="p">)</span>
508	<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">outfile</span><span class="p">)</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span>
509	<span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Multiple executables for Fortran code are available!'</span><span class="p">)</span>
510	<span class="c1"># move executable one dir up and delete Fortran dir</span>
511	<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="s1">'..'</span><span class="p">)</span>
512	<span class="n">shutil</span><span class="o">.</span><span class="n">move</span><span class="p">(</span><span class="n">outfile</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</span><span class="p">,</span><span class="s1">'calc_etadot'</span><span class="p">))</span>
513	<span class="n">shutil</span><span class="o">.</span><span class="n">rmtree</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</span><span class="p">),</span><span class="s1">'Fortran'</span><span class="p">))</span>
514
515	<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_FLEXEXTRACT_DIR</span><span class="p">)</span>
516	<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">tar_file</span><span class="p">):</span>
517	<span class="n">os</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">tar_file</span><span class="p">)</span>
518
519	<span class="k">return</span></div>
520
521
522	<div class="viewcode-block" id="check_install_conditions"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.check_install_conditions">[docs]</a><span class="k">def</span> <span class="nf">check_install_conditions</span><span class="p">(</span><span class="n">c</span><span class="p">):</span>
523	<span class="sd">'''Checks necessary attributes and conditions</span>
524	<span class="sd"> for the installation, e.g. whether they exist and contain values.</span>
525	<span class="sd"> Otherwise set default values.</span>
526
527	<span class="sd"> Parameters</span>
528	<span class="sd"> ----------</span>
529	<span class="sd"> c : ControlFile</span>
530	<span class="sd"> Contains all the parameters of CONTROL file and</span>
531	<span class="sd"> command line.</span>
532
533
534	<span class="sd"> Return</span>
535	<span class="sd"> ------</span>
536
537	<span class="sd"> '''</span>
538
539	<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="ow">and</span> \
540	<span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">_config</span><span class="o">.</span><span class="n">INSTALL_TARGETS</span><span class="p">:</span>
541	<span class="nb">print</span><span class="p">(</span><span class="s1">'ERROR: unknown or missing installation target '</span><span class="p">)</span>
542	<span class="nb">print</span><span class="p">(</span><span class="s1">'target: '</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span><span class="p">)</span>
543	<span class="nb">print</span><span class="p">(</span><span class="s1">'please specify correct installation target '</span> <span class="o">+</span>
544	<span class="nb">str</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">INSTALL_TARGETS</span><span class="p">))</span>
545	<span class="nb">print</span><span class="p">(</span><span class="s1">'use -h or --help for help'</span><span class="p">)</span>
546	<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>
547
548	<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="ow">and</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'local'</span><span class="p">,</span> <span class="s1">'syslocal'</span><span class="p">]:</span>
549	<span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">ecgid</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">ecuid</span><span class="p">:</span>
550	<span class="nb">print</span><span class="p">(</span><span class="s1">'Please enter your ECMWF user id and group id '</span>
551	<span class="s1">' with command line options --ecuid --ecgid'</span><span class="p">)</span>
552	<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> \
553	<span class="s1">' -h" to print usage information'</span><span class="p">)</span>
554	<span class="nb">print</span><span class="p">(</span><span class="s1">'Please consult ecaccess documentation or ECMWF user '</span>
555	<span class="s1">'support for further details.</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
556	<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>
557	<span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">gateway</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">destination</span><span class="p">:</span>
558	<span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: Parameters GATEWAY and DESTINATION were '</span>
559	<span class="s1">'not properly set for working on ECMWF server. </span><span class="se">\n</span><span class="s1">'</span>
560	<span class="s1">'There will be no transfer of output files to the '</span>
561	<span class="s1">'local gateway server possible!'</span><span class="p">)</span>
562	<span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">:</span>
563	<span class="n">c</span><span class="o">.</span><span class="n">installdir</span> <span class="o">=</span> <span class="s1">'$</span><span class="si">{HOME}</span><span class="s1">'</span>
564	<span class="k">elif</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="o">==</span> <span class="s1">'local'</span><span class="p">:</span>
565	<span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">:</span>
566	<span class="n">c</span><span class="o">.</span><span class="n">installdir</span> <span class="o">=</span> <span class="n">_config</span><span class="o">.</span><span class="n">PATH_FLEXEXTRACT_DIR</span>
567	<span class="k">elif</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="o">==</span> <span class="s1">'syslocal'</span><span class="p">:</span>
568	<span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">installdir</span><span class="p">:</span>
569	<span class="n">c</span><span class="o">.</span><span class="n">installdir</span> <span class="o">=</span> <span class="n">_config</span><span class="o">.</span><span class="n">PATH_FLEXEXTRACT_DIR</span>
570	<span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">sysinstalldir</span><span class="p">:</span>
571	<span class="nb">print</span><span class="p">(</span><span class="s1">'ERROR: System installation was selected but '</span>
572	<span class="s1">'no system installation path was defined.'</span><span class="p">)</span>
573	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">()</span>
574
575	<span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">makefile</span><span class="p">:</span>
576	<span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: no makefile was specified.'</span><span class="p">)</span>
577	<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="o">==</span> <span class="s1">'local'</span><span class="p">:</span>
578	<span class="n">c</span><span class="o">.</span><span class="n">makefile</span> <span class="o">=</span> <span class="s1">'makefile_local_gfortran'</span>
579	<span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: default makefile selected: makefile_local_gfortan'</span><span class="p">)</span>
580	<span class="k">elif</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="o">==</span> <span class="s1">'ecgate'</span><span class="p">:</span>
581	<span class="n">c</span><span class="o">.</span><span class="n">makefile</span> <span class="o">=</span> <span class="s1">'makefile_ecgate'</span>
582	<span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: default makefile selected: makefile_ecgate'</span><span class="p">)</span>
583	<span class="k">elif</span> <span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="o">==</span> <span class="s1">'cca'</span> <span class="ow">or</span> \
584	<span class="n">c</span><span class="o">.</span><span class="n">install_target</span> <span class="o">==</span> <span class="s1">'ccb'</span><span class="p">:</span>
585	<span class="n">c</span><span class="o">.</span><span class="n">makefile</span> <span class="o">=</span> <span class="s1">'makefile_cray'</span>
586	<span class="nb">print</span><span class="p">(</span><span class="s1">'WARNING: default makefile selected: makefile_cray'</span><span class="p">)</span>
587	<span class="k">else</span><span class="p">:</span>
588	<span class="k">pass</span>
589
590	<span class="k">return</span></div>
591
592
593	<div class="viewcode-block" id="mk_tarball"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.mk_tarball">[docs]</a><span class="k">def</span> <span class="nf">mk_tarball</span><span class="p">(</span><span class="n">tarball_path</span><span class="p">,</span> <span class="n">target</span><span class="p">):</span>
594	<span class="sd">'''Creates a tarball with all necessary files which need to be sent to the</span>
595	<span class="sd"> installation directory.</span>
596	<span class="sd"> It does not matter whether this is local or remote.</span>
597	<span class="sd"> Collects all Python files, the Fortran source and makefiles,</span>
598	<span class="sd"> the ECMWF_ENV file, the CONTROL files as well as the</span>
599	<span class="sd"> template files.</span>
600
601	<span class="sd"> Parameters</span>
602	<span class="sd"> ----------</span>
603	<span class="sd"> tarball_path : str</span>
604	<span class="sd"> The complete path to the tar file which will contain all</span>
605	<span class="sd"> relevant data for flex_extract.</span>
606
607	<span class="sd"> target : str</span>
608	<span class="sd"> The queue where the job is submitted to.</span>
609
610	<span class="sd"> Return</span>
611	<span class="sd"> ------</span>
612
613	<span class="sd"> '''</span>
614
615	<span class="nb">print</span><span class="p">(</span><span class="s1">'Create tarball ...'</span><span class="p">)</span>
616
617	<span class="c1"># change to FLEXEXTRACT directory so that the tar can contain</span>
618	<span class="c1"># relative pathes to the files and directories</span>
619	<span class="n">ecd</span> <span class="o">=</span> <span class="n">_config</span><span class="o">.</span><span class="n">PATH_FLEXEXTRACT_DIR</span> <span class="o">+</span> <span class="s1">'/'</span>
620	<span class="n">os</span><span class="o">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">ecd</span><span class="p">)</span>
621
622	<span class="c1"># get lists of the files to be added to the tar file</span>
623	<span class="k">if</span> <span class="n">target</span> <span class="o">==</span> <span class="s1">'local'</span><span class="p">:</span>
624	<span class="n">ecmwf_env_file</span> <span class="o">=</span> <span class="p">[]</span>
625	<span class="n">runfile</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">ecd</span><span class="p">)</span>
626	<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_RUN_DIR</span><span class="p">,</span>
627	<span class="s1">'run_local.sh'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
628	<span class="k">else</span><span class="p">:</span>
629	<span class="n">ecmwf_env_file</span> <span class="o">=</span> <span class="p">[</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_ECMWF_ENV</span><span class="p">]</span>
630	<span class="n">runfile</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">ecd</span><span class="p">)</span>
631	<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_RUN_DIR</span><span class="p">,</span>
632	<span class="s1">'run.sh'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
633
634	<span class="n">pyfiles</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">ecd</span><span class="p">)</span>
635	<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_PYTHON_SRC</span><span class="p">,</span> <span class="s1">'*py'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
636	<span class="n">pytestfiles</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">ecd</span><span class="p">)</span>
637	<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_PYTHONTEST_SRC</span><span class="p">,</span> <span class="s1">'*py'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
638	<span class="n">controlfiles</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">ecd</span><span class="p">)</span>
639	<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_CONTROLFILES</span><span class="p">,</span>
640	<span class="s1">'CONTROL*'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
641	<span class="n">testfiles</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">ecd</span><span class="p">)</span>
642	<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_TEST</span><span class="o">+</span><span class="s2">"/Installation"</span><span class="p">,</span> <span class="s1">'*'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
643	<span class="n">tempfiles</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">ecd</span><span class="p">)</span>
644	<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_TEMPLATES</span><span class="p">,</span> <span class="s1">'*.template'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
645	<span class="n">gribtable</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">ecd</span><span class="p">)</span>
646	<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_TEMPLATES</span><span class="p">,</span> <span class="s1">'grib'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
647	<span class="n">ffiles</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">ecd</span><span class="p">)</span>
648	<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_FORTRAN_SRC</span><span class="p">,</span> <span class="s1">'*.f90'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
649	<span class="n">hfiles</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">ecd</span><span class="p">)</span>
650	<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_FORTRAN_SRC</span><span class="p">,</span> <span class="s1">'*.h'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
651	<span class="n">makefiles</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">ecd</span><span class="p">)</span>
652	<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_FORTRAN_SRC</span><span class="p">,</span> <span class="s1">'makefile*'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
653	<span class="n">jobdir</span> <span class="o">=</span> <span class="p">[</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">ecd</span><span class="p">)</span>
654	<span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_JOBSCRIPTS</span><span class="p">,</span> <span class="s1">'*.md'</span><span class="p">)</span><span class="o">.</span><span class="n">files</span><span class="p">]</span>
655
656	<span class="c1"># concatenate single lists to one for a better looping</span>
657	<span class="n">filelist</span> <span class="o">=</span> <span class="n">pyfiles</span> <span class="o">+</span> <span class="n">pytestfiles</span> <span class="o">+</span> <span class="n">controlfiles</span> <span class="o">+</span> <span class="n">tempfiles</span> <span class="o">+</span> \
658	<span class="n">ffiles</span> <span class="o">+</span> <span class="n">gribtable</span> <span class="o">+</span> <span class="n">hfiles</span> <span class="o">+</span> <span class="n">makefiles</span> <span class="o">+</span> <span class="n">ecmwf_env_file</span> <span class="o">+</span> \
659	<span class="n">runfile</span> <span class="o">+</span> <span class="n">jobdir</span> <span class="o">+</span> <span class="n">testfiles</span> <span class="o">+</span>\
660	<span class="p">[</span><span class="s1">'CODE_OF_CONDUCT.md'</span><span class="p">,</span> <span class="s1">'LICENSE.md'</span><span class="p">,</span> <span class="s1">'README.md'</span><span class="p">]</span>
661
662	<span class="c1"># create installation tar-file</span>
663	<span class="n">exclude_files</span> <span class="o">=</span> <span class="p">[</span><span class="s2">".ksh"</span><span class="p">,</span> <span class="s2">".tar"</span><span class="p">]</span>
664	<span class="k">try</span><span class="p">:</span>
665	<span class="k">with</span> <span class="n">tarfile</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">tarball_path</span><span class="p">,</span> <span class="s2">"w:gz"</span><span class="p">)</span> <span class="k">as</span> <span class="n">tar_handle</span><span class="p">:</span>
666	<span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">filelist</span><span class="p">:</span>
667	<span class="n">tar_handle</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">recursive</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
668	<span class="nb">filter</span><span class="o">=</span><span class="k">lambda</span> <span class="n">tarinfo</span><span class="p">:</span> <span class="kc">None</span>
669	<span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">tarinfo</span><span class="o">.</span><span class="n">name</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span>
670	<span class="ow">in</span> <span class="n">exclude_files</span>
671	<span class="k">else</span> <span class="n">tarinfo</span><span class="p">)</span>
672	<span class="k">except</span> <span class="n">tarfile</span><span class="o">.</span><span class="n">TarError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
673	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
674
675	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... error occured while trying to create the tar-file '</span> <span class="o">+</span>
676	<span class="nb">str</span><span class="p">(</span><span class="n">tarball_path</span><span class="p">))</span>
677
678	<span class="k">return</span></div>
679
680
681	<div class="viewcode-block" id="un_tarball"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.un_tarball">[docs]</a><span class="k">def</span> <span class="nf">un_tarball</span><span class="p">(</span><span class="n">tarball_path</span><span class="p">):</span>
682	<span class="sd">'''Extracts the given tarball into current directory.</span>
683
684	<span class="sd"> Parameters</span>
685	<span class="sd"> ----------</span>
686	<span class="sd"> tarball_path : str</span>
687	<span class="sd"> The complete path to the tar file which will contain all</span>
688	<span class="sd"> relevant data for flex_extract.</span>
689
690	<span class="sd"> Return</span>
691	<span class="sd"> ------</span>
692
693	<span class="sd"> '''</span>
694
695	<span class="nb">print</span><span class="p">(</span><span class="s1">'Untar ...'</span><span class="p">)</span>
696
697	<span class="k">try</span><span class="p">:</span>
698	<span class="k">with</span> <span class="n">tarfile</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">tarball_path</span><span class="p">)</span> <span class="k">as</span> <span class="n">tar_handle</span><span class="p">:</span>
699	<span class="n">tar_handle</span><span class="o">.</span><span class="n">extractall</span><span class="p">()</span>
700	<span class="k">except</span> <span class="n">tarfile</span><span class="o">.</span><span class="n">TarError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
701	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... error occured while trying to read tar-file '</span> <span class="o">+</span>
702	<span class="nb">str</span><span class="p">(</span><span class="n">tarball_path</span><span class="p">))</span>
703	<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
704	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">errno</span><span class="p">))</span>
705	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">strerror</span><span class="p">))</span>
706
707	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... error occured while trying to read tar-file '</span> <span class="o">+</span>
708	<span class="nb">str</span><span class="p">(</span><span class="n">tarball_path</span><span class="p">))</span>
709
710	<span class="k">return</span></div>
711
712	<div class="viewcode-block" id="mk_env_vars"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.mk_env_vars">[docs]</a><span class="k">def</span> <span class="nf">mk_env_vars</span><span class="p">(</span><span class="n">ecuid</span><span class="p">,</span> <span class="n">ecgid</span><span class="p">,</span> <span class="n">gateway</span><span class="p">,</span> <span class="n">destination</span><span class="p">):</span>
713	<span class="sd">'''Creates a file named ECMWF_ENV which contains the</span>
714	<span class="sd"> necessary environmental variables at ECMWF servers.</span>
715	<span class="sd"> It is based on the template ECMWF_ENV.template.</span>
716
717	<span class="sd"> Parameters</span>
718	<span class="sd"> ----------</span>
719	<span class="sd"> ecuid : str</span>
720	<span class="sd"> The user id on ECMWF server.</span>
721
722	<span class="sd"> ecgid : str</span>
723	<span class="sd"> The group id on ECMWF server.</span>
724
725	<span class="sd"> gateway : str</span>
726	<span class="sd"> The gateway server the user is using.</span>
727
728	<span class="sd"> destination : str</span>
729	<span class="sd"> The remote destination which is used to transfer files</span>
730	<span class="sd"> from ECMWF server to local gateway server.</span>
731
732	<span class="sd"> Return</span>
733	<span class="sd"> ------</span>
734
735	<span class="sd"> '''</span>
736	<span class="kn">from</span> <span class="nn">genshi.template.text</span> <span class="kn">import</span> <span class="n">NewTextTemplate</span>
737	<span class="kn">from</span> <span class="nn">genshi.template</span> <span class="kn">import</span> <span class="n">TemplateLoader</span>
738	<span class="kn">from</span> <span class="nn">genshi.template.eval</span> <span class="kn">import</span> <span class="n">UndefinedError</span>
739
740	<span class="k">try</span><span class="p">:</span>
741	<span class="n">loader</span> <span class="o">=</span> <span class="n">TemplateLoader</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_TEMPLATES</span><span class="p">,</span> <span class="n">auto_reload</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
742	<span class="n">ecmwfvars_template</span> <span class="o">=</span> <span class="n">loader</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">TEMPFILE_USER_ENVVARS</span><span class="p">,</span>
743	<span class="bp">cls</span><span class="o">=</span><span class="n">NewTextTemplate</span><span class="p">)</span>
744
745	<span class="n">stream</span> <span class="o">=</span> <span class="n">ecmwfvars_template</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span><span class="n">user_name</span><span class="o">=</span><span class="n">ecuid</span><span class="p">,</span>
746	<span class="n">user_group</span><span class="o">=</span><span class="n">ecgid</span><span class="p">,</span>
747	<span class="n">gateway_name</span><span class="o">=</span><span class="n">gateway</span><span class="p">,</span>
748	<span class="n">destination_name</span><span class="o">=</span><span class="n">destination</span>
749	<span class="p">)</span>
750	<span class="k">except</span> <span class="n">UndefinedError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
751	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
752
753	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... error occured while trying to generate template '</span> <span class="o">+</span>
754	<span class="n">_config</span><span class="o">.</span><span class="n">PATH_ECMWF_ENV</span><span class="p">)</span>
755	<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
756	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">errno</span><span class="p">))</span>
757	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">strerror</span><span class="p">))</span>
758
759	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... error occured while trying to generate template '</span> <span class="o">+</span>
760	<span class="n">_config</span><span class="o">.</span><span class="n">PATH_ECMWF_ENV</span><span class="p">)</span>
761
762	<span class="k">try</span><span class="p">:</span>
763	<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_ECMWF_ENV</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
764	<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">stream</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="s1">'text'</span><span class="p">))</span>
765	<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
766	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">errno</span><span class="p">))</span>
767	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">strerror</span><span class="p">))</span>
768
769	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... error occured while trying to write '</span> <span class="o">+</span>
770	<span class="n">_config</span><span class="o">.</span><span class="n">PATH_ECMWF_ENV</span><span class="p">)</span>
771
772	<span class="k">return</span></div>
773
774	<div class="viewcode-block" id="mk_compilejob"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.mk_compilejob">[docs]</a><span class="k">def</span> <span class="nf">mk_compilejob</span><span class="p">(</span><span class="n">makefile</span><span class="p">,</span> <span class="n">ecuid</span><span class="p">,</span> <span class="n">ecgid</span><span class="p">,</span> <span class="n">fp_root</span><span class="p">):</span>
775	<span class="sd">'''Modifies the original job template file so that it is specified</span>
776	<span class="sd"> for the user and the environment were it will be applied. Result</span>
777	<span class="sd"> is stored in a new file "job.temp" in the python directory.</span>
778
779	<span class="sd"> Parameters</span>
780	<span class="sd"> ----------</span>
781	<span class="sd"> makefile : str</span>
782	<span class="sd"> Name of the makefile which should be used to compile the Fortran</span>
783	<span class="sd"> program.</span>
784
785	<span class="sd"> ecuid : str</span>
786	<span class="sd"> The user id on ECMWF server.</span>
787
788	<span class="sd"> ecgid : str</span>
789	<span class="sd"> The group id on ECMWF server.</span>
790
791	<span class="sd"> fp_root : str</span>
792	<span class="sd"> Path to the root directory of FLEXPART environment or flex_extract</span>
793	<span class="sd"> environment.</span>
794
795	<span class="sd"> Return</span>
796	<span class="sd"> ------</span>
797
798	<span class="sd"> '''</span>
799	<span class="kn">from</span> <span class="nn">genshi.template.text</span> <span class="kn">import</span> <span class="n">NewTextTemplate</span>
800	<span class="kn">from</span> <span class="nn">genshi.template</span> <span class="kn">import</span> <span class="n">TemplateLoader</span>
801	<span class="kn">from</span> <span class="nn">genshi.template.eval</span> <span class="kn">import</span> <span class="n">UndefinedError</span>
802
803	<span class="k">if</span> <span class="n">fp_root</span> <span class="o">==</span> <span class="s1">'../'</span><span class="p">:</span>
804	<span class="n">fp_root</span> <span class="o">=</span> <span class="s1">'$HOME'</span>
805
806	<span class="k">try</span><span class="p">:</span>
807	<span class="n">loader</span> <span class="o">=</span> <span class="n">TemplateLoader</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_TEMPLATES</span><span class="p">,</span> <span class="n">auto_reload</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
808	<span class="n">compile_template</span> <span class="o">=</span> <span class="n">loader</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">TEMPFILE_INSTALL_COMPILEJOB</span><span class="p">,</span>
809	<span class="bp">cls</span><span class="o">=</span><span class="n">NewTextTemplate</span><span class="p">)</span>
810
811	<span class="n">stream</span> <span class="o">=</span> <span class="n">compile_template</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span>
812	<span class="n">usergroup</span><span class="o">=</span><span class="n">ecgid</span><span class="p">,</span>
813	<span class="n">username</span><span class="o">=</span><span class="n">ecuid</span><span class="p">,</span>
814	<span class="n">version_number</span><span class="o">=</span><span class="n">_config</span><span class="o">.</span><span class="n">_VERSION_STR</span><span class="p">,</span>
815	<span class="n">fp_root_scripts</span><span class="o">=</span><span class="n">fp_root</span><span class="p">,</span>
816	<span class="n">makefile</span><span class="o">=</span><span class="n">makefile</span><span class="p">,</span>
817	<span class="n">fortran_program</span><span class="o">=</span><span class="n">_config</span><span class="o">.</span><span class="n">FORTRAN_EXECUTABLE</span>
818	<span class="p">)</span>
819	<span class="k">except</span> <span class="n">UndefinedError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
820	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
821
822	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... error occured while trying to generate template '</span> <span class="o">+</span>
823	<span class="n">_config</span><span class="o">.</span><span class="n">TEMPFILE_INSTALL_COMPILEJOB</span><span class="p">)</span>
824	<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
825	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">errno</span><span class="p">))</span>
826	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">strerror</span><span class="p">))</span>
827
828	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... error occured while trying to generate template '</span> <span class="o">+</span>
829	<span class="n">_config</span><span class="o">.</span><span class="n">TEMPFILE_INSTALL_COMPILEJOB</span><span class="p">)</span>
830
831	<span class="k">try</span><span class="p">:</span>
832	<span class="n">compilejob</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_JOBSCRIPTS</span><span class="p">,</span>
833	<span class="n">_config</span><span class="o">.</span><span class="n">FILE_INSTALL_COMPILEJOB</span><span class="p">)</span>
834
835	<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">compilejob</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
836	<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">stream</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="s1">'text'</span><span class="p">))</span>
837	<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
838	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">errno</span><span class="p">))</span>
839	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">strerror</span><span class="p">))</span>
840
841	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... error occured while trying to write '</span> <span class="o">+</span>
842	<span class="n">compilejob</span><span class="p">)</span>
843
844	<span class="k">return</span></div>
845
846	<div class="viewcode-block" id="mk_job_template"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.mk_job_template">[docs]</a><span class="k">def</span> <span class="nf">mk_job_template</span><span class="p">(</span><span class="n">ecuid</span><span class="p">,</span> <span class="n">ecgid</span><span class="p">,</span> <span class="n">fp_root</span><span class="p">):</span>
847	<span class="sd">'''Modifies the original job template file so that it is specified</span>
848	<span class="sd"> for the user and the environment were it will be applied. Result</span>
849	<span class="sd"> is stored in a new file.</span>
850
851	<span class="sd"> Parameters</span>
852	<span class="sd"> ----------</span>
853	<span class="sd"> ecuid : str</span>
854	<span class="sd"> The user id on ECMWF server.</span>
855
856	<span class="sd"> ecgid : str</span>
857	<span class="sd"> The group id on ECMWF server.</span>
858
859	<span class="sd"> fp_root : str</span>
860	<span class="sd"> Path to the root directory of FLEXPART environment or flex_extract</span>
861	<span class="sd"> environment.</span>
862
863	<span class="sd"> Return</span>
864	<span class="sd"> ------</span>
865
866	<span class="sd"> '''</span>
867	<span class="kn">from</span> <span class="nn">genshi.template.text</span> <span class="kn">import</span> <span class="n">NewTextTemplate</span>
868	<span class="kn">from</span> <span class="nn">genshi.template</span> <span class="kn">import</span> <span class="n">TemplateLoader</span>
869	<span class="kn">from</span> <span class="nn">genshi.template.eval</span> <span class="kn">import</span> <span class="n">UndefinedError</span>
870
871	<span class="n">fp_root_path_to_python</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">fp_root</span><span class="p">,</span>
872	<span class="n">_config</span><span class="o">.</span><span class="n">FLEXEXTRACT_DIRNAME</span><span class="p">,</span>
873	<span class="n">_config</span><span class="o">.</span><span class="n">PATH_REL_PYTHON_SRC</span><span class="p">)</span>
874	<span class="k">if</span> <span class="s1">'$'</span> <span class="ow">in</span> <span class="n">fp_root_path_to_python</span><span class="p">:</span>
875	<span class="n">ind</span> <span class="o">=</span> <span class="n">fp_root_path_to_python</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="s1">'$'</span><span class="p">)</span>
876	<span class="n">fp_root_path_to_python</span> <span class="o">=</span> <span class="n">fp_root_path_to_python</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="n">ind</span><span class="p">]</span> <span class="o">+</span> <span class="s1">'$'</span> <span class="o">+</span> \
877	<span class="n">fp_root_path_to_python</span><span class="p">[</span><span class="n">ind</span><span class="p">:]</span>
878
879	<span class="k">try</span><span class="p">:</span>
880	<span class="n">loader</span> <span class="o">=</span> <span class="n">TemplateLoader</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_TEMPLATES</span><span class="p">,</span> <span class="n">auto_reload</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
881	<span class="n">compile_template</span> <span class="o">=</span> <span class="n">loader</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">TEMPFILE_INSTALL_JOB</span><span class="p">,</span>
882	<span class="bp">cls</span><span class="o">=</span><span class="n">NewTextTemplate</span><span class="p">)</span>
883
884	<span class="n">stream</span> <span class="o">=</span> <span class="n">compile_template</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span>
885	<span class="n">usergroup</span><span class="o">=</span><span class="n">ecgid</span><span class="p">,</span>
886	<span class="n">username</span><span class="o">=</span><span class="n">ecuid</span><span class="p">,</span>
887	<span class="n">version_number</span><span class="o">=</span><span class="n">_config</span><span class="o">.</span><span class="n">_VERSION_STR</span><span class="p">,</span>
888	<span class="n">fp_root_path</span><span class="o">=</span><span class="n">fp_root_path_to_python</span><span class="p">,</span>
889	<span class="p">)</span>
890	<span class="k">except</span> <span class="n">UndefinedError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
891	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="p">))</span>
892
893	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... error occured while trying to generate template '</span> <span class="o">+</span>
894	<span class="n">_config</span><span class="o">.</span><span class="n">TEMPFILE_INSTALL_JOB</span><span class="p">)</span>
895	<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
896	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">errno</span><span class="p">))</span>
897	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">strerror</span><span class="p">))</span>
898
899	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... error occured while trying to generate template '</span> <span class="o">+</span>
900	<span class="n">_config</span><span class="o">.</span><span class="n">TEMPFILE_INSTALL_JOB</span><span class="p">)</span>
901
902
903	<span class="k">try</span><span class="p">:</span>
904	<span class="n">tempjobfile</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_TEMPLATES</span><span class="p">,</span>
905	<span class="n">_config</span><span class="o">.</span><span class="n">TEMPFILE_JOB</span><span class="p">)</span>
906
907	<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">tempjobfile</span><span class="p">,</span> <span class="s1">'w'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
908	<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">stream</span><span class="o">.</span><span class="n">render</span><span class="p">(</span><span class="s1">'text'</span><span class="p">))</span>
909	<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
910	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR CODE: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">errno</span><span class="p">))</span>
911	<span class="nb">print</span><span class="p">(</span><span class="s1">'... ERROR MESSAGE:</span><span class="se">\n</span><span class="s1"> </span><span class="se">\t</span><span class="s1"> '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">strerror</span><span class="p">))</span>
912
913	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">... error occured while trying to write '</span> <span class="o">+</span>
914	<span class="n">tempjobfile</span><span class="p">)</span>
915
916	<span class="k">return</span></div>
917
918	<div class="viewcode-block" id="del_fortran_build"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.del_fortran_build">[docs]</a><span class="k">def</span> <span class="nf">del_fortran_build</span><span class="p">(</span><span class="n">src_path</span><span class="p">):</span>
919	<span class="sd">'''Clean up the Fortran source directory and remove all</span>
920	<span class="sd"> build files (e.g. \.o, \.mod and FORTRAN EXECUTABLE)</span>
921
922	<span class="sd"> Parameters</span>
923	<span class="sd"> ----------</span>
924	<span class="sd"> src_path : str</span>
925	<span class="sd"> Path to the fortran source directory.</span>
926
927	<span class="sd"> Return</span>
928	<span class="sd"> ------</span>
929
930	<span class="sd"> '''</span>
931
932	<span class="n">modfiles</span> <span class="o">=</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">src_path</span><span class="p">,</span> <span class="s1">'*.mod'</span><span class="p">)</span>
933	<span class="n">objfiles</span> <span class="o">=</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">src_path</span><span class="p">,</span> <span class="s1">'*.o'</span><span class="p">)</span>
934	<span class="n">exefile</span> <span class="o">=</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">src_path</span><span class="p">,</span> <span class="n">_config</span><span class="o">.</span><span class="n">FORTRAN_EXECUTABLE</span><span class="p">)</span>
935
936	<span class="n">modfiles</span><span class="o">.</span><span class="n">delete_files</span><span class="p">()</span>
937	<span class="n">objfiles</span><span class="o">.</span><span class="n">delete_files</span><span class="p">()</span>
938	<span class="n">exefile</span><span class="o">.</span><span class="n">delete_files</span><span class="p">()</span>
939
940	<span class="k">return</span></div>
941
942	<div class="viewcode-block" id="mk_fortran_build"><a class="viewcode-back" href="../Documentation/Api/api_python.html#install.mk_fortran_build">[docs]</a><span class="k">def</span> <span class="nf">mk_fortran_build</span><span class="p">(</span><span class="n">src_path</span><span class="p">,</span> <span class="n">makefile</span><span class="p">):</span>
943	<span class="sd">'''Compiles the Fortran code and generates the executable.</span>
944
945	<span class="sd"> Parameters</span>
946	<span class="sd"> ----------</span>
947	<span class="sd"> src_path : str</span>
948	<span class="sd"> Path to the fortran source directory.</span>
949
950	<span class="sd"> makefile : str</span>
951	<span class="sd"> The name of the makefile which should be used.</span>
952
953	<span class="sd"> Return</span>
954	<span class="sd"> ------</span>
955
956	<span class="sd"> '''</span>
957
958	<span class="k">try</span><span class="p">:</span>
959	<span class="nb">print</span><span class="p">(</span><span class="s1">'Using makefile: '</span> <span class="o">+</span> <span class="n">makefile</span><span class="p">)</span>
960	<span class="n">p</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">([</span><span class="s1">'make'</span><span class="p">,</span> <span class="s1">'-f'</span><span class="p">,</span>
961	<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">src_path</span><span class="p">,</span> <span class="n">makefile</span><span class="p">)],</span>
962	<span class="n">stdin</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
963	<span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
964	<span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span>
965	<span class="n">bufsize</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
966	<span class="n">pout</span><span class="p">,</span> <span class="n">perr</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">communicate</span><span class="p">()</span>
967	<span class="nb">print</span><span class="p">(</span><span class="n">pout</span><span class="o">.</span><span class="n">decode</span><span class="p">())</span>
968	<span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">returncode</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span>
969	<span class="nb">print</span><span class="p">(</span><span class="n">perr</span><span class="o">.</span><span class="n">decode</span><span class="p">())</span>
970	<span class="nb">print</span><span class="p">(</span><span class="s1">'Please edit '</span> <span class="o">+</span> <span class="n">makefile</span> <span class="o">+</span>
971	<span class="s1">' or try another makefile in the src directory.'</span><span class="p">)</span>
972	<span class="nb">print</span><span class="p">(</span><span class="s1">'Most likely ECCODES_INCLUDE_DIR, ECCODES_LIB '</span>
973	<span class="s1">'and EMOSLIB must be adapted.'</span><span class="p">)</span>
974	<span class="nb">print</span><span class="p">(</span><span class="s1">'Available makefiles:'</span><span class="p">)</span>
975	<span class="nb">print</span><span class="p">(</span><span class="n">UioFiles</span><span class="p">(</span><span class="n">src_path</span><span class="p">,</span> <span class="s1">'makefile*'</span><span class="p">))</span>
976	<span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="s1">'Compilation failed!'</span><span class="p">)</span>
977	<span class="k">except</span> <span class="ne">ValueError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
978	<span class="nb">print</span><span class="p">(</span><span class="s1">'ERROR: makefile call failed:'</span><span class="p">)</span>
979	<span class="nb">print</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
980	<span class="k">else</span><span class="p">:</span>
981	<span class="n">execute_subprocess</span><span class="p">([</span><span class="s1">'ls'</span><span class="p">,</span> <span class="s1">'-l'</span><span class="p">,</span>
982	<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">src_path</span><span class="p">,</span> <span class="n">_config</span><span class="o">.</span><span class="n">FORTRAN_EXECUTABLE</span><span class="p">)],</span>
983	<span class="n">error_msg</span><span class="o">=</span><span class="s1">'FORTRAN EXECUTABLE COULD NOT BE FOUND!'</span><span class="p">)</span>
984
985	<span class="k">return</span></div>
986
987
988	<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">"__main__"</span><span class="p">:</span>
989	<span class="n">main</span><span class="p">()</span>
990	</pre></div>
991
992	</div>
993
994	</div>
995	<footer>
996
997
998	<hr/>
999
1000	<div role="contentinfo">
1001	<p>
1002	© Copyright 2020, Anne Philipp, Leopold Haimberger and Petra Seibert
1003
1004	</p>
1005	</div>
1006	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>.
1007
1008	</footer>
1009
1010	</div>
1011	</div>
1012
1013	</section>
1014
1015	</div>
1016
1017
1018
1019	<script type="text/javascript">
1020	jQuery(function () {
1021	SphinxRtdTheme.Navigation.enable(true);
1022	});
1023	</script>
1024
1025
1026
1027
1028
1029
1030	</body>
1031	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: