Context Navigation

source: flex_extract.git/Documentation/html/_modules/submit.html @ 6931f61

ctbtodev

Last change on this file since 6931f61 was 6931f61, checked in by anphi <anne.philipp@…>, 4 years ago
Update Onlinedocumentation after review of language editing
Property mode set to `100644`
File size: 32.8 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>submit — 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>submit</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 submit</h1><div class="highlight"><pre>
163	<span></span><span class="ch">#!/usr/bin/env python3</span>
164	<span class="c1"># -- coding: utf-8 --</span>
165	<span class="c1">#*******************************************************************************</span>
166	<span class="c1"># @Author: Anne Fouilloux (University of Oslo)</span>
167	<span class="c1">#</span>
168	<span class="c1"># @Date: October 2014</span>
169	<span class="c1">#</span>
170	<span class="c1"># @Change History:</span>
171	<span class="c1">#</span>
172	<span class="c1"># November 2015 - Leopold Haimberger (University of Vienna):</span>
173	<span class="c1"># - job submission on ecgate and cca</span>
174	<span class="c1"># - job templates suitable for twice daily operational dissemination</span>
175	<span class="c1">#</span>
176	<span class="c1"># February 2018 - Anne Philipp (University of Vienna):</span>
177	<span class="c1"># - applied PEP8 style guide</span>
178	<span class="c1"># - added documentation</span>
179	<span class="c1"># - minor changes in programming style (for consistence)</span>
180	<span class="c1"># - changed path names to variables from config file</span>
181	<span class="c1"># - added option for writing mars requests to extra file</span>
182	<span class="c1"># additionally, as option without submitting the mars jobs</span>
183	<span class="c1"># - splitted submit function to use genshi templates for the</span>
184	<span class="c1"># job script and avoid code duplication</span>
185	<span class="c1">#</span>
186	<span class="c1"># @License:</span>
187	<span class="c1"># (C) Copyright 2014-2019.</span>
188	<span class="c1"># Anne Philipp, Leopold Haimberger</span>
189	<span class="c1">#</span>
190	<span class="c1"># SPDX-License-Identifier: CC-BY-4.0</span>
191	<span class="c1">#</span>
192	<span class="c1"># This work is licensed under the Creative Commons Attribution 4.0</span>
193	<span class="c1"># International License. To view a copy of this license, visit</span>
194	<span class="c1"># http://creativecommons.org/licenses/by/4.0/ or send a letter to</span>
195	<span class="c1"># Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</span>
196	<span class="c1">#*******************************************************************************</span>
197	<span class="sd">'''This script allows the user to extract meteorological fields from the ECMWF.</span>
198
199	<span class="sd">It prepares the settings for retrieving the data from ECMWF servers and</span>
200	<span class="sd">process the resulting files to prepare them for the use with FLEXPART or</span>
201	<span class="sd">FLEXTRA.</span>
202
203	<span class="sd">If it is supposed to work locally then it works through the necessary</span>
204	<span class="sd">functions get_mars_data and prepare_flexpart. Otherwise it prepares</span>
205	<span class="sd">a job script (korn shell) which will do the necessary work on the</span>
206	<span class="sd">ECMWF server. This script will de submitted via the ecaccess command</span>
207	<span class="sd">ecaccess-job-submit.</span>
208
209	<span class="sd">This file can also be imported as a module which then contains the following</span>
210	<span class="sd">functions:</span>
211
212	<span class="sd"> * main - the main function of the script</span>
213	<span class="sd"> * submit - calls mk_jobscript depending on operation mode and submits its</span>
214	<span class="sd"> * mk_jobscript - creates the job script from a template</span>
215
216	<span class="sd">Type: submit.py --help</span>
217	<span class="sd">to get information about command line parameters.</span>
218	<span class="sd">Read the documentation for usage instructions.</span>
219	<span class="sd">'''</span>
220
221	<span class="c1"># ------------------------------------------------------------------------------</span>
222	<span class="c1"># MODULES</span>
223	<span class="c1"># ------------------------------------------------------------------------------</span>
224	<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">print_function</span>
225
226	<span class="kn">import</span> <span class="nn">os</span>
227	<span class="kn">import</span> <span class="nn">sys</span>
228	<span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timedelta</span>
229
230	<span class="c1"># software specific classes and modules from flex_extract</span>
231	<span class="kn">import</span> <span class="nn">_config</span>
232	<span class="kn">from</span> <span class="nn">Mods.tools</span> <span class="kn">import</span> <span class="p">(</span><span class="n">setup_controldata</span><span class="p">,</span> <span class="n">normal_exit</span><span class="p">,</span>
233	<span class="n">submit_job_to_ecserver</span><span class="p">)</span>
234	<span class="kn">from</span> <span class="nn">Mods.get_mars_data</span> <span class="kn">import</span> <span class="n">get_mars_data</span>
235	<span class="kn">from</span> <span class="nn">Mods.prepare_flexpart</span> <span class="kn">import</span> <span class="n">prepare_flexpart</span>
236	<span class="c1">#from Classes.ControlFile import ControlFile</span>
237
238
239	<span class="c1"># ------------------------------------------------------------------------------</span>
240	<span class="c1"># METHODS</span>
241	<span class="c1"># ------------------------------------------------------------------------------</span>
242
243	<div class="viewcode-block" id="main"><a class="viewcode-back" href="../Documentation/Api/api_python.html#submit.main">[docs]</a><span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
244	<span class="sd">'''Get the arguments from script call and from CONTROL file.</span>
245	<span class="sd"> Decides from the argument "queue" if the local version</span>
246	<span class="sd"> is done "queue=None" or the gateway version with "queue=ecgate"</span>
247	<span class="sd"> or "queue=cca".</span>
248
249	<span class="sd"> Parameters</span>
250	<span class="sd"> ----------</span>
251
252
253	<span class="sd"> Return</span>
254	<span class="sd"> ------</span>
255
256	<span class="sd"> '''</span>
257
258	<span class="n">c</span><span class="p">,</span> <span class="n">ppid</span><span class="p">,</span> <span class="n">queue</span><span class="p">,</span> <span class="n">job_template</span> <span class="o">=</span> <span class="n">setup_controldata</span><span class="p">()</span>
259
260	<span class="c1"># on local side</span>
261	<span class="c1"># starting from an ECMWF server this would also be the local side</span>
262	<span class="n">called_from_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span>
263	<span class="k">if</span> <span class="n">queue</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
264	<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">inputdir</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">'/'</span><span class="p">:</span>
265	<span class="n">c</span><span class="o">.</span><span class="n">inputdir</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">called_from_dir</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">inputdir</span><span class="p">)</span>
266	<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">outputdir</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">'/'</span><span class="p">:</span>
267	<span class="n">c</span><span class="o">.</span><span class="n">outputdir</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">called_from_dir</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">outputdir</span><span class="p">)</span>
268	<span class="n">get_mars_data</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
269	<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">request</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">c</span><span class="o">.</span><span class="n">request</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
270	<span class="n">prepare_flexpart</span><span class="p">(</span><span class="n">ppid</span><span class="p">,</span> <span class="n">c</span><span class="p">)</span>
271	<span class="n">exit_message</span> <span class="o">=</span> <span class="s1">'FLEX_EXTRACT IS DONE!'</span>
272	<span class="k">else</span><span class="p">:</span>
273	<span class="n">exit_message</span> <span class="o">=</span> <span class="s1">'PRINTING MARS_REQUESTS DONE!'</span>
274	<span class="c1"># send files to ECMWF server</span>
275	<span class="k">else</span><span class="p">:</span>
276	<span class="n">submit</span><span class="p">(</span><span class="n">job_template</span><span class="p">,</span> <span class="n">c</span><span class="p">,</span> <span class="n">queue</span><span class="p">)</span>
277	<span class="n">exit_message</span> <span class="o">=</span> <span class="s1">'FLEX_EXTRACT JOB SCRIPT IS SUBMITED!'</span>
278
279	<span class="n">normal_exit</span><span class="p">(</span><span class="n">exit_message</span><span class="p">)</span>
280
281	<span class="k">return</span></div>
282
283	<div class="viewcode-block" id="submit"><a class="viewcode-back" href="../Documentation/Api/api_python.html#submit.submit">[docs]</a><span class="k">def</span> <span class="nf">submit</span><span class="p">(</span><span class="n">jtemplate</span><span class="p">,</span> <span class="n">c</span><span class="p">,</span> <span class="n">queue</span><span class="p">):</span>
284	<span class="sd">'''Prepares the job script and submits it to the specified queue.</span>
285
286	<span class="sd"> Parameters</span>
287	<span class="sd"> ----------</span>
288	<span class="sd"> jtemplate : str</span>
289	<span class="sd"> Job template file from sub-directory "_templates" for</span>
290	<span class="sd"> submission to ECMWF. It contains all necessary</span>
291	<span class="sd"> module and variable settings for the ECMWF environment as well as</span>
292	<span class="sd"> the job call and mail report instructions.</span>
293	<span class="sd"> Default is "job.temp".</span>
294
295	<span class="sd"> c : ControlFile</span>
296	<span class="sd"> Contains all the parameters of CONTROL file and</span>
297	<span class="sd"> command line.</span>
298
299	<span class="sd"> queue : str</span>
300	<span class="sd"> Name of queue for submission to ECMWF (e.g. ecgate or cca )</span>
301
302	<span class="sd"> Return</span>
303	<span class="sd"> ------</span>
304
305	<span class="sd"> '''</span>
306
307	<span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">oper</span><span class="p">:</span>
308	<span class="c1"># --------- create on demand job script ------------------------------------</span>
309	<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">purefc</span><span class="p">:</span>
310	<span class="nb">print</span><span class="p">(</span><span class="s1">'---- Pure forecast mode! ----'</span><span class="p">)</span>
311	<span class="k">else</span><span class="p">:</span>
312	<span class="nb">print</span><span class="p">(</span><span class="s1">'---- On-demand mode! ----'</span><span class="p">)</span>
313
314	<span class="n">job_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_JOBSCRIPTS</span><span class="p">,</span>
315	<span class="n">jtemplate</span><span class="p">[:</span><span class="o">-</span><span class="mi">5</span><span class="p">]</span> <span class="o">+</span> <span class="s1">'.ksh'</span><span class="p">)</span>
316
317	<span class="c1"># divide time periode into specified number of job chunks</span>
318	<span class="c1"># to have multiple job scripts</span>
319	<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">job_chunk</span><span class="p">:</span>
320	<span class="n">start</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">start_date</span><span class="p">,</span> <span class="s1">'%Y%m</span><span class="si">%d</span><span class="s1">'</span><span class="p">)</span>
321	<span class="n">end</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">end_date</span><span class="p">,</span> <span class="s1">'%Y%m</span><span class="si">%d</span><span class="s1">'</span><span class="p">)</span>
322	<span class="n">chunk</span> <span class="o">=</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="n">c</span><span class="o">.</span><span class="n">job_chunk</span><span class="p">)</span>
323	<span class="n">oneday</span> <span class="o">=</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
324
325	<span class="k">while</span> <span class="n">start</span> <span class="o"><=</span> <span class="n">end</span><span class="p">:</span>
326	<span class="k">if</span> <span class="p">(</span><span class="n">start</span> <span class="o">+</span> <span class="n">chunk</span><span class="p">)</span> <span class="o"><=</span> <span class="n">end</span><span class="p">:</span>
327	<span class="n">c</span><span class="o">.</span><span class="n">end_date</span> <span class="o">=</span> <span class="p">(</span><span class="n">start</span> <span class="o">+</span> <span class="n">chunk</span> <span class="o">-</span> <span class="n">oneday</span><span class="p">)</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">"%Y%m</span><span class="si">%d</span><span class="s2">"</span><span class="p">)</span>
328	<span class="k">else</span><span class="p">:</span>
329	<span class="n">c</span><span class="o">.</span><span class="n">end_date</span> <span class="o">=</span> <span class="n">end</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">"%Y%m</span><span class="si">%d</span><span class="s2">"</span><span class="p">)</span>
330
331	<span class="n">clist</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">to_list</span><span class="p">()</span>
332	<span class="n">mk_jobscript</span><span class="p">(</span><span class="n">jtemplate</span><span class="p">,</span> <span class="n">job_file</span><span class="p">,</span> <span class="n">clist</span><span class="p">)</span>
333
334	<span class="n">job_id</span> <span class="o">=</span> <span class="n">submit_job_to_ecserver</span><span class="p">(</span><span class="n">queue</span><span class="p">,</span> <span class="n">job_file</span><span class="p">)</span>
335	<span class="nb">print</span><span class="p">(</span><span class="s1">'The job id is: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">job_id</span><span class="o">.</span><span class="n">strip</span><span class="p">()))</span>
336
337	<span class="n">start</span> <span class="o">=</span> <span class="n">start</span> <span class="o">+</span> <span class="n">chunk</span>
338	<span class="n">c</span><span class="o">.</span><span class="n">start_date</span> <span class="o">=</span> <span class="n">start</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">"%Y%m</span><span class="si">%d</span><span class="s2">"</span><span class="p">)</span>
339	<span class="c1"># submit a single job script</span>
340	<span class="k">else</span><span class="p">:</span>
341	<span class="n">clist</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">to_list</span><span class="p">()</span>
342
343	<span class="n">mk_jobscript</span><span class="p">(</span><span class="n">jtemplate</span><span class="p">,</span> <span class="n">job_file</span><span class="p">,</span> <span class="n">clist</span><span class="p">)</span>
344
345	<span class="n">job_id</span> <span class="o">=</span> <span class="n">submit_job_to_ecserver</span><span class="p">(</span><span class="n">queue</span><span class="p">,</span> <span class="n">job_file</span><span class="p">)</span>
346	<span class="nb">print</span><span class="p">(</span><span class="s1">'The job id is: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">job_id</span><span class="o">.</span><span class="n">strip</span><span class="p">()))</span>
347
348	<span class="k">else</span><span class="p">:</span>
349	<span class="c1"># --------- create operational job script ----------------------------------</span>
350	<span class="nb">print</span><span class="p">(</span><span class="s1">'---- Operational mode! ----'</span><span class="p">)</span>
351
352	<span class="n">job_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_JOBSCRIPTS</span><span class="p">,</span>
353	<span class="n">jtemplate</span><span class="p">[:</span><span class="o">-</span><span class="mi">5</span><span class="p">]</span> <span class="o">+</span> <span class="s1">'oper.ksh'</span><span class="p">)</span>
354
355	<span class="n">c</span><span class="o">.</span><span class="n">start_date</span> <span class="o">=</span> <span class="s1">'$</span><span class="si">{MSJ_YEAR}</span><span class="s1">$</span><span class="si">{MSJ_MONTH}</span><span class="s1">$</span><span class="si">{MSJ_DAY}</span><span class="s1">'</span>
356	<span class="n">c</span><span class="o">.</span><span class="n">end_date</span> <span class="o">=</span> <span class="s1">'$</span><span class="si">{MSJ_YEAR}</span><span class="s1">$</span><span class="si">{MSJ_MONTH}</span><span class="s1">$</span><span class="si">{MSJ_DAY}</span><span class="s1">'</span>
357	<span class="n">c</span><span class="o">.</span><span class="n">basetime</span> <span class="o">=</span> <span class="s1">'$</span><span class="si">{MSJ_BASETIME}</span><span class="s1">'</span>
358	<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">maxstep</span> <span class="o">></span> <span class="mi">24</span><span class="p">:</span>
359	<span class="n">c</span><span class="o">.</span><span class="n">time</span> <span class="o">=</span> <span class="s1">'$</span><span class="si">{MSJ_BASETIME}</span><span class="s1"> </span><span class="si">{MSJ_BASETIME}</span><span class="s1">'</span>
360
361	<span class="n">clist</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">to_list</span><span class="p">()</span>
362
363	<span class="n">mk_jobscript</span><span class="p">(</span><span class="n">jtemplate</span><span class="p">,</span> <span class="n">job_file</span><span class="p">,</span> <span class="n">clist</span><span class="p">)</span>
364
365	<span class="n">job_id</span> <span class="o">=</span> <span class="n">submit_job_to_ecserver</span><span class="p">(</span><span class="n">queue</span><span class="p">,</span> <span class="n">job_file</span><span class="p">)</span>
366	<span class="nb">print</span><span class="p">(</span><span class="s1">'The job id is: '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">job_id</span><span class="o">.</span><span class="n">strip</span><span class="p">()))</span>
367
368	<span class="nb">print</span><span class="p">(</span><span class="s1">'You should get an email per job with subject flex.hostname.pid'</span><span class="p">)</span>
369
370	<span class="k">return</span></div>
371
372	<div class="viewcode-block" id="mk_jobscript"><a class="viewcode-back" href="../Documentation/Api/api_python.html#submit.mk_jobscript">[docs]</a><span class="k">def</span> <span class="nf">mk_jobscript</span><span class="p">(</span><span class="n">jtemplate</span><span class="p">,</span> <span class="n">job_file</span><span class="p">,</span> <span class="n">clist</span><span class="p">):</span>
373	<span class="sd">'''Creates the job script from template.</span>
374
375	<span class="sd"> Parameters</span>
376	<span class="sd"> ----------</span>
377	<span class="sd"> jtemplate : str</span>
378	<span class="sd"> Job template file from sub-directory "_templates" for</span>
379	<span class="sd"> submission to ECMWF. It contains all necessary</span>
380	<span class="sd"> module and variable settings for the ECMWF environment as well as</span>
381	<span class="sd"> the job call and mail report instructions.</span>
382	<span class="sd"> Default is "job.temp".</span>
383
384	<span class="sd"> job_file : str</span>
385	<span class="sd"> Path to the job script file.</span>
386
387	<span class="sd"> clist : list of str</span>
388	<span class="sd"> Contains all necessary parameters for ECMWF CONTROL file.</span>
389
390	<span class="sd"> Return</span>
391	<span class="sd"> ------</span>
392
393	<span class="sd"> '''</span>
394	<span class="kn">from</span> <span class="nn">genshi.template.text</span> <span class="kn">import</span> <span class="n">NewTextTemplate</span>
395	<span class="kn">from</span> <span class="nn">genshi.template</span> <span class="kn">import</span> <span class="n">TemplateLoader</span>
396	<span class="kn">from</span> <span class="nn">genshi.template.eval</span> <span class="kn">import</span> <span class="n">UndefinedError</span>
397
398	<span class="c1"># load template and insert control content as list</span>
399	<span class="k">try</span><span class="p">:</span>
400	<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>
401	<span class="n">control_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">jtemplate</span><span class="p">,</span>
402	<span class="bp">cls</span><span class="o">=</span><span class="n">NewTextTemplate</span><span class="p">)</span>
403
404	<span class="n">stream</span> <span class="o">=</span> <span class="n">control_template</span><span class="o">.</span><span class="n">generate</span><span class="p">(</span><span class="n">control_content</span><span class="o">=</span><span class="n">clist</span><span class="p">)</span>
405	<span class="k">except</span> <span class="n">UndefinedError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
406	<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>
407
408	<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 jobscript'</span><span class="p">)</span>
409	<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
410	<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>
411	<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>
412
413	<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 jobscript'</span><span class="p">)</span>
414
415	<span class="c1"># create jobscript file</span>
416	<span class="k">try</span><span class="p">:</span>
417	<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">job_file</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>
418	<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>
419	<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
420	<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>
421	<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>
422
423	<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> <span class="n">job_file</span><span class="p">)</span>
424
425	<span class="k">return</span></div>
426
427
428	<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">"__main__"</span><span class="p">:</span>
429	<span class="n">main</span><span class="p">()</span>
430	</pre></div>
431
432	</div>
433
434	</div>
435	<footer>
436
437
438	<hr/>
439
440	<div role="contentinfo">
441	<p>
442	© Copyright 2020, Anne Philipp, Leopold Haimberger and Petra Seibert
443
444	</p>
445	</div>
446	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>.
447
448	</footer>
449
450	</div>
451	</div>
452
453	</section>
454
455	</div>
456
457
458
459	<script type="text/javascript">
460	jQuery(function () {
461	SphinxRtdTheme.Navigation.enable(true);
462	});
463	</script>
464
465
466
467
468
469
470	</body>
471	</html>

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

Download in other formats: