Context Navigation

source: flex_extract.git/documentation/Sphinx/build/html/_modules/submit.html @ 274f9ef

ctbtodev

Last change on this file since 274f9ef was 274f9ef, checked in by Anne Philipp <anne.philipp@…>, 6 years ago
Converted docstrings to numpy style and build first structure for sphinxdocumentation (incl API)
Property mode set to `100644`
File size: 24.1 KB

Line
1
2
3	<!DOCTYPE html>
4	<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5	<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6	<head>
7	<meta charset="utf-8">
8
9	<meta name="viewport" content="width=device-width, initial-scale=1.0">
10
11	<title>submit — flex_extract 7.1 alpha documentation</title>
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27	<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
28	<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
29	<link rel="index" title="Index" href="../genindex.html" />
30	<link rel="search" title="Search" href="../search.html" />
31
32
33	<script src="../_static/js/modernizr.min.js"></script>
34
35	</head>
36
37	<body class="wy-body-for-nav">
38
39
40	<div class="wy-grid-for-nav">
41
42
43	<nav data-toggle="wy-nav-shift" class="wy-nav-side">
44	<div class="wy-side-scroll">
45	<div class="wy-side-nav-search">
46
47
48
49	<a href="../index.html" class="icon icon-home"> flex_extract
50
51
52
53	</a>
54
55
56
57
58	<div class="version">
59	7.1
60	</div>
61
62
63
64
65	<div role="search">
66	<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
67	<input type="text" name="q" placeholder="Search docs" />
68	<input type="hidden" name="check_keywords" value="yes" />
69	<input type="hidden" name="area" value="default" />
70	</form>
71	</div>
72
73
74	</div>
75
76	<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
77
78
79
80
81
82
83	<p class="caption"><span class="caption-text">Table of Contents:</span></p>
84	<ul>
85	<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>
86	<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
87	<li class="toctree-l1"><a class="reference internal" href="../program_structure.html">Program Structure</a></li>
88	<li class="toctree-l1"><a class="reference internal" href="../user_guide.html">User Guide</a></li>
89	<li class="toctree-l1"><a class="reference internal" href="../api.html">Auto Generated Documentation</a></li>
90	<li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li>
91	</ul>
92
93
94
95	</div>
96	</div>
97	</nav>
98
99	<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
100
101
102	<nav class="wy-nav-top" aria-label="top navigation">
103
104	<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
105	<a href="../index.html">flex_extract</a>
106
107	</nav>
108
109
110	<div class="wy-nav-content">
111
112	<div class="rst-content">
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130	<div role="navigation" aria-label="breadcrumbs navigation">
131
132	<ul class="wy-breadcrumbs">
133
134	<li><a href="../index.html">Docs</a> »</li>
135
136	<li><a href="index.html">Module code</a> »</li>
137
138	<li>submit</li>
139
140
141	<li class="wy-breadcrumbs-aside">
142
143	</li>
144
145	</ul>
146
147
148	<hr/>
149	</div>
150	<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
151	<div itemprop="articleBody">
152
153	<h1>Source code for submit</h1><div class="highlight"><pre>
154	<span></span><span class="ch">#!/usr/bin/env python</span>
155	<span class="c1"># -- coding: utf-8 --</span>
156	<span class="c1">#*******************************************************************************</span>
157	<span class="c1"># @Author: Anne Fouilloux (University of Oslo)</span>
158	<span class="c1">#</span>
159	<span class="c1"># @Date: October 2014</span>
160	<span class="c1">#</span>
161	<span class="c1"># @Change History:</span>
162	<span class="c1">#</span>
163	<span class="c1"># November 2015 - Leopold Haimberger (University of Vienna):</span>
164	<span class="c1"># - job submission on ecgate and cca</span>
165	<span class="c1"># - job templates suitable for twice daily operational dissemination</span>
166	<span class="c1">#</span>
167	<span class="c1"># February 2018 - Anne Philipp (University of Vienna):</span>
168	<span class="c1"># - applied PEP8 style guide</span>
169	<span class="c1"># - added documentation</span>
170	<span class="c1"># - minor changes in programming style (for consistence)</span>
171	<span class="c1"># - changed path names to variables from config file</span>
172	<span class="c1"># - added option for writing mars requests to extra file</span>
173	<span class="c1"># additionally,as option without submitting the mars jobs</span>
174	<span class="c1">#</span>
175	<span class="c1"># @License:</span>
176	<span class="c1"># (C) Copyright 2014-2018.</span>
177	<span class="c1">#</span>
178	<span class="c1"># This software is licensed under the terms of the Apache Licence Version 2.0</span>
179	<span class="c1"># which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.</span>
180	<span class="c1">#</span>
181	<span class="c1"># @Program Functionality:</span>
182	<span class="c1"># This program is the main program of flex_extract and controls the</span>
183	<span class="c1"># program flow.</span>
184	<span class="c1"># If it is supposed to work locally then it works through the necessary</span>
185	<span class="c1"># functions get_mars_data and prepareFlexpart. Otherwise it prepares</span>
186	<span class="c1"># a shell job script which will do the necessary work on the</span>
187	<span class="c1"># ECMWF server and is submitted via ecaccess-job-submit.</span>
188	<span class="c1">#</span>
189	<span class="c1"># @Program Content:</span>
190	<span class="c1"># - main</span>
191	<span class="c1"># - submit</span>
192	<span class="c1">#</span>
193	<span class="c1">#*******************************************************************************</span>
194
195	<span class="c1"># ------------------------------------------------------------------------------</span>
196	<span class="c1"># MODULES</span>
197	<span class="c1"># ------------------------------------------------------------------------------</span>
198	<span class="kn">import</span> <span class="nn">os</span>
199	<span class="kn">import</span> <span class="nn">sys</span>
200	<span class="kn">import</span> <span class="nn">subprocess</span>
201	<span class="kn">import</span> <span class="nn">inspect</span>
202	<span class="kn">import</span> <span class="nn">collections</span>
203
204	<span class="c1"># software specific classes and modules from flex_extract</span>
205	<span class="kn">import</span> <span class="nn">_config</span>
206	<span class="kn">from</span> <span class="nn">mods.tools</span> <span class="k">import</span> <span class="p">(</span><span class="n">normal_exit</span><span class="p">,</span> <span class="n">get_cmdline_arguments</span><span class="p">,</span>
207	<span class="n">submit_job_to_ecserver</span><span class="p">,</span> <span class="n">read_ecenv</span><span class="p">)</span>
208	<span class="kn">from</span> <span class="nn">mods.get_mars_data</span> <span class="k">import</span> <span class="n">get_mars_data</span>
209	<span class="kn">from</span> <span class="nn">mods.prepare_flexpart</span> <span class="k">import</span> <span class="n">prepare_flexpart</span>
210	<span class="kn">from</span> <span class="nn">classes.ControlFile</span> <span class="k">import</span> <span class="n">ControlFile</span>
211
212	<span class="c1"># ------------------------------------------------------------------------------</span>
213	<span class="c1"># FUNCTIONS</span>
214	<span class="c1"># ------------------------------------------------------------------------------</span>
215
216	<div class="viewcode-block" id="main"><a class="viewcode-back" href="../api.html#submit.main">[docs]</a><span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
217	<span class="sd">'''Get the arguments from script call and from CONTROL file.</span>
218	<span class="sd"> Decides from the argument "queue" if the local version</span>
219	<span class="sd"> is done "queue=None" or the gateway version with "queue=ecgate"</span>
220	<span class="sd"> or "queue=cca".</span>
221
222	<span class="sd"> Parameters</span>
223	<span class="sd"> ----------</span>
224
225	<span class="sd"> Return</span>
226	<span class="sd"> ------</span>
227
228	<span class="sd"> '''</span>
229
230	<span class="n">args</span> <span class="o">=</span> <span class="n">get_cmdline_arguments</span><span class="p">()</span>
231	<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>
232
233	<span class="n">env_parameter</span> <span class="o">=</span> <span class="n">read_ecenv</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>
234	<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>
235	<span class="n">c</span><span class="o">.</span><span class="n">assign_envs_to_control</span><span class="p">(</span><span class="n">env_parameter</span><span class="p">)</span>
236	<span class="n">c</span><span class="o">.</span><span class="n">check_conditions</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">queue</span><span class="p">)</span>
237
238	<span class="c1"># on local side</span>
239	<span class="c1"># on ECMWF server this would also be the local side</span>
240	<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>
241	<span class="k">if</span> <span class="n">args</span><span class="o">.</span><span class="n">queue</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
242	<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>
243	<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>
244	<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>
245	<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>
246	<span class="n">get_mars_data</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
247	<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>
248	<span class="n">prepare_flexpart</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">ppid</span><span class="p">,</span> <span class="n">c</span><span class="p">)</span>
249	<span class="n">normal_exit</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">mailfail</span><span class="p">,</span> <span class="s1">'FLEX_EXTRACT IS DONE!'</span><span class="p">)</span>
250	<span class="k">else</span><span class="p">:</span>
251	<span class="n">normal_exit</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">mailfail</span><span class="p">,</span> <span class="s1">'PRINTING MARS_REQUESTS DONE!'</span><span class="p">)</span>
252	<span class="c1"># send files to ECMWF server and install there</span>
253	<span class="k">else</span><span class="p">:</span>
254	<span class="n">submit</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">job_template</span><span class="p">,</span> <span class="n">c</span><span class="p">,</span> <span class="n">args</span><span class="o">.</span><span class="n">queue</span><span class="p">)</span>
255
256	<span class="k">return</span></div>
257
258	<div class="viewcode-block" id="submit"><a class="viewcode-back" href="../api.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>
259	<span class="sd">'''Prepares the job script and submit it to the specified queue.</span>
260
261	<span class="sd"> Parameters</span>
262	<span class="sd"> ----------</span>
263	<span class="sd"> jtemplate : :obj:`string`</span>
264	<span class="sd"> Job template file from sub-directory "_templates" for</span>
265	<span class="sd"> submission to ECMWF. It contains all necessary</span>
266	<span class="sd"> module and variable settings for the ECMWF environment as well as</span>
267	<span class="sd"> the job call and mail report instructions.</span>
268	<span class="sd"> Default is "job.temp".</span>
269
270	<span class="sd"> c : :obj:`ControlFile`</span>
271	<span class="sd"> Contains all the parameters of CONTROL file and</span>
272	<span class="sd"> command line.</span>
273
274	<span class="sd"> queue : :obj:`string`</span>
275	<span class="sd"> Name of queue for submission to ECMWF (e.g. ecgate or cca )</span>
276
277	<span class="sd"> Return</span>
278	<span class="sd"> ------</span>
279
280	<span class="sd"> '''</span>
281
282	<span class="c1"># read template file and get index for CONTROL input</span>
283	<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">_config</span><span class="o">.</span><span class="n">PATH_TEMPLATES</span><span class="p">,</span> <span class="n">jtemplate</span><span class="p">))</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
284	<span class="n">lftext</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">read</span><span class="p">()</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span>
285	<span class="n">insert_point</span> <span class="o">=</span> <span class="n">lftext</span><span class="o">.</span><span class="n">index</span><span class="p">(</span><span class="s1">'EOF'</span><span class="p">)</span>
286
287	<span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">basetime</span><span class="p">:</span>
288	<span class="c1"># --------- create on demand job script ------------------------------------</span>
289	<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>
290	<span class="nb">print</span><span class="p">(</span><span class="s1">'---- Pure forecast mode! ----'</span><span class="p">)</span>
291	<span class="k">else</span><span class="p">:</span>
292	<span class="nb">print</span><span class="p">(</span><span class="s1">'---- On-demand mode! ----'</span><span class="p">)</span>
293	<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>
294	<span class="n">jtemplate</span><span class="p">[:</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span> <span class="o">+</span> <span class="s1">'ksh'</span><span class="p">)</span>
295	<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>
296
297	<span class="n">lftextondemand</span> <span class="o">=</span> <span class="n">lftext</span><span class="p">[:</span><span class="n">insert_point</span><span class="p">]</span> <span class="o">+</span> <span class="n">clist</span> <span class="o">+</span> <span class="n">lftext</span><span class="p">[</span><span class="n">insert_point</span><span class="p">:]</span>
298
299	<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>
300	<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">lftextondemand</span><span class="p">))</span>
301
302	<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>
303
304	<span class="k">else</span><span class="p">:</span>
305	<span class="c1"># --------- create operational job script ----------------------------------</span>
306	<span class="nb">print</span><span class="p">(</span><span class="s1">'---- Operational mode! ----'</span><span class="p">)</span>
307	<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>
308	<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>
309
310	<span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">maxstep</span><span class="p">:</span>
311	<span class="n">mt</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">maxstep</span><span class="p">)</span>
312	<span class="k">else</span><span class="p">:</span>
313	<span class="n">mt</span> <span class="o">=</span> <span class="mi">0</span>
314
315	<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>
316	<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>
317	<span class="n">c</span><span class="o">.</span><span class="n">base_time</span> <span class="o">=</span> <span class="s1">'$</span><span class="si">{MSJ_BASETIME}</span><span class="s1">'</span>
318	<span class="k">if</span> <span class="n">mt</span> <span class="o">></span> <span class="mi">24</span><span class="p">:</span>
319	<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>
320
321	<span class="n">colist</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">to_list</span><span class="p">()</span>
322
323	<span class="n">lftextoper</span> <span class="o">=</span> <span class="n">lftext</span><span class="p">[:</span><span class="n">insert_point</span><span class="p">]</span> <span class="o">+</span> <span class="n">colist</span> <span class="o">+</span> <span class="n">lftext</span><span class="p">[</span><span class="n">insert_point</span> <span class="o">+</span> <span class="mi">2</span><span class="p">:]</span>
324
325	<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>
326	<span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">lftextoper</span><span class="p">))</span>
327
328	<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>
329
330	<span class="c1"># --------------------------------------------------------------------------</span>
331	<span class="nb">print</span><span class="p">(</span><span class="s1">'You should get an email with subject flex.hostname.pid'</span><span class="p">)</span>
332
333	<span class="k">return</span></div>
334
335	<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">"__main__"</span><span class="p">:</span>
336	<span class="n">main</span><span class="p">()</span>
337	</pre></div>
338
339	</div>
340
341	</div>
342	<footer>
343
344
345	<hr/>
346
347	<div role="contentinfo">
348	<p>
349	© Copyright 2018, Anne Philipp and Leopold Haimberger.
350
351	</p>
352	</div>
353	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>.
354
355	</footer>
356
357	</div>
358	</div>
359
360	</section>
361
362	</div>
363
364
365
366
367
368	<script type="text/javascript">
369	var DOCUMENTATION_OPTIONS = {
370	URL_ROOT:'../',
371	VERSION:'7.1 alpha',
372	LANGUAGE:'None',
373	COLLAPSE_INDEX:false,
374	FILE_SUFFIX:'.html',
375	HAS_SOURCE: true,
376	SOURCELINK_SUFFIX: '.txt'
377	};
378	</script>
379	<script type="text/javascript" src="../_static/jquery.js"></script>
380	<script type="text/javascript" src="../_static/underscore.js"></script>
381	<script type="text/javascript" src="../_static/doctools.js"></script>
382	<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
383
384
385
386	<script type="text/javascript" src="../_static/js/theme.js"></script>
387
388	<script type="text/javascript">
389	jQuery(function () {
390	SphinxRtdTheme.Navigation.enable(true);
391	});
392	</script>
393
394	</body>
395	</html>

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

Download in other formats: