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>Python’s Auto Generated Documentation — flex_extract 7.1 alpha documentation</title> |
---|
12 | |
---|
13 | |
---|
14 | |
---|
15 | |
---|
16 | |
---|
17 | |
---|
18 | |
---|
19 | |
---|
20 | <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script> |
---|
21 | |
---|
22 | |
---|
23 | <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> |
---|
24 | <script type="text/javascript" src="../../_static/jquery.js"></script> |
---|
25 | <script type="text/javascript" src="../../_static/underscore.js"></script> |
---|
26 | <script type="text/javascript" src="../../_static/doctools.js"></script> |
---|
27 | <script type="text/javascript" src="../../_static/language_data.js"></script> |
---|
28 | <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
---|
29 | |
---|
30 | <script type="text/javascript" src="../../_static/js/theme.js"></script> |
---|
31 | |
---|
32 | |
---|
33 | |
---|
34 | |
---|
35 | <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
---|
36 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
---|
37 | <link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" /> |
---|
38 | <link rel="stylesheet" href="../../_static/css/theme_overrides.css" type="text/css" /> |
---|
39 | <link rel="index" title="Index" href="../../genindex.html" /> |
---|
40 | <link rel="search" title="Search" href="../../search.html" /> |
---|
41 | <link rel="next" title="Fortran’s Auto Generated Documentation" href="api_fortran.html" /> |
---|
42 | <link rel="prev" title="Auto Generated Documentation" href="../api.html" /> |
---|
43 | </head> |
---|
44 | |
---|
45 | <body class="wy-body-for-nav"> |
---|
46 | |
---|
47 | |
---|
48 | <div class="wy-grid-for-nav"> |
---|
49 | |
---|
50 | <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
---|
51 | <div class="wy-side-scroll"> |
---|
52 | <div class="wy-side-nav-search" > |
---|
53 | |
---|
54 | |
---|
55 | |
---|
56 | <a href="../../index.html" class="icon icon-home"> flex_extract |
---|
57 | |
---|
58 | |
---|
59 | |
---|
60 | </a> |
---|
61 | |
---|
62 | |
---|
63 | |
---|
64 | |
---|
65 | <div class="version"> |
---|
66 | 7.1 |
---|
67 | </div> |
---|
68 | |
---|
69 | |
---|
70 | |
---|
71 | |
---|
72 | <div role="search"> |
---|
73 | <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> |
---|
74 | <input type="text" name="q" placeholder="Search docs" /> |
---|
75 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
76 | <input type="hidden" name="area" value="default" /> |
---|
77 | </form> |
---|
78 | </div> |
---|
79 | |
---|
80 | |
---|
81 | </div> |
---|
82 | |
---|
83 | <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
---|
84 | |
---|
85 | |
---|
86 | |
---|
87 | |
---|
88 | |
---|
89 | |
---|
90 | <p class="caption"><span class="caption-text">Table of Contents:</span></p> |
---|
91 | <ul class="current"> |
---|
92 | <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li> |
---|
93 | <li class="toctree-l1"><a class="reference internal" href="../../quick_start.html">Quick Start</a></li> |
---|
94 | <li class="toctree-l1"><a class="reference internal" href="../../ecmwf_data.html">ECMWF Data</a></li> |
---|
95 | <li class="toctree-l1 current"><a class="reference internal" href="../../documentation.html">Documentation</a><ul class="current"> |
---|
96 | <li class="toctree-l2"><a class="reference internal" href="../overview.html">Overview</a></li> |
---|
97 | <li class="toctree-l2"><a class="reference internal" href="../input.html">Control & Input Data</a></li> |
---|
98 | <li class="toctree-l2"><a class="reference internal" href="../output.html">Output Data</a></li> |
---|
99 | <li class="toctree-l2"><a class="reference internal" href="../disagg.html">Disaggregation of Flux Data</a></li> |
---|
100 | <li class="toctree-l2"><a class="reference internal" href="../vertco.html">Vertical Coordinate</a></li> |
---|
101 | <li class="toctree-l2 current"><a class="reference internal" href="../api.html">Auto Generated Documentation</a><ul class="current"> |
---|
102 | <li class="toctree-l3 current"><a class="current reference internal" href="#">Python’s Auto Generated Documentation</a><ul> |
---|
103 | <li class="toctree-l4"><a class="reference internal" href="#programs">Programs</a></li> |
---|
104 | <li class="toctree-l4"><a class="reference internal" href="#classes">Classes</a></li> |
---|
105 | <li class="toctree-l4"><a class="reference internal" href="#modules">Modules</a></li> |
---|
106 | </ul> |
---|
107 | </li> |
---|
108 | <li class="toctree-l3"><a class="reference internal" href="api_fortran.html">Fortran’s Auto Generated Documentation</a></li> |
---|
109 | </ul> |
---|
110 | </li> |
---|
111 | </ul> |
---|
112 | </li> |
---|
113 | <li class="toctree-l1"><a class="reference internal" href="../../evaluation.html">Evaluation</a></li> |
---|
114 | <li class="toctree-l1"><a class="reference internal" href="../../dev_guide.html">Developer Guide</a></li> |
---|
115 | <li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changelog</a></li> |
---|
116 | <li class="toctree-l1"><a class="reference internal" href="../../support.html">Support</a></li> |
---|
117 | <li class="toctree-l1"><a class="reference internal" href="../../Support/faq.html">FAQ - Frequently asked questions</a></li> |
---|
118 | <li class="toctree-l1"><a class="reference internal" href="../../authors.html">Developer Team</a></li> |
---|
119 | </ul> |
---|
120 | |
---|
121 | |
---|
122 | |
---|
123 | </div> |
---|
124 | </div> |
---|
125 | </nav> |
---|
126 | |
---|
127 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
---|
128 | |
---|
129 | |
---|
130 | <nav class="wy-nav-top" aria-label="top navigation"> |
---|
131 | |
---|
132 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
---|
133 | <a href="../../index.html">flex_extract</a> |
---|
134 | |
---|
135 | </nav> |
---|
136 | |
---|
137 | |
---|
138 | <div class="wy-nav-content"> |
---|
139 | |
---|
140 | <div class="rst-content"> |
---|
141 | |
---|
142 | |
---|
143 | |
---|
144 | |
---|
145 | |
---|
146 | |
---|
147 | |
---|
148 | |
---|
149 | |
---|
150 | |
---|
151 | |
---|
152 | |
---|
153 | |
---|
154 | |
---|
155 | |
---|
156 | |
---|
157 | |
---|
158 | <div role="navigation" aria-label="breadcrumbs navigation"> |
---|
159 | |
---|
160 | <ul class="wy-breadcrumbs"> |
---|
161 | |
---|
162 | <li><a href="../../index.html">Docs</a> »</li> |
---|
163 | |
---|
164 | <li><a href="../../documentation.html">Documentation</a> »</li> |
---|
165 | |
---|
166 | <li><a href="../api.html">Auto Generated Documentation</a> »</li> |
---|
167 | |
---|
168 | <li>Python’s Auto Generated Documentation</li> |
---|
169 | |
---|
170 | |
---|
171 | <li class="wy-breadcrumbs-aside"> |
---|
172 | |
---|
173 | |
---|
174 | <a href="../../_sources/Documentation/Api/api_python.rst.txt" rel="nofollow"> View page source</a> |
---|
175 | |
---|
176 | |
---|
177 | </li> |
---|
178 | |
---|
179 | </ul> |
---|
180 | |
---|
181 | |
---|
182 | <hr/> |
---|
183 | </div> |
---|
184 | <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
---|
185 | <div itemprop="articleBody"> |
---|
186 | |
---|
187 | <div class="section" id="python-s-auto-generated-documentation"> |
---|
188 | <h1>Python’s Auto Generated Documentation<a class="headerlink" href="#python-s-auto-generated-documentation" title="Permalink to this headline">¶</a></h1> |
---|
189 | <div class="contents local topic" id="contents"> |
---|
190 | <ul class="simple"> |
---|
191 | <li><a class="reference internal" href="#programs" id="id3">Programs</a><ul> |
---|
192 | <li><a class="reference internal" href="#module-install" id="id4">install</a></li> |
---|
193 | <li><a class="reference internal" href="#module-submit" id="id5">submit</a></li> |
---|
194 | </ul> |
---|
195 | </li> |
---|
196 | <li><a class="reference internal" href="#classes" id="id6">Classes</a><ul> |
---|
197 | <li><a class="reference internal" href="#module-ControlFile" id="id7">ControlFile</a></li> |
---|
198 | <li><a class="reference internal" href="#module-EcFlexpart" id="id8">EcFlexpart</a></li> |
---|
199 | <li><a class="reference internal" href="#module-GribUtil" id="id9">GribUtil</a></li> |
---|
200 | <li><a class="reference internal" href="#module-MarsRetrieval" id="id10">MarsRetrieval</a></li> |
---|
201 | <li><a class="reference internal" href="#module-UioFiles" id="id11">UioFiles</a></li> |
---|
202 | </ul> |
---|
203 | </li> |
---|
204 | <li><a class="reference internal" href="#modules" id="id12">Modules</a><ul> |
---|
205 | <li><a class="reference internal" href="#module-get_mars_data" id="id13">get_mars_data</a></li> |
---|
206 | <li><a class="reference internal" href="#module-prepare_flexpart" id="id14">prepare_flexpart</a></li> |
---|
207 | <li><a class="reference internal" href="#module-tools" id="id15">tools</a></li> |
---|
208 | <li><a class="reference internal" href="#module-checks" id="id16">checks</a></li> |
---|
209 | <li><a class="reference internal" href="#module-disaggregation" id="id17">disaggregation</a></li> |
---|
210 | </ul> |
---|
211 | </li> |
---|
212 | </ul> |
---|
213 | </div> |
---|
214 | <div class="section" id="programs"> |
---|
215 | <h2><a class="toc-backref" href="#id3">Programs</a><a class="headerlink" href="#programs" title="Permalink to this headline">¶</a></h2> |
---|
216 | <div class="section" id="module-install"> |
---|
217 | <span id="install"></span><h3><a class="toc-backref" href="#id4">install</a><a class="headerlink" href="#module-install" title="Permalink to this headline">¶</a></h3> |
---|
218 | <p>This script installs the flex_extract program.</p> |
---|
219 | <p>Depending on the selected installation environment (locally or on the |
---|
220 | ECMWF server ecgate or cca) the program extracts the commandline |
---|
221 | arguments and the CONTROL file parameter and prepares the corresponding |
---|
222 | environment. |
---|
223 | The necessary files are collected in a tar-ball and placed |
---|
224 | at the target location. There its untared, the environment variables will |
---|
225 | be set and the Fortran code will be compiled. |
---|
226 | If the ECMWF environment is selected a job script is prepared and submitted |
---|
227 | for the remaining configurations after putting the tar-ball to the |
---|
228 | target ECMWF server.</p> |
---|
229 | <p>Type: install.py –help |
---|
230 | to get information about command line parameters. |
---|
231 | Read the documentation for usage instructions.</p> |
---|
232 | <dl class="function"> |
---|
233 | <dt id="install.check_install_conditions"> |
---|
234 | <code class="descclassname">install.</code><code class="descname">check_install_conditions</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#check_install_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.check_install_conditions" title="Permalink to this definition">¶</a></dt> |
---|
235 | <dd><p>Checks a couple of necessary attributes and conditions |
---|
236 | for the installation such as if they exist and contain values. |
---|
237 | Otherwise set default values.</p> |
---|
238 | <table class="docutils field-list" frame="void" rules="none"> |
---|
239 | <col class="field-name" /> |
---|
240 | <col class="field-body" /> |
---|
241 | <tbody valign="top"> |
---|
242 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
243 | command line.</td> |
---|
244 | </tr> |
---|
245 | </tbody> |
---|
246 | </table> |
---|
247 | </dd></dl> |
---|
248 | |
---|
249 | <dl class="function"> |
---|
250 | <dt id="install.del_convert_build"> |
---|
251 | <code class="descclassname">install.</code><code class="descname">del_convert_build</code><span class="sig-paren">(</span><em>src_path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#del_convert_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.del_convert_build" title="Permalink to this definition">¶</a></dt> |
---|
252 | <dd><p>Clean up the Fortran source directory and remove all |
---|
253 | build files (e.g. *.o, *.mod and CONVERT2)</p> |
---|
254 | <table class="docutils field-list" frame="void" rules="none"> |
---|
255 | <col class="field-name" /> |
---|
256 | <col class="field-body" /> |
---|
257 | <tbody valign="top"> |
---|
258 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>src_path</strong> (<em>str</em>) – Path to the fortran source directory.</td> |
---|
259 | </tr> |
---|
260 | </tbody> |
---|
261 | </table> |
---|
262 | </dd></dl> |
---|
263 | |
---|
264 | <dl class="function"> |
---|
265 | <dt id="install.get_install_cmdline_args"> |
---|
266 | <code class="descclassname">install.</code><code class="descname">get_install_cmdline_args</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#get_install_cmdline_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.get_install_cmdline_args" title="Permalink to this definition">¶</a></dt> |
---|
267 | <dd><p>Decomposes the command line arguments and assigns them to variables. |
---|
268 | Apply default values for non mentioned arguments.</p> |
---|
269 | <table class="docutils field-list" frame="void" rules="none"> |
---|
270 | <col class="field-name" /> |
---|
271 | <col class="field-body" /> |
---|
272 | <tbody valign="top"> |
---|
273 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>args</strong> – Contains the commandline arguments from script/program call.</td> |
---|
274 | </tr> |
---|
275 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Namespace</td> |
---|
276 | </tr> |
---|
277 | </tbody> |
---|
278 | </table> |
---|
279 | </dd></dl> |
---|
280 | |
---|
281 | <dl class="function"> |
---|
282 | <dt id="install.install_local"> |
---|
283 | <code class="descclassname">install.</code><code class="descname">install_local</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#install_local"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.install_local" title="Permalink to this definition">¶</a></dt> |
---|
284 | <dd><p>Perform the actual installation on a local machine.</p> |
---|
285 | <table class="docutils field-list" frame="void" rules="none"> |
---|
286 | <col class="field-name" /> |
---|
287 | <col class="field-body" /> |
---|
288 | <tbody valign="top"> |
---|
289 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
290 | command line.</td> |
---|
291 | </tr> |
---|
292 | </tbody> |
---|
293 | </table> |
---|
294 | </dd></dl> |
---|
295 | |
---|
296 | <dl class="function"> |
---|
297 | <dt id="install.install_via_gateway"> |
---|
298 | <code class="descclassname">install.</code><code class="descname">install_via_gateway</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#install_via_gateway"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.install_via_gateway" title="Permalink to this definition">¶</a></dt> |
---|
299 | <dd><p>Prepare data transfer to remote gate and submit a job script which will |
---|
300 | install everything on the remote gate.</p> |
---|
301 | <table class="docutils field-list" frame="void" rules="none"> |
---|
302 | <col class="field-name" /> |
---|
303 | <col class="field-body" /> |
---|
304 | <tbody valign="top"> |
---|
305 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
306 | command line.</td> |
---|
307 | </tr> |
---|
308 | </tbody> |
---|
309 | </table> |
---|
310 | </dd></dl> |
---|
311 | |
---|
312 | <dl class="function"> |
---|
313 | <dt id="install.main"> |
---|
314 | <code class="descclassname">install.</code><code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.main" title="Permalink to this definition">¶</a></dt> |
---|
315 | <dd><p>Controls the installation process. Calls the installation function |
---|
316 | if target is specified.</p> |
---|
317 | </dd></dl> |
---|
318 | |
---|
319 | <dl class="function"> |
---|
320 | <dt id="install.mk_compilejob"> |
---|
321 | <code class="descclassname">install.</code><code class="descname">mk_compilejob</code><span class="sig-paren">(</span><em>makefile</em>, <em>ecuid</em>, <em>ecgid</em>, <em>fp_root</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#mk_compilejob"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_compilejob" title="Permalink to this definition">¶</a></dt> |
---|
322 | <dd><p>Modifies the original job template file so that it is specified |
---|
323 | for the user and the environment were it will be applied. Result |
---|
324 | is stored in a new file “job.temp” in the python directory.</p> |
---|
325 | <table class="docutils field-list" frame="void" rules="none"> |
---|
326 | <col class="field-name" /> |
---|
327 | <col class="field-body" /> |
---|
328 | <tbody valign="top"> |
---|
329 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
330 | <li><strong>makefile</strong> (<em>str</em>) – Name of the makefile which should be used to compile FORTRAN |
---|
331 | CONVERT2 program.</li> |
---|
332 | <li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li> |
---|
333 | <li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li> |
---|
334 | <li><strong>fp_root</strong> (<em>str</em>) – Path to the root directory of FLEXPART environment or flex_extract |
---|
335 | environment.</li> |
---|
336 | </ul> |
---|
337 | </td> |
---|
338 | </tr> |
---|
339 | </tbody> |
---|
340 | </table> |
---|
341 | </dd></dl> |
---|
342 | |
---|
343 | <dl class="function"> |
---|
344 | <dt id="install.mk_convert_build"> |
---|
345 | <code class="descclassname">install.</code><code class="descname">mk_convert_build</code><span class="sig-paren">(</span><em>src_path</em>, <em>makefile</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#mk_convert_build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_convert_build" title="Permalink to this definition">¶</a></dt> |
---|
346 | <dd><p>Compiles the Fortran code and generates the executable.</p> |
---|
347 | <table class="docutils field-list" frame="void" rules="none"> |
---|
348 | <col class="field-name" /> |
---|
349 | <col class="field-body" /> |
---|
350 | <tbody valign="top"> |
---|
351 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
352 | <li><strong>src_path</strong> (<em>str</em>) – Path to the fortran source directory.</li> |
---|
353 | <li><strong>makefile</strong> (<em>str</em>) – The name of the makefile which should be used.</li> |
---|
354 | </ul> |
---|
355 | </td> |
---|
356 | </tr> |
---|
357 | </tbody> |
---|
358 | </table> |
---|
359 | </dd></dl> |
---|
360 | |
---|
361 | <dl class="function"> |
---|
362 | <dt id="install.mk_env_vars"> |
---|
363 | <code class="descclassname">install.</code><code class="descname">mk_env_vars</code><span class="sig-paren">(</span><em>ecuid</em>, <em>ecgid</em>, <em>gateway</em>, <em>destination</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#mk_env_vars"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_env_vars" title="Permalink to this definition">¶</a></dt> |
---|
364 | <dd><p>Creates a file named ECMWF_ENV which contains the |
---|
365 | necessary environmental variables at ECMWF servers. |
---|
366 | It is based on the template ECMWF_ENV.template.</p> |
---|
367 | <table class="docutils field-list" frame="void" rules="none"> |
---|
368 | <col class="field-name" /> |
---|
369 | <col class="field-body" /> |
---|
370 | <tbody valign="top"> |
---|
371 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
372 | <li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li> |
---|
373 | <li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li> |
---|
374 | <li><strong>gateway</strong> (<em>str</em>) – The gateway server the user is using.</li> |
---|
375 | <li><strong>destination</strong> (<em>str</em>) – The remote destination which is used to transfer files |
---|
376 | from ECMWF server to local gateway server.</li> |
---|
377 | </ul> |
---|
378 | </td> |
---|
379 | </tr> |
---|
380 | </tbody> |
---|
381 | </table> |
---|
382 | </dd></dl> |
---|
383 | |
---|
384 | <dl class="function"> |
---|
385 | <dt id="install.mk_job_template"> |
---|
386 | <code class="descclassname">install.</code><code class="descname">mk_job_template</code><span class="sig-paren">(</span><em>ecuid</em>, <em>ecgid</em>, <em>fp_root</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#mk_job_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_job_template" title="Permalink to this definition">¶</a></dt> |
---|
387 | <dd><p>Modifies the original job template file so that it is specified |
---|
388 | for the user and the environment were it will be applied. Result |
---|
389 | is stored in a new file.</p> |
---|
390 | <table class="docutils field-list" frame="void" rules="none"> |
---|
391 | <col class="field-name" /> |
---|
392 | <col class="field-body" /> |
---|
393 | <tbody valign="top"> |
---|
394 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
395 | <li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li> |
---|
396 | <li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li> |
---|
397 | <li><strong>fp_root</strong> (<em>str</em>) – Path to the root directory of FLEXPART environment or flex_extract |
---|
398 | environment.</li> |
---|
399 | </ul> |
---|
400 | </td> |
---|
401 | </tr> |
---|
402 | </tbody> |
---|
403 | </table> |
---|
404 | </dd></dl> |
---|
405 | |
---|
406 | <dl class="function"> |
---|
407 | <dt id="install.mk_tarball"> |
---|
408 | <code class="descclassname">install.</code><code class="descname">mk_tarball</code><span class="sig-paren">(</span><em>tarball_path</em>, <em>target</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#mk_tarball"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.mk_tarball" title="Permalink to this definition">¶</a></dt> |
---|
409 | <dd><p>Creates a tarball with all necessary files which need to be sent to the |
---|
410 | installation directory. |
---|
411 | It does not matter if this is local or remote. |
---|
412 | Collects all python files, the Fortran source and makefiles, |
---|
413 | the ECMWF_ENV file, the CONTROL files as well as the |
---|
414 | template files.</p> |
---|
415 | <table class="docutils field-list" frame="void" rules="none"> |
---|
416 | <col class="field-name" /> |
---|
417 | <col class="field-body" /> |
---|
418 | <tbody valign="top"> |
---|
419 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
420 | <li><strong>tarball_path</strong> (<em>str</em>) – The complete path to the tar file which will contain all |
---|
421 | relevant data for flex_extract.</li> |
---|
422 | <li><strong>target</strong> (<em>str</em>) – The queue where the job is submitted to.</li> |
---|
423 | </ul> |
---|
424 | </td> |
---|
425 | </tr> |
---|
426 | </tbody> |
---|
427 | </table> |
---|
428 | </dd></dl> |
---|
429 | |
---|
430 | <dl class="function"> |
---|
431 | <dt id="install.un_tarball"> |
---|
432 | <code class="descclassname">install.</code><code class="descname">un_tarball</code><span class="sig-paren">(</span><em>tarball_path</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/install.html#un_tarball"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#install.un_tarball" title="Permalink to this definition">¶</a></dt> |
---|
433 | <dd><p>Extracts the given tarball into current directory.</p> |
---|
434 | <table class="docutils field-list" frame="void" rules="none"> |
---|
435 | <col class="field-name" /> |
---|
436 | <col class="field-body" /> |
---|
437 | <tbody valign="top"> |
---|
438 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tarball_path</strong> (<em>str</em>) – The complete path to the tar file which will contain all |
---|
439 | relevant data for flex_extract.</td> |
---|
440 | </tr> |
---|
441 | </tbody> |
---|
442 | </table> |
---|
443 | </dd></dl> |
---|
444 | |
---|
445 | </div> |
---|
446 | <div class="section" id="module-submit"> |
---|
447 | <span id="submit"></span><h3><a class="toc-backref" href="#id5">submit</a><a class="headerlink" href="#module-submit" title="Permalink to this headline">¶</a></h3> |
---|
448 | <p>This script allows the user to extract meteorological fields from the ECMWF.</p> |
---|
449 | <p>It prepares the settings for retrieving the data from ECMWF servers and |
---|
450 | process the resulting files to prepare them for the use with FLEXPART or |
---|
451 | FLEXTRA.</p> |
---|
452 | <p>If it is supposed to work locally then it works through the necessary |
---|
453 | functions get_mars_data and prepare_flexpart. Otherwise it prepares |
---|
454 | a job script (korn shell) which will do the necessary work on the |
---|
455 | ECMWF server. This script will de submitted via the ecaccess command |
---|
456 | ecaccess-job-submit.</p> |
---|
457 | <p>This file can also be imported as a module which then contains the following |
---|
458 | functions:</p> |
---|
459 | <blockquote> |
---|
460 | <div><ul class="simple"> |
---|
461 | <li>main - the main function of the script</li> |
---|
462 | <li>submit - calls mk_jobscript depending on operation mode and submits its</li> |
---|
463 | <li>mk_jobscript - creates the job script from a template</li> |
---|
464 | </ul> |
---|
465 | </div></blockquote> |
---|
466 | <p>Type: submit.py –help |
---|
467 | to get information about command line parameters. |
---|
468 | Read the documentation for usage instructions.</p> |
---|
469 | <dl class="function"> |
---|
470 | <dt id="submit.main"> |
---|
471 | <code class="descclassname">submit.</code><code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/submit.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#submit.main" title="Permalink to this definition">¶</a></dt> |
---|
472 | <dd><p>Get the arguments from script call and from CONTROL file. |
---|
473 | Decides from the argument “queue” if the local version |
---|
474 | is done “queue=None” or the gateway version with “queue=ecgate” |
---|
475 | or “queue=cca”.</p> |
---|
476 | </dd></dl> |
---|
477 | |
---|
478 | <dl class="function"> |
---|
479 | <dt id="submit.mk_jobscript"> |
---|
480 | <code class="descclassname">submit.</code><code class="descname">mk_jobscript</code><span class="sig-paren">(</span><em>jtemplate</em>, <em>job_file</em>, <em>clist</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/submit.html#mk_jobscript"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#submit.mk_jobscript" title="Permalink to this definition">¶</a></dt> |
---|
481 | <dd><p>Creates the job script from template.</p> |
---|
482 | <table class="docutils field-list" frame="void" rules="none"> |
---|
483 | <col class="field-name" /> |
---|
484 | <col class="field-body" /> |
---|
485 | <tbody valign="top"> |
---|
486 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
487 | <li><strong>jtemplate</strong> (<em>str</em>) – Job template file from sub-directory “_templates” for |
---|
488 | submission to ECMWF. It contains all necessary |
---|
489 | module and variable settings for the ECMWF environment as well as |
---|
490 | the job call and mail report instructions. |
---|
491 | Default is “job.temp”.</li> |
---|
492 | <li><strong>job_file</strong> (<em>str</em>) – Path to the job script file.</li> |
---|
493 | <li><strong>clist</strong> (<em>list of str</em>) – Contains all necessary parameters for ECMWF CONTROL file.</li> |
---|
494 | </ul> |
---|
495 | </td> |
---|
496 | </tr> |
---|
497 | </tbody> |
---|
498 | </table> |
---|
499 | </dd></dl> |
---|
500 | |
---|
501 | <dl class="function"> |
---|
502 | <dt id="submit.submit"> |
---|
503 | <code class="descclassname">submit.</code><code class="descname">submit</code><span class="sig-paren">(</span><em>jtemplate</em>, <em>c</em>, <em>queue</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/submit.html#submit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#submit.submit" title="Permalink to this definition">¶</a></dt> |
---|
504 | <dd><p>Prepares the job script and submits it to the specified queue.</p> |
---|
505 | <table class="docutils field-list" frame="void" rules="none"> |
---|
506 | <col class="field-name" /> |
---|
507 | <col class="field-body" /> |
---|
508 | <tbody valign="top"> |
---|
509 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
510 | <li><strong>jtemplate</strong> (<em>str</em>) – Job template file from sub-directory “_templates” for |
---|
511 | submission to ECMWF. It contains all necessary |
---|
512 | module and variable settings for the ECMWF environment as well as |
---|
513 | the job call and mail report instructions. |
---|
514 | Default is “job.temp”.</li> |
---|
515 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
516 | command line.</li> |
---|
517 | <li><strong>queue</strong> (<em>str</em>) – Name of queue for submission to ECMWF (e.g. ecgate or cca )</li> |
---|
518 | </ul> |
---|
519 | </td> |
---|
520 | </tr> |
---|
521 | </tbody> |
---|
522 | </table> |
---|
523 | </dd></dl> |
---|
524 | |
---|
525 | </div> |
---|
526 | </div> |
---|
527 | <div class="section" id="classes"> |
---|
528 | <h2><a class="toc-backref" href="#id6">Classes</a><a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2> |
---|
529 | <div class="section" id="module-ControlFile"> |
---|
530 | <span id="controlfile"></span><h3><a class="toc-backref" href="#id7">ControlFile</a><a class="headerlink" href="#module-ControlFile" title="Permalink to this headline">¶</a></h3> |
---|
531 | <dl class="class"> |
---|
532 | <dt id="ControlFile.ControlFile"> |
---|
533 | <em class="property">class </em><code class="descclassname">ControlFile.</code><code class="descname">ControlFile</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/ControlFile.html#ControlFile"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile" title="Permalink to this definition">¶</a></dt> |
---|
534 | <dd><p>Contains the information which are stored in the CONTROL files.</p> |
---|
535 | <p>The CONTROL file is the steering part of the FLEXPART extraction |
---|
536 | software. All necessary parameters needed to retrieve the data fields |
---|
537 | from the MARS archive for driving FLEXPART are set in a CONTROL file. |
---|
538 | Some specific parameters like the start and end dates can be overwritten |
---|
539 | by the command line parameters, but in generall all parameters needed |
---|
540 | for a complete set of fields for FLEXPART can be set in the CONTROL file.</p> |
---|
541 | <dl class="attribute"> |
---|
542 | <dt id="ControlFile.ControlFile.controlfile"> |
---|
543 | <code class="descname">controlfile</code><a class="headerlink" href="#ControlFile.ControlFile.controlfile" title="Permalink to this definition">¶</a></dt> |
---|
544 | <dd><p>The name of the control file to be processed. Default value is the |
---|
545 | filename passed to the init function when initialised.</p> |
---|
546 | <table class="docutils field-list" frame="void" rules="none"> |
---|
547 | <col class="field-name" /> |
---|
548 | <col class="field-body" /> |
---|
549 | <tbody valign="top"> |
---|
550 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
551 | </tr> |
---|
552 | </tbody> |
---|
553 | </table> |
---|
554 | </dd></dl> |
---|
555 | |
---|
556 | <dl class="attribute"> |
---|
557 | <dt id="ControlFile.ControlFile.start_date"> |
---|
558 | <code class="descname">start_date</code><a class="headerlink" href="#ControlFile.ControlFile.start_date" title="Permalink to this definition">¶</a></dt> |
---|
559 | <dd><p>The first day of the retrieval period. Default value is None.</p> |
---|
560 | <table class="docutils field-list" frame="void" rules="none"> |
---|
561 | <col class="field-name" /> |
---|
562 | <col class="field-body" /> |
---|
563 | <tbody valign="top"> |
---|
564 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
565 | </tr> |
---|
566 | </tbody> |
---|
567 | </table> |
---|
568 | </dd></dl> |
---|
569 | |
---|
570 | <dl class="attribute"> |
---|
571 | <dt id="ControlFile.ControlFile.end_date"> |
---|
572 | <code class="descname">end_date</code><a class="headerlink" href="#ControlFile.ControlFile.end_date" title="Permalink to this definition">¶</a></dt> |
---|
573 | <dd><p>The last day of the retrieval period. Default value is None.</p> |
---|
574 | <table class="docutils field-list" frame="void" rules="none"> |
---|
575 | <col class="field-name" /> |
---|
576 | <col class="field-body" /> |
---|
577 | <tbody valign="top"> |
---|
578 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
579 | </tr> |
---|
580 | </tbody> |
---|
581 | </table> |
---|
582 | </dd></dl> |
---|
583 | |
---|
584 | <dl class="attribute"> |
---|
585 | <dt id="ControlFile.ControlFile.date_chunk"> |
---|
586 | <code class="descname">date_chunk</code><a class="headerlink" href="#ControlFile.ControlFile.date_chunk" title="Permalink to this definition">¶</a></dt> |
---|
587 | <dd><p>Length of period for a single mars retrieval. Default value is 3.</p> |
---|
588 | <table class="docutils field-list" frame="void" rules="none"> |
---|
589 | <col class="field-name" /> |
---|
590 | <col class="field-body" /> |
---|
591 | <tbody valign="top"> |
---|
592 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
593 | </tr> |
---|
594 | </tbody> |
---|
595 | </table> |
---|
596 | </dd></dl> |
---|
597 | |
---|
598 | <dl class="attribute"> |
---|
599 | <dt id="ControlFile.ControlFile.dtime"> |
---|
600 | <code class="descname">dtime</code><a class="headerlink" href="#ControlFile.ControlFile.dtime" title="Permalink to this definition">¶</a></dt> |
---|
601 | <dd><p>The time step in hours. Default value is None.</p> |
---|
602 | <table class="docutils field-list" frame="void" rules="none"> |
---|
603 | <col class="field-name" /> |
---|
604 | <col class="field-body" /> |
---|
605 | <tbody valign="top"> |
---|
606 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
607 | </tr> |
---|
608 | </tbody> |
---|
609 | </table> |
---|
610 | </dd></dl> |
---|
611 | |
---|
612 | <dl class="attribute"> |
---|
613 | <dt id="ControlFile.ControlFile.basetime"> |
---|
614 | <code class="descname">basetime</code><a class="headerlink" href="#ControlFile.ControlFile.basetime" title="Permalink to this definition">¶</a></dt> |
---|
615 | <dd><p>The time for a half day retrieval. The 12 hours upfront are to be |
---|
616 | retrieved. Default value is None.</p> |
---|
617 | <table class="docutils field-list" frame="void" rules="none"> |
---|
618 | <col class="field-name" /> |
---|
619 | <col class="field-body" /> |
---|
620 | <tbody valign="top"> |
---|
621 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
622 | </tr> |
---|
623 | </tbody> |
---|
624 | </table> |
---|
625 | </dd></dl> |
---|
626 | |
---|
627 | <dl class="attribute"> |
---|
628 | <dt id="ControlFile.ControlFile.maxstep"> |
---|
629 | <code class="descname">maxstep</code><a class="headerlink" href="#ControlFile.ControlFile.maxstep" title="Permalink to this definition">¶</a></dt> |
---|
630 | <dd><p>The maximum forecast step for non flux data. Default value is None.</p> |
---|
631 | <table class="docutils field-list" frame="void" rules="none"> |
---|
632 | <col class="field-name" /> |
---|
633 | <col class="field-body" /> |
---|
634 | <tbody valign="top"> |
---|
635 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
636 | </tr> |
---|
637 | </tbody> |
---|
638 | </table> |
---|
639 | </dd></dl> |
---|
640 | |
---|
641 | <dl class="attribute"> |
---|
642 | <dt id="ControlFile.ControlFile.type"> |
---|
643 | <code class="descname">type</code><a class="headerlink" href="#ControlFile.ControlFile.type" title="Permalink to this definition">¶</a></dt> |
---|
644 | <dd><p>List of field type per retrieving hour. Default value is None.</p> |
---|
645 | <table class="docutils field-list" frame="void" rules="none"> |
---|
646 | <col class="field-name" /> |
---|
647 | <col class="field-body" /> |
---|
648 | <tbody valign="top"> |
---|
649 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
650 | </tr> |
---|
651 | </tbody> |
---|
652 | </table> |
---|
653 | </dd></dl> |
---|
654 | |
---|
655 | <dl class="attribute"> |
---|
656 | <dt id="ControlFile.ControlFile.time"> |
---|
657 | <code class="descname">time</code><a class="headerlink" href="#ControlFile.ControlFile.time" title="Permalink to this definition">¶</a></dt> |
---|
658 | <dd><p>List of retrieving times in hours. Default valuer is None.</p> |
---|
659 | <table class="docutils field-list" frame="void" rules="none"> |
---|
660 | <col class="field-name" /> |
---|
661 | <col class="field-body" /> |
---|
662 | <tbody valign="top"> |
---|
663 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
664 | </tr> |
---|
665 | </tbody> |
---|
666 | </table> |
---|
667 | </dd></dl> |
---|
668 | |
---|
669 | <dl class="attribute"> |
---|
670 | <dt id="ControlFile.ControlFile.step"> |
---|
671 | <code class="descname">step</code><a class="headerlink" href="#ControlFile.ControlFile.step" title="Permalink to this definition">¶</a></dt> |
---|
672 | <dd><p>List of forecast time steps in hours for non flux data. |
---|
673 | Default value is None.</p> |
---|
674 | <table class="docutils field-list" frame="void" rules="none"> |
---|
675 | <col class="field-name" /> |
---|
676 | <col class="field-body" /> |
---|
677 | <tbody valign="top"> |
---|
678 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str or str</td> |
---|
679 | </tr> |
---|
680 | </tbody> |
---|
681 | </table> |
---|
682 | </dd></dl> |
---|
683 | |
---|
684 | <dl class="attribute"> |
---|
685 | <dt id="ControlFile.ControlFile.acctype"> |
---|
686 | <code class="descname">acctype</code><a class="headerlink" href="#ControlFile.ControlFile.acctype" title="Permalink to this definition">¶</a></dt> |
---|
687 | <dd><p>The field type for the accumulated forecast fields. |
---|
688 | Default value is None.</p> |
---|
689 | <table class="docutils field-list" frame="void" rules="none"> |
---|
690 | <col class="field-name" /> |
---|
691 | <col class="field-body" /> |
---|
692 | <tbody valign="top"> |
---|
693 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
694 | </tr> |
---|
695 | </tbody> |
---|
696 | </table> |
---|
697 | </dd></dl> |
---|
698 | |
---|
699 | <dl class="attribute"> |
---|
700 | <dt id="ControlFile.ControlFile.acctime"> |
---|
701 | <code class="descname">acctime</code><a class="headerlink" href="#ControlFile.ControlFile.acctime" title="Permalink to this definition">¶</a></dt> |
---|
702 | <dd><p>The starting time of the accumulated forecasts. Default value is None.</p> |
---|
703 | <table class="docutils field-list" frame="void" rules="none"> |
---|
704 | <col class="field-name" /> |
---|
705 | <col class="field-body" /> |
---|
706 | <tbody valign="top"> |
---|
707 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
708 | </tr> |
---|
709 | </tbody> |
---|
710 | </table> |
---|
711 | </dd></dl> |
---|
712 | |
---|
713 | <dl class="attribute"> |
---|
714 | <dt id="ControlFile.ControlFile.accmaxstep"> |
---|
715 | <code class="descname">accmaxstep</code><a class="headerlink" href="#ControlFile.ControlFile.accmaxstep" title="Permalink to this definition">¶</a></dt> |
---|
716 | <dd><p>The maximum forecast step for the accumulated forecast fields |
---|
717 | (flux data). Default value is None.</p> |
---|
718 | <table class="docutils field-list" frame="void" rules="none"> |
---|
719 | <col class="field-name" /> |
---|
720 | <col class="field-body" /> |
---|
721 | <tbody valign="top"> |
---|
722 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
723 | </tr> |
---|
724 | </tbody> |
---|
725 | </table> |
---|
726 | </dd></dl> |
---|
727 | |
---|
728 | <dl class="attribute"> |
---|
729 | <dt id="ControlFile.ControlFile.marsclass"> |
---|
730 | <code class="descname">marsclass</code><a class="headerlink" href="#ControlFile.ControlFile.marsclass" title="Permalink to this definition">¶</a></dt> |
---|
731 | <dd><p>Characterisation of dataset. Default value is None.</p> |
---|
732 | <table class="docutils field-list" frame="void" rules="none"> |
---|
733 | <col class="field-name" /> |
---|
734 | <col class="field-body" /> |
---|
735 | <tbody valign="top"> |
---|
736 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
737 | </tr> |
---|
738 | </tbody> |
---|
739 | </table> |
---|
740 | </dd></dl> |
---|
741 | |
---|
742 | <dl class="attribute"> |
---|
743 | <dt id="ControlFile.ControlFile.dataset"> |
---|
744 | <code class="descname">dataset</code><a class="headerlink" href="#ControlFile.ControlFile.dataset" title="Permalink to this definition">¶</a></dt> |
---|
745 | <dd><p>For public datasets there is the specific naming and parameter |
---|
746 | dataset which has to be used to characterize the type of |
---|
747 | data. Default value is None.</p> |
---|
748 | <table class="docutils field-list" frame="void" rules="none"> |
---|
749 | <col class="field-name" /> |
---|
750 | <col class="field-body" /> |
---|
751 | <tbody valign="top"> |
---|
752 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
753 | </tr> |
---|
754 | </tbody> |
---|
755 | </table> |
---|
756 | </dd></dl> |
---|
757 | |
---|
758 | <dl class="attribute"> |
---|
759 | <dt id="ControlFile.ControlFile.stream"> |
---|
760 | <code class="descname">stream</code><a class="headerlink" href="#ControlFile.ControlFile.stream" title="Permalink to this definition">¶</a></dt> |
---|
761 | <dd><p>Identifies the forecasting system used to generate the data. |
---|
762 | Default value is None.</p> |
---|
763 | <table class="docutils field-list" frame="void" rules="none"> |
---|
764 | <col class="field-name" /> |
---|
765 | <col class="field-body" /> |
---|
766 | <tbody valign="top"> |
---|
767 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
768 | </tr> |
---|
769 | </tbody> |
---|
770 | </table> |
---|
771 | </dd></dl> |
---|
772 | |
---|
773 | <dl class="attribute"> |
---|
774 | <dt id="ControlFile.ControlFile.number"> |
---|
775 | <code class="descname">number</code><a class="headerlink" href="#ControlFile.ControlFile.number" title="Permalink to this definition">¶</a></dt> |
---|
776 | <dd><p>Selects the member in ensemble forecast run. Default value is ‘OFF’.</p> |
---|
777 | <table class="docutils field-list" frame="void" rules="none"> |
---|
778 | <col class="field-name" /> |
---|
779 | <col class="field-body" /> |
---|
780 | <tbody valign="top"> |
---|
781 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
782 | </tr> |
---|
783 | </tbody> |
---|
784 | </table> |
---|
785 | </dd></dl> |
---|
786 | |
---|
787 | <dl class="attribute"> |
---|
788 | <dt id="ControlFile.ControlFile.expver"> |
---|
789 | <code class="descname">expver</code><a class="headerlink" href="#ControlFile.ControlFile.expver" title="Permalink to this definition">¶</a></dt> |
---|
790 | <dd><p>The version number of the dataset. Default value is ‘1’.</p> |
---|
791 | <table class="docutils field-list" frame="void" rules="none"> |
---|
792 | <col class="field-name" /> |
---|
793 | <col class="field-body" /> |
---|
794 | <tbody valign="top"> |
---|
795 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
796 | </tr> |
---|
797 | </tbody> |
---|
798 | </table> |
---|
799 | </dd></dl> |
---|
800 | |
---|
801 | <dl class="attribute"> |
---|
802 | <dt id="ControlFile.ControlFile.gaussian"> |
---|
803 | <code class="descname">gaussian</code><a class="headerlink" href="#ControlFile.ControlFile.gaussian" title="Permalink to this definition">¶</a></dt> |
---|
804 | <dd><p>This parameter is deprecated and should no longer be used. |
---|
805 | Specifies the desired type of Gaussian grid for the output. |
---|
806 | Default value is an empty string ‘’.</p> |
---|
807 | <table class="docutils field-list" frame="void" rules="none"> |
---|
808 | <col class="field-name" /> |
---|
809 | <col class="field-body" /> |
---|
810 | <tbody valign="top"> |
---|
811 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
812 | </tr> |
---|
813 | </tbody> |
---|
814 | </table> |
---|
815 | </dd></dl> |
---|
816 | |
---|
817 | <dl class="attribute"> |
---|
818 | <dt id="ControlFile.ControlFile.grid"> |
---|
819 | <code class="descname">grid</code><a class="headerlink" href="#ControlFile.ControlFile.grid" title="Permalink to this definition">¶</a></dt> |
---|
820 | <dd><p>Specifies the output grid which can be either a Gaussian grid |
---|
821 | or a Latitude/Longitude grid. Default value is None.</p> |
---|
822 | <table class="docutils field-list" frame="void" rules="none"> |
---|
823 | <col class="field-name" /> |
---|
824 | <col class="field-body" /> |
---|
825 | <tbody valign="top"> |
---|
826 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
827 | </tr> |
---|
828 | </tbody> |
---|
829 | </table> |
---|
830 | </dd></dl> |
---|
831 | |
---|
832 | <dl class="attribute"> |
---|
833 | <dt id="ControlFile.ControlFile.area"> |
---|
834 | <code class="descname">area</code><a class="headerlink" href="#ControlFile.ControlFile.area" title="Permalink to this definition">¶</a></dt> |
---|
835 | <dd><p>Specifies the desired sub-area of data to be extracted. |
---|
836 | Default value is None.</p> |
---|
837 | <table class="docutils field-list" frame="void" rules="none"> |
---|
838 | <col class="field-name" /> |
---|
839 | <col class="field-body" /> |
---|
840 | <tbody valign="top"> |
---|
841 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
842 | </tr> |
---|
843 | </tbody> |
---|
844 | </table> |
---|
845 | </dd></dl> |
---|
846 | |
---|
847 | <dl class="attribute"> |
---|
848 | <dt id="ControlFile.ControlFile.left"> |
---|
849 | <code class="descname">left</code><a class="headerlink" href="#ControlFile.ControlFile.left" title="Permalink to this definition">¶</a></dt> |
---|
850 | <dd><p>The western most longitude of the area to be extracted. |
---|
851 | Default value is None.</p> |
---|
852 | <table class="docutils field-list" frame="void" rules="none"> |
---|
853 | <col class="field-name" /> |
---|
854 | <col class="field-body" /> |
---|
855 | <tbody valign="top"> |
---|
856 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
857 | </tr> |
---|
858 | </tbody> |
---|
859 | </table> |
---|
860 | </dd></dl> |
---|
861 | |
---|
862 | <dl class="attribute"> |
---|
863 | <dt id="ControlFile.ControlFile.lower"> |
---|
864 | <code class="descname">lower</code><a class="headerlink" href="#ControlFile.ControlFile.lower" title="Permalink to this definition">¶</a></dt> |
---|
865 | <dd><p>The southern most latitude of the area to be extracted. |
---|
866 | Default value is None.</p> |
---|
867 | <table class="docutils field-list" frame="void" rules="none"> |
---|
868 | <col class="field-name" /> |
---|
869 | <col class="field-body" /> |
---|
870 | <tbody valign="top"> |
---|
871 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
872 | </tr> |
---|
873 | </tbody> |
---|
874 | </table> |
---|
875 | </dd></dl> |
---|
876 | |
---|
877 | <dl class="attribute"> |
---|
878 | <dt id="ControlFile.ControlFile.upper"> |
---|
879 | <code class="descname">upper</code><a class="headerlink" href="#ControlFile.ControlFile.upper" title="Permalink to this definition">¶</a></dt> |
---|
880 | <dd><p>The northern most latitued of the area to be extracted. |
---|
881 | Default value is None.</p> |
---|
882 | <table class="docutils field-list" frame="void" rules="none"> |
---|
883 | <col class="field-name" /> |
---|
884 | <col class="field-body" /> |
---|
885 | <tbody valign="top"> |
---|
886 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
887 | </tr> |
---|
888 | </tbody> |
---|
889 | </table> |
---|
890 | </dd></dl> |
---|
891 | |
---|
892 | <dl class="attribute"> |
---|
893 | <dt id="ControlFile.ControlFile.right"> |
---|
894 | <code class="descname">right</code><a class="headerlink" href="#ControlFile.ControlFile.right" title="Permalink to this definition">¶</a></dt> |
---|
895 | <dd><p>The eastern most longitude of the area to be extracted. |
---|
896 | Default value is None.</p> |
---|
897 | <table class="docutils field-list" frame="void" rules="none"> |
---|
898 | <col class="field-name" /> |
---|
899 | <col class="field-body" /> |
---|
900 | <tbody valign="top"> |
---|
901 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
902 | </tr> |
---|
903 | </tbody> |
---|
904 | </table> |
---|
905 | </dd></dl> |
---|
906 | |
---|
907 | <dl class="attribute"> |
---|
908 | <dt id="ControlFile.ControlFile.level"> |
---|
909 | <code class="descname">level</code><a class="headerlink" href="#ControlFile.ControlFile.level" title="Permalink to this definition">¶</a></dt> |
---|
910 | <dd><p>Specifies the maximum level. Default value is None.</p> |
---|
911 | <table class="docutils field-list" frame="void" rules="none"> |
---|
912 | <col class="field-name" /> |
---|
913 | <col class="field-body" /> |
---|
914 | <tbody valign="top"> |
---|
915 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
916 | </tr> |
---|
917 | </tbody> |
---|
918 | </table> |
---|
919 | </dd></dl> |
---|
920 | |
---|
921 | <dl class="attribute"> |
---|
922 | <dt id="ControlFile.ControlFile.levelist"> |
---|
923 | <code class="descname">levelist</code><a class="headerlink" href="#ControlFile.ControlFile.levelist" title="Permalink to this definition">¶</a></dt> |
---|
924 | <dd><p>Specifies the required level list. Default value is None.</p> |
---|
925 | <table class="docutils field-list" frame="void" rules="none"> |
---|
926 | <col class="field-name" /> |
---|
927 | <col class="field-body" /> |
---|
928 | <tbody valign="top"> |
---|
929 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
930 | </tr> |
---|
931 | </tbody> |
---|
932 | </table> |
---|
933 | </dd></dl> |
---|
934 | |
---|
935 | <dl class="attribute"> |
---|
936 | <dt id="ControlFile.ControlFile.resol"> |
---|
937 | <code class="descname">resol</code><a class="headerlink" href="#ControlFile.ControlFile.resol" title="Permalink to this definition">¶</a></dt> |
---|
938 | <dd><p>Specifies the desired triangular truncation of retrieved data, |
---|
939 | before carrying out any other selected post-processing. |
---|
940 | Default value is None.</p> |
---|
941 | <table class="docutils field-list" frame="void" rules="none"> |
---|
942 | <col class="field-name" /> |
---|
943 | <col class="field-body" /> |
---|
944 | <tbody valign="top"> |
---|
945 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
946 | </tr> |
---|
947 | </tbody> |
---|
948 | </table> |
---|
949 | </dd></dl> |
---|
950 | |
---|
951 | <dl class="attribute"> |
---|
952 | <dt id="ControlFile.ControlFile.gauss"> |
---|
953 | <code class="descname">gauss</code><a class="headerlink" href="#ControlFile.ControlFile.gauss" title="Permalink to this definition">¶</a></dt> |
---|
954 | <dd><p>Switch to select gaussian fields (1) or regular lat/lon (0). |
---|
955 | Default value is 0.</p> |
---|
956 | <table class="docutils field-list" frame="void" rules="none"> |
---|
957 | <col class="field-name" /> |
---|
958 | <col class="field-body" /> |
---|
959 | <tbody valign="top"> |
---|
960 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
961 | </tr> |
---|
962 | </tbody> |
---|
963 | </table> |
---|
964 | </dd></dl> |
---|
965 | |
---|
966 | <dl class="attribute"> |
---|
967 | <dt id="ControlFile.ControlFile.accuracy"> |
---|
968 | <code class="descname">accuracy</code><a class="headerlink" href="#ControlFile.ControlFile.accuracy" title="Permalink to this definition">¶</a></dt> |
---|
969 | <dd><p>Specifies the number of bits per value to be used in the |
---|
970 | generated GRIB coded fields. Default value is 24.</p> |
---|
971 | <table class="docutils field-list" frame="void" rules="none"> |
---|
972 | <col class="field-name" /> |
---|
973 | <col class="field-body" /> |
---|
974 | <tbody valign="top"> |
---|
975 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
976 | </tr> |
---|
977 | </tbody> |
---|
978 | </table> |
---|
979 | </dd></dl> |
---|
980 | |
---|
981 | <dl class="attribute"> |
---|
982 | <dt id="ControlFile.ControlFile.omega"> |
---|
983 | <code class="descname">omega</code><a class="headerlink" href="#ControlFile.ControlFile.omega" title="Permalink to this definition">¶</a></dt> |
---|
984 | <dd><p>Switch to select omega retrieval (1) or not (0). Default value is 0.</p> |
---|
985 | <table class="docutils field-list" frame="void" rules="none"> |
---|
986 | <col class="field-name" /> |
---|
987 | <col class="field-body" /> |
---|
988 | <tbody valign="top"> |
---|
989 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
990 | </tr> |
---|
991 | </tbody> |
---|
992 | </table> |
---|
993 | </dd></dl> |
---|
994 | |
---|
995 | <dl class="attribute"> |
---|
996 | <dt id="ControlFile.ControlFile.omegadiff"> |
---|
997 | <code class="descname">omegadiff</code><a class="headerlink" href="#ControlFile.ControlFile.omegadiff" title="Permalink to this definition">¶</a></dt> |
---|
998 | <dd><p>Switch to decide to calculate Omega and Dps/Dt from continuity |
---|
999 | equation for diagnostic purposes (1) or not (0). Default value is 0.</p> |
---|
1000 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1001 | <col class="field-name" /> |
---|
1002 | <col class="field-body" /> |
---|
1003 | <tbody valign="top"> |
---|
1004 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1005 | </tr> |
---|
1006 | </tbody> |
---|
1007 | </table> |
---|
1008 | </dd></dl> |
---|
1009 | |
---|
1010 | <dl class="attribute"> |
---|
1011 | <dt id="ControlFile.ControlFile.eta"> |
---|
1012 | <code class="descname">eta</code><a class="headerlink" href="#ControlFile.ControlFile.eta" title="Permalink to this definition">¶</a></dt> |
---|
1013 | <dd><p>Switch to select direct retrieval of etadot from MARS (1) or |
---|
1014 | wether it has to be calculated (0). Then Default value is 0.</p> |
---|
1015 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1016 | <col class="field-name" /> |
---|
1017 | <col class="field-body" /> |
---|
1018 | <tbody valign="top"> |
---|
1019 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1020 | </tr> |
---|
1021 | </tbody> |
---|
1022 | </table> |
---|
1023 | </dd></dl> |
---|
1024 | |
---|
1025 | <dl class="attribute"> |
---|
1026 | <dt id="ControlFile.ControlFile.etadiff"> |
---|
1027 | <code class="descname">etadiff</code><a class="headerlink" href="#ControlFile.ControlFile.etadiff" title="Permalink to this definition">¶</a></dt> |
---|
1028 | <dd><p>Switch to select calculation of etadot and Dps/Dt from continuity |
---|
1029 | equation for diagnostic purposes (1) or not (0). Default value is 0.</p> |
---|
1030 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1031 | <col class="field-name" /> |
---|
1032 | <col class="field-body" /> |
---|
1033 | <tbody valign="top"> |
---|
1034 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1035 | </tr> |
---|
1036 | </tbody> |
---|
1037 | </table> |
---|
1038 | </dd></dl> |
---|
1039 | |
---|
1040 | <dl class="attribute"> |
---|
1041 | <dt id="ControlFile.ControlFile.etapar"> |
---|
1042 | <code class="descname">etapar</code><a class="headerlink" href="#ControlFile.ControlFile.etapar" title="Permalink to this definition">¶</a></dt> |
---|
1043 | <dd><p>GRIB parameter Id for etadot fields. Default value is 77.</p> |
---|
1044 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1045 | <col class="field-name" /> |
---|
1046 | <col class="field-body" /> |
---|
1047 | <tbody valign="top"> |
---|
1048 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1049 | </tr> |
---|
1050 | </tbody> |
---|
1051 | </table> |
---|
1052 | </dd></dl> |
---|
1053 | |
---|
1054 | <dl class="attribute"> |
---|
1055 | <dt id="ControlFile.ControlFile.dpdeta"> |
---|
1056 | <code class="descname">dpdeta</code><a class="headerlink" href="#ControlFile.ControlFile.dpdeta" title="Permalink to this definition">¶</a></dt> |
---|
1057 | <dd><p>Switch to select multiplication of etadot with dpdeta. |
---|
1058 | Default value is 1.</p> |
---|
1059 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1060 | <col class="field-name" /> |
---|
1061 | <col class="field-body" /> |
---|
1062 | <tbody valign="top"> |
---|
1063 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1064 | </tr> |
---|
1065 | </tbody> |
---|
1066 | </table> |
---|
1067 | </dd></dl> |
---|
1068 | |
---|
1069 | <dl class="attribute"> |
---|
1070 | <dt id="ControlFile.ControlFile.smooth"> |
---|
1071 | <code class="descname">smooth</code><a class="headerlink" href="#ControlFile.ControlFile.smooth" title="Permalink to this definition">¶</a></dt> |
---|
1072 | <dd><p>Spectral truncation of ETADOT after calculation on Gaussian grid. |
---|
1073 | Default value is 0.</p> |
---|
1074 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1075 | <col class="field-name" /> |
---|
1076 | <col class="field-body" /> |
---|
1077 | <tbody valign="top"> |
---|
1078 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1079 | </tr> |
---|
1080 | </tbody> |
---|
1081 | </table> |
---|
1082 | </dd></dl> |
---|
1083 | |
---|
1084 | <dl class="attribute"> |
---|
1085 | <dt id="ControlFile.ControlFile.format"> |
---|
1086 | <code class="descname">format</code><a class="headerlink" href="#ControlFile.ControlFile.format" title="Permalink to this definition">¶</a></dt> |
---|
1087 | <dd><p>The format of the GRIB data. Default value is ‘GRIB1’.</p> |
---|
1088 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1089 | <col class="field-name" /> |
---|
1090 | <col class="field-body" /> |
---|
1091 | <tbody valign="top"> |
---|
1092 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1093 | </tr> |
---|
1094 | </tbody> |
---|
1095 | </table> |
---|
1096 | </dd></dl> |
---|
1097 | |
---|
1098 | <dl class="attribute"> |
---|
1099 | <dt id="ControlFile.ControlFile.addpar"> |
---|
1100 | <code class="descname">addpar</code><a class="headerlink" href="#ControlFile.ControlFile.addpar" title="Permalink to this definition">¶</a></dt> |
---|
1101 | <dd><p>List of additional surface level ECMWF parameter to be retrieved. |
---|
1102 | Default value is None.</p> |
---|
1103 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1104 | <col class="field-name" /> |
---|
1105 | <col class="field-body" /> |
---|
1106 | <tbody valign="top"> |
---|
1107 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1108 | </tr> |
---|
1109 | </tbody> |
---|
1110 | </table> |
---|
1111 | </dd></dl> |
---|
1112 | |
---|
1113 | <dl class="attribute"> |
---|
1114 | <dt id="ControlFile.ControlFile.prefix"> |
---|
1115 | <code class="descname">prefix</code><a class="headerlink" href="#ControlFile.ControlFile.prefix" title="Permalink to this definition">¶</a></dt> |
---|
1116 | <dd><p>Prefix string for the final FLEXPART/FLEXTRA ready input files. |
---|
1117 | Default value is ‘EN’.</p> |
---|
1118 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1119 | <col class="field-name" /> |
---|
1120 | <col class="field-body" /> |
---|
1121 | <tbody valign="top"> |
---|
1122 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1123 | </tr> |
---|
1124 | </tbody> |
---|
1125 | </table> |
---|
1126 | </dd></dl> |
---|
1127 | |
---|
1128 | <dl class="attribute"> |
---|
1129 | <dt id="ControlFile.ControlFile.cwc"> |
---|
1130 | <code class="descname">cwc</code><a class="headerlink" href="#ControlFile.ControlFile.cwc" title="Permalink to this definition">¶</a></dt> |
---|
1131 | <dd><p>Switch to select wether the sum of cloud liquid water content and |
---|
1132 | cloud ice water content should be retrieved. Default value is 0.</p> |
---|
1133 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1134 | <col class="field-name" /> |
---|
1135 | <col class="field-body" /> |
---|
1136 | <tbody valign="top"> |
---|
1137 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1138 | </tr> |
---|
1139 | </tbody> |
---|
1140 | </table> |
---|
1141 | </dd></dl> |
---|
1142 | |
---|
1143 | <dl class="attribute"> |
---|
1144 | <dt id="ControlFile.ControlFile.wrf"> |
---|
1145 | <code class="descname">wrf</code><a class="headerlink" href="#ControlFile.ControlFile.wrf" title="Permalink to this definition">¶</a></dt> |
---|
1146 | <dd><p>Switch to select further parameters for retrievment to support |
---|
1147 | WRF simulations. Default value is 0.</p> |
---|
1148 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1149 | <col class="field-name" /> |
---|
1150 | <col class="field-body" /> |
---|
1151 | <tbody valign="top"> |
---|
1152 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1153 | </tr> |
---|
1154 | </tbody> |
---|
1155 | </table> |
---|
1156 | </dd></dl> |
---|
1157 | |
---|
1158 | <dl class="attribute"> |
---|
1159 | <dt id="ControlFile.ControlFile.ecfsdir"> |
---|
1160 | <code class="descname">ecfsdir</code><a class="headerlink" href="#ControlFile.ControlFile.ecfsdir" title="Permalink to this definition">¶</a></dt> |
---|
1161 | <dd><p>Path to the ECMWF storage ‘ectmp:/${USER}/econdemand/’</p> |
---|
1162 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1163 | <col class="field-name" /> |
---|
1164 | <col class="field-body" /> |
---|
1165 | <tbody valign="top"> |
---|
1166 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1167 | </tr> |
---|
1168 | </tbody> |
---|
1169 | </table> |
---|
1170 | </dd></dl> |
---|
1171 | |
---|
1172 | <dl class="attribute"> |
---|
1173 | <dt id="ControlFile.ControlFile.mailfail"> |
---|
1174 | <code class="descname">mailfail</code><a class="headerlink" href="#ControlFile.ControlFile.mailfail" title="Permalink to this definition">¶</a></dt> |
---|
1175 | <dd><p>Email list for sending error log files from ECMWF servers. |
---|
1176 | The email addresses should be seperated by a comma. |
---|
1177 | Default value is [‘${USER}’].</p> |
---|
1178 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1179 | <col class="field-name" /> |
---|
1180 | <col class="field-body" /> |
---|
1181 | <tbody valign="top"> |
---|
1182 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
1183 | </tr> |
---|
1184 | </tbody> |
---|
1185 | </table> |
---|
1186 | </dd></dl> |
---|
1187 | |
---|
1188 | <dl class="attribute"> |
---|
1189 | <dt id="ControlFile.ControlFile.mailops"> |
---|
1190 | <code class="descname">mailops</code><a class="headerlink" href="#ControlFile.ControlFile.mailops" title="Permalink to this definition">¶</a></dt> |
---|
1191 | <dd><p>Email list for sending operational log files from ECMWF servers. |
---|
1192 | The email addresses should be seperated by a comma. |
---|
1193 | Default value is [‘${USER}’].</p> |
---|
1194 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1195 | <col class="field-name" /> |
---|
1196 | <col class="field-body" /> |
---|
1197 | <tbody valign="top"> |
---|
1198 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
1199 | </tr> |
---|
1200 | </tbody> |
---|
1201 | </table> |
---|
1202 | </dd></dl> |
---|
1203 | |
---|
1204 | <dl class="attribute"> |
---|
1205 | <dt id="ControlFile.ControlFile.ecstorage"> |
---|
1206 | <code class="descname">ecstorage</code><a class="headerlink" href="#ControlFile.ControlFile.ecstorage" title="Permalink to this definition">¶</a></dt> |
---|
1207 | <dd><p>Switch to select storage of FLEXPART ready output files |
---|
1208 | in the ECFS file system. Default value is 0.</p> |
---|
1209 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1210 | <col class="field-name" /> |
---|
1211 | <col class="field-body" /> |
---|
1212 | <tbody valign="top"> |
---|
1213 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1214 | </tr> |
---|
1215 | </tbody> |
---|
1216 | </table> |
---|
1217 | </dd></dl> |
---|
1218 | |
---|
1219 | <dl class="attribute"> |
---|
1220 | <dt id="ControlFile.ControlFile.ectrans"> |
---|
1221 | <code class="descname">ectrans</code><a class="headerlink" href="#ControlFile.ControlFile.ectrans" title="Permalink to this definition">¶</a></dt> |
---|
1222 | <dd><p>Switch to select the transfer of FLEXPART ready output files |
---|
1223 | to the gateway server. Default value is 0.</p> |
---|
1224 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1225 | <col class="field-name" /> |
---|
1226 | <col class="field-body" /> |
---|
1227 | <tbody valign="top"> |
---|
1228 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1229 | </tr> |
---|
1230 | </tbody> |
---|
1231 | </table> |
---|
1232 | </dd></dl> |
---|
1233 | |
---|
1234 | <dl class="attribute"> |
---|
1235 | <dt id="ControlFile.ControlFile.inputdir"> |
---|
1236 | <code class="descname">inputdir</code><a class="headerlink" href="#ControlFile.ControlFile.inputdir" title="Permalink to this definition">¶</a></dt> |
---|
1237 | <dd><p>Path to the temporary directory for the retrieval grib files and |
---|
1238 | other processing files. Default value is _config.PATH_INPUT_DIR.</p> |
---|
1239 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1240 | <col class="field-name" /> |
---|
1241 | <col class="field-body" /> |
---|
1242 | <tbody valign="top"> |
---|
1243 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1244 | </tr> |
---|
1245 | </tbody> |
---|
1246 | </table> |
---|
1247 | </dd></dl> |
---|
1248 | |
---|
1249 | <dl class="attribute"> |
---|
1250 | <dt id="ControlFile.ControlFile.outputdir"> |
---|
1251 | <code class="descname">outputdir</code><a class="headerlink" href="#ControlFile.ControlFile.outputdir" title="Permalink to this definition">¶</a></dt> |
---|
1252 | <dd><p>Path to the final directory where the final FLEXPART ready input |
---|
1253 | files are stored. Default value is None.</p> |
---|
1254 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1255 | <col class="field-name" /> |
---|
1256 | <col class="field-body" /> |
---|
1257 | <tbody valign="top"> |
---|
1258 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1259 | </tr> |
---|
1260 | </tbody> |
---|
1261 | </table> |
---|
1262 | </dd></dl> |
---|
1263 | |
---|
1264 | <dl class="attribute"> |
---|
1265 | <dt id="ControlFile.ControlFile.flexextractdir"> |
---|
1266 | <code class="descname">flexextractdir</code><a class="headerlink" href="#ControlFile.ControlFile.flexextractdir" title="Permalink to this definition">¶</a></dt> |
---|
1267 | <dd><p>Path to the flex_extract root directory. Default value is |
---|
1268 | _config.PATH_FLEXEXTRACT_DIR.</p> |
---|
1269 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1270 | <col class="field-name" /> |
---|
1271 | <col class="field-body" /> |
---|
1272 | <tbody valign="top"> |
---|
1273 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1274 | </tr> |
---|
1275 | </tbody> |
---|
1276 | </table> |
---|
1277 | </dd></dl> |
---|
1278 | |
---|
1279 | <dl class="attribute"> |
---|
1280 | <dt id="ControlFile.ControlFile.exedir"> |
---|
1281 | <code class="descname">exedir</code><a class="headerlink" href="#ControlFile.ControlFile.exedir" title="Permalink to this definition">¶</a></dt> |
---|
1282 | <dd><p>Path to the FORTRAN executable file. Default value is |
---|
1283 | _config.PATH_FORTRAN_SRC.</p> |
---|
1284 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1285 | <col class="field-name" /> |
---|
1286 | <col class="field-body" /> |
---|
1287 | <tbody valign="top"> |
---|
1288 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1289 | </tr> |
---|
1290 | </tbody> |
---|
1291 | </table> |
---|
1292 | </dd></dl> |
---|
1293 | |
---|
1294 | <dl class="attribute"> |
---|
1295 | <dt id="ControlFile.ControlFile.installdir"> |
---|
1296 | <code class="descname">installdir</code><a class="headerlink" href="#ControlFile.ControlFile.installdir" title="Permalink to this definition">¶</a></dt> |
---|
1297 | <dd><p>Path to a FLEXPART root directory. Default value is None.</p> |
---|
1298 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1299 | <col class="field-name" /> |
---|
1300 | <col class="field-body" /> |
---|
1301 | <tbody valign="top"> |
---|
1302 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1303 | </tr> |
---|
1304 | </tbody> |
---|
1305 | </table> |
---|
1306 | </dd></dl> |
---|
1307 | |
---|
1308 | <dl class="attribute"> |
---|
1309 | <dt id="ControlFile.ControlFile.makefile"> |
---|
1310 | <code class="descname">makefile</code><a class="headerlink" href="#ControlFile.ControlFile.makefile" title="Permalink to this definition">¶</a></dt> |
---|
1311 | <dd><p>Name of the makefile to be used for the Fortran program. |
---|
1312 | Default value is ‘Makefile.gfortran’.</p> |
---|
1313 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1314 | <col class="field-name" /> |
---|
1315 | <col class="field-body" /> |
---|
1316 | <tbody valign="top"> |
---|
1317 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1318 | </tr> |
---|
1319 | </tbody> |
---|
1320 | </table> |
---|
1321 | </dd></dl> |
---|
1322 | |
---|
1323 | <dl class="attribute"> |
---|
1324 | <dt id="ControlFile.ControlFile.destination"> |
---|
1325 | <code class="descname">destination</code><a class="headerlink" href="#ControlFile.ControlFile.destination" title="Permalink to this definition">¶</a></dt> |
---|
1326 | <dd><p>The remote destination which is used to transfer files |
---|
1327 | from ECMWF server to local gateway server. Default value is None.</p> |
---|
1328 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1329 | <col class="field-name" /> |
---|
1330 | <col class="field-body" /> |
---|
1331 | <tbody valign="top"> |
---|
1332 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1333 | </tr> |
---|
1334 | </tbody> |
---|
1335 | </table> |
---|
1336 | </dd></dl> |
---|
1337 | |
---|
1338 | <dl class="attribute"> |
---|
1339 | <dt id="ControlFile.ControlFile.gateway"> |
---|
1340 | <code class="descname">gateway</code><a class="headerlink" href="#ControlFile.ControlFile.gateway" title="Permalink to this definition">¶</a></dt> |
---|
1341 | <dd><p>The gateway server the user is using. Default value is None.</p> |
---|
1342 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1343 | <col class="field-name" /> |
---|
1344 | <col class="field-body" /> |
---|
1345 | <tbody valign="top"> |
---|
1346 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1347 | </tr> |
---|
1348 | </tbody> |
---|
1349 | </table> |
---|
1350 | </dd></dl> |
---|
1351 | |
---|
1352 | <dl class="attribute"> |
---|
1353 | <dt id="ControlFile.ControlFile.ecuid"> |
---|
1354 | <code class="descname">ecuid</code><a class="headerlink" href="#ControlFile.ControlFile.ecuid" title="Permalink to this definition">¶</a></dt> |
---|
1355 | <dd><p>The user id on ECMWF server. Default value is None.</p> |
---|
1356 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1357 | <col class="field-name" /> |
---|
1358 | <col class="field-body" /> |
---|
1359 | <tbody valign="top"> |
---|
1360 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1361 | </tr> |
---|
1362 | </tbody> |
---|
1363 | </table> |
---|
1364 | </dd></dl> |
---|
1365 | |
---|
1366 | <dl class="attribute"> |
---|
1367 | <dt id="ControlFile.ControlFile.ecgid"> |
---|
1368 | <code class="descname">ecgid</code><a class="headerlink" href="#ControlFile.ControlFile.ecgid" title="Permalink to this definition">¶</a></dt> |
---|
1369 | <dd><p>The group id on ECMWF server. Default value is None.</p> |
---|
1370 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1371 | <col class="field-name" /> |
---|
1372 | <col class="field-body" /> |
---|
1373 | <tbody valign="top"> |
---|
1374 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1375 | </tr> |
---|
1376 | </tbody> |
---|
1377 | </table> |
---|
1378 | </dd></dl> |
---|
1379 | |
---|
1380 | <dl class="attribute"> |
---|
1381 | <dt id="ControlFile.ControlFile.install_target"> |
---|
1382 | <code class="descname">install_target</code><a class="headerlink" href="#ControlFile.ControlFile.install_target" title="Permalink to this definition">¶</a></dt> |
---|
1383 | <dd><p>Defines the location where the installation is to be done. |
---|
1384 | Default value is None.</p> |
---|
1385 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1386 | <col class="field-name" /> |
---|
1387 | <col class="field-body" /> |
---|
1388 | <tbody valign="top"> |
---|
1389 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1390 | </tr> |
---|
1391 | </tbody> |
---|
1392 | </table> |
---|
1393 | </dd></dl> |
---|
1394 | |
---|
1395 | <dl class="attribute"> |
---|
1396 | <dt id="ControlFile.ControlFile.debug"> |
---|
1397 | <code class="descname">debug</code><a class="headerlink" href="#ControlFile.ControlFile.debug" title="Permalink to this definition">¶</a></dt> |
---|
1398 | <dd><p>Switch to keep temporary files at the end of postprocessing (1) or |
---|
1399 | to delete all temporary files except the final output files (0). |
---|
1400 | Default value is 0.</p> |
---|
1401 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1402 | <col class="field-name" /> |
---|
1403 | <col class="field-body" /> |
---|
1404 | <tbody valign="top"> |
---|
1405 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1406 | </tr> |
---|
1407 | </tbody> |
---|
1408 | </table> |
---|
1409 | </dd></dl> |
---|
1410 | |
---|
1411 | <dl class="attribute"> |
---|
1412 | <dt id="ControlFile.ControlFile.oper"> |
---|
1413 | <code class="descname">oper</code><a class="headerlink" href="#ControlFile.ControlFile.oper" title="Permalink to this definition">¶</a></dt> |
---|
1414 | <dd><p>Switch to prepare the operational job script. Start date, end date and |
---|
1415 | basetime will be prepared with environment variables. |
---|
1416 | Default value is 0.</p> |
---|
1417 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1418 | <col class="field-name" /> |
---|
1419 | <col class="field-body" /> |
---|
1420 | <tbody valign="top"> |
---|
1421 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1422 | </tr> |
---|
1423 | </tbody> |
---|
1424 | </table> |
---|
1425 | </dd></dl> |
---|
1426 | |
---|
1427 | <dl class="attribute"> |
---|
1428 | <dt id="ControlFile.ControlFile.request"> |
---|
1429 | <code class="descname">request</code><a class="headerlink" href="#ControlFile.ControlFile.request" title="Permalink to this definition">¶</a></dt> |
---|
1430 | <dd><p>Switch to select between just retrieving the data (0), writing the mars |
---|
1431 | parameter values to a csv file (1) or doing both (2). |
---|
1432 | Default value is 0.</p> |
---|
1433 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1434 | <col class="field-name" /> |
---|
1435 | <col class="field-body" /> |
---|
1436 | <tbody valign="top"> |
---|
1437 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1438 | </tr> |
---|
1439 | </tbody> |
---|
1440 | </table> |
---|
1441 | </dd></dl> |
---|
1442 | |
---|
1443 | <dl class="attribute"> |
---|
1444 | <dt id="ControlFile.ControlFile.public"> |
---|
1445 | <code class="descname">public</code><a class="headerlink" href="#ControlFile.ControlFile.public" title="Permalink to this definition">¶</a></dt> |
---|
1446 | <dd><p>Switch to select kind of ECMWF Web Api access and the |
---|
1447 | possible data sets. Public data sets (1) and Memberstate data sets (0). |
---|
1448 | Default value is 0.</p> |
---|
1449 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1450 | <col class="field-name" /> |
---|
1451 | <col class="field-body" /> |
---|
1452 | <tbody valign="top"> |
---|
1453 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1454 | </tr> |
---|
1455 | </tbody> |
---|
1456 | </table> |
---|
1457 | </dd></dl> |
---|
1458 | |
---|
1459 | <dl class="attribute"> |
---|
1460 | <dt id="ControlFile.ControlFile.ec_api"> |
---|
1461 | <code class="descname">ec_api</code><a class="headerlink" href="#ControlFile.ControlFile.ec_api" title="Permalink to this definition">¶</a></dt> |
---|
1462 | <dd><p>Tells wether the ECMWF Web API was able to load or not. |
---|
1463 | Default value is None.</p> |
---|
1464 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1465 | <col class="field-name" /> |
---|
1466 | <col class="field-body" /> |
---|
1467 | <tbody valign="top"> |
---|
1468 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> |
---|
1469 | </tr> |
---|
1470 | </tbody> |
---|
1471 | </table> |
---|
1472 | </dd></dl> |
---|
1473 | |
---|
1474 | <dl class="attribute"> |
---|
1475 | <dt id="ControlFile.ControlFile.cds_api"> |
---|
1476 | <code class="descname">cds_api</code><a class="headerlink" href="#ControlFile.ControlFile.cds_api" title="Permalink to this definition">¶</a></dt> |
---|
1477 | <dd><p>Tells wether the CDS API was able to load or not. |
---|
1478 | Default value is None.</p> |
---|
1479 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1480 | <col class="field-name" /> |
---|
1481 | <col class="field-body" /> |
---|
1482 | <tbody valign="top"> |
---|
1483 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">boolean</td> |
---|
1484 | </tr> |
---|
1485 | </tbody> |
---|
1486 | </table> |
---|
1487 | </dd></dl> |
---|
1488 | |
---|
1489 | <dl class="attribute"> |
---|
1490 | <dt id="ControlFile.ControlFile.purefc"> |
---|
1491 | <code class="descname">purefc</code><a class="headerlink" href="#ControlFile.ControlFile.purefc" title="Permalink to this definition">¶</a></dt> |
---|
1492 | <dd><p>Switch to decide wether the job is a pure forecast retrieval or |
---|
1493 | coupled with analysis data. Default value is 0.</p> |
---|
1494 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1495 | <col class="field-name" /> |
---|
1496 | <col class="field-body" /> |
---|
1497 | <tbody valign="top"> |
---|
1498 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1499 | </tr> |
---|
1500 | </tbody> |
---|
1501 | </table> |
---|
1502 | </dd></dl> |
---|
1503 | |
---|
1504 | <dl class="attribute"> |
---|
1505 | <dt id="ControlFile.ControlFile.rrint"> |
---|
1506 | <code class="descname">rrint</code><a class="headerlink" href="#ControlFile.ControlFile.rrint" title="Permalink to this definition">¶</a></dt> |
---|
1507 | <dd><p>Switch to select between old precipitation disaggregation method (0) |
---|
1508 | or the new IA3 disaggegration method (1). Default value is 0.</p> |
---|
1509 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1510 | <col class="field-name" /> |
---|
1511 | <col class="field-body" /> |
---|
1512 | <tbody valign="top"> |
---|
1513 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1514 | </tr> |
---|
1515 | </tbody> |
---|
1516 | </table> |
---|
1517 | </dd></dl> |
---|
1518 | |
---|
1519 | <dl class="attribute"> |
---|
1520 | <dt id="ControlFile.ControlFile.doubleelda"> |
---|
1521 | <code class="descname">doubleelda</code><a class="headerlink" href="#ControlFile.ControlFile.doubleelda" title="Permalink to this definition">¶</a></dt> |
---|
1522 | <dd><p>Switch to select the calculation of extra ensemble members for the |
---|
1523 | ELDA stream. It doubles the amount of retrieved ensemble members.</p> |
---|
1524 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1525 | <col class="field-name" /> |
---|
1526 | <col class="field-body" /> |
---|
1527 | <tbody valign="top"> |
---|
1528 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1529 | </tr> |
---|
1530 | </tbody> |
---|
1531 | </table> |
---|
1532 | </dd></dl> |
---|
1533 | |
---|
1534 | <dl class="attribute"> |
---|
1535 | <dt id="ControlFile.ControlFile.logicals"> |
---|
1536 | <code class="descname">logicals</code><a class="headerlink" href="#ControlFile.ControlFile.logicals" title="Permalink to this definition">¶</a></dt> |
---|
1537 | <dd><p>List of the names of logical switches which controls the flow |
---|
1538 | of the program. Default list is [‘gauss’, ‘omega’, ‘omegadiff’, ‘eta’, |
---|
1539 | ‘etadiff’, ‘dpdeta’, ‘cwc’, ‘wrf’, ‘ecstorage’, |
---|
1540 | ‘ectrans’, ‘debug’, ‘request’, ‘public’, ‘purefc’, ‘rrint’, ‘doubleelda’]</p> |
---|
1541 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1542 | <col class="field-name" /> |
---|
1543 | <col class="field-body" /> |
---|
1544 | <tbody valign="top"> |
---|
1545 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
1546 | </tr> |
---|
1547 | </tbody> |
---|
1548 | </table> |
---|
1549 | </dd></dl> |
---|
1550 | |
---|
1551 | <dl class="method"> |
---|
1552 | <dt id="ControlFile.ControlFile.assign_args_to_control"> |
---|
1553 | <code class="descname">assign_args_to_control</code><span class="sig-paren">(</span><em>args</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/ControlFile.html#ControlFile.assign_args_to_control"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.assign_args_to_control" title="Permalink to this definition">¶</a></dt> |
---|
1554 | <dd><p>Overwrites the existing ControlFile instance attributes with |
---|
1555 | the command line arguments.</p> |
---|
1556 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1557 | <col class="field-name" /> |
---|
1558 | <col class="field-body" /> |
---|
1559 | <tbody valign="top"> |
---|
1560 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>args</strong> (<em>Namespace</em>) – Contains the commandline arguments from script/program call.</td> |
---|
1561 | </tr> |
---|
1562 | </tbody> |
---|
1563 | </table> |
---|
1564 | </dd></dl> |
---|
1565 | |
---|
1566 | <dl class="method"> |
---|
1567 | <dt id="ControlFile.ControlFile.assign_envs_to_control"> |
---|
1568 | <code class="descname">assign_envs_to_control</code><span class="sig-paren">(</span><em>envs</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/ControlFile.html#ControlFile.assign_envs_to_control"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.assign_envs_to_control" title="Permalink to this definition">¶</a></dt> |
---|
1569 | <dd><p>Assigns the ECMWF environment parameter.</p> |
---|
1570 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1571 | <col class="field-name" /> |
---|
1572 | <col class="field-body" /> |
---|
1573 | <tbody valign="top"> |
---|
1574 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>envs</strong> (<em>dict of str</em>) – Contains the ECMWF environment parameternames “ECUID”, “ECGID”, |
---|
1575 | “DESTINATION” and “GATEWAY” with its corresponding values. |
---|
1576 | They were read from the file “ECMWF_ENV”.</td> |
---|
1577 | </tr> |
---|
1578 | </tbody> |
---|
1579 | </table> |
---|
1580 | </dd></dl> |
---|
1581 | |
---|
1582 | <dl class="method"> |
---|
1583 | <dt id="ControlFile.ControlFile.check_conditions"> |
---|
1584 | <code class="descname">check_conditions</code><span class="sig-paren">(</span><em>queue</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/ControlFile.html#ControlFile.check_conditions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.check_conditions" title="Permalink to this definition">¶</a></dt> |
---|
1585 | <dd><p>Checks a couple of necessary attributes and conditions, |
---|
1586 | such as if they exist and contain values. |
---|
1587 | Otherwise set default values.</p> |
---|
1588 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1589 | <col class="field-name" /> |
---|
1590 | <col class="field-body" /> |
---|
1591 | <tbody valign="top"> |
---|
1592 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>queue</strong> (<em>str</em>) – Name of the queue if submitted to the ECMWF servers. |
---|
1593 | Used to check if ecuid, ecgid, gateway and destination |
---|
1594 | are set correctly and are not empty.</td> |
---|
1595 | </tr> |
---|
1596 | </tbody> |
---|
1597 | </table> |
---|
1598 | </dd></dl> |
---|
1599 | |
---|
1600 | <dl class="method"> |
---|
1601 | <dt id="ControlFile.ControlFile.to_list"> |
---|
1602 | <code class="descname">to_list</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/ControlFile.html#ControlFile.to_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#ControlFile.ControlFile.to_list" title="Permalink to this definition">¶</a></dt> |
---|
1603 | <dd><p>Just generates a list of strings containing the attributes and |
---|
1604 | assigned values except the attributes “_expanded”, “exedir”, |
---|
1605 | “flexextractdir” and “installdir”.</p> |
---|
1606 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1607 | <col class="field-name" /> |
---|
1608 | <col class="field-body" /> |
---|
1609 | <tbody valign="top"> |
---|
1610 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>l</strong> – A sorted list of the all ControlFile class attributes with |
---|
1611 | their values except the attributes “_expanded”, “exedir”, |
---|
1612 | “flexextractdir” and “installdir”.</td> |
---|
1613 | </tr> |
---|
1614 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list of *</td> |
---|
1615 | </tr> |
---|
1616 | </tbody> |
---|
1617 | </table> |
---|
1618 | </dd></dl> |
---|
1619 | |
---|
1620 | </dd></dl> |
---|
1621 | |
---|
1622 | </div> |
---|
1623 | <div class="section" id="module-EcFlexpart"> |
---|
1624 | <span id="ecflexpart"></span><h3><a class="toc-backref" href="#id8">EcFlexpart</a><a class="headerlink" href="#module-EcFlexpart" title="Permalink to this headline">¶</a></h3> |
---|
1625 | <dl class="class"> |
---|
1626 | <dt id="EcFlexpart.EcFlexpart"> |
---|
1627 | <em class="property">class </em><code class="descclassname">EcFlexpart.</code><code class="descname">EcFlexpart</code><span class="sig-paren">(</span><em>c</em>, <em>fluxes=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/EcFlexpart.html#EcFlexpart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart" title="Permalink to this definition">¶</a></dt> |
---|
1628 | <dd><p>Class to represent FLEXPART specific ECMWF data.</p> |
---|
1629 | <p>FLEXPART needs grib files in a specifc format. All necessary data fields |
---|
1630 | for one time step are stored in a single file. The class represents an |
---|
1631 | instance with all the parameter and settings necessary for retrieving |
---|
1632 | MARS data and modifing them so they are fitting FLEXPART needs. The class |
---|
1633 | is able to disaggregate the fluxes and convert grid types to the one needed |
---|
1634 | by FLEXPART, therefore using the FORTRAN program.</p> |
---|
1635 | <dl class="attribute"> |
---|
1636 | <dt id="EcFlexpart.EcFlexpart.mreq_count"> |
---|
1637 | <code class="descname">mreq_count</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.mreq_count" title="Permalink to this definition">¶</a></dt> |
---|
1638 | <dd><p>Counter for the number of generated mars requests.</p> |
---|
1639 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1640 | <col class="field-name" /> |
---|
1641 | <col class="field-body" /> |
---|
1642 | <tbody valign="top"> |
---|
1643 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1644 | </tr> |
---|
1645 | </tbody> |
---|
1646 | </table> |
---|
1647 | </dd></dl> |
---|
1648 | |
---|
1649 | <dl class="attribute"> |
---|
1650 | <dt id="EcFlexpart.EcFlexpart.inputdir"> |
---|
1651 | <code class="descname">inputdir</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.inputdir" title="Permalink to this definition">¶</a></dt> |
---|
1652 | <dd><p>Path to the directory where the retrieved data is stored.</p> |
---|
1653 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1654 | <col class="field-name" /> |
---|
1655 | <col class="field-body" /> |
---|
1656 | <tbody valign="top"> |
---|
1657 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1658 | </tr> |
---|
1659 | </tbody> |
---|
1660 | </table> |
---|
1661 | </dd></dl> |
---|
1662 | |
---|
1663 | <dl class="attribute"> |
---|
1664 | <dt id="EcFlexpart.EcFlexpart.dataset"> |
---|
1665 | <code class="descname">dataset</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.dataset" title="Permalink to this definition">¶</a></dt> |
---|
1666 | <dd><p>For public datasets there is the specific naming and parameter |
---|
1667 | dataset which has to be used to characterize the type of |
---|
1668 | data.</p> |
---|
1669 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1670 | <col class="field-name" /> |
---|
1671 | <col class="field-body" /> |
---|
1672 | <tbody valign="top"> |
---|
1673 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1674 | </tr> |
---|
1675 | </tbody> |
---|
1676 | </table> |
---|
1677 | </dd></dl> |
---|
1678 | |
---|
1679 | <dl class="attribute"> |
---|
1680 | <dt id="EcFlexpart.EcFlexpart.basetime"> |
---|
1681 | <code class="descname">basetime</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.basetime" title="Permalink to this definition">¶</a></dt> |
---|
1682 | <dd><p>The time for a half day retrieval. The 12 hours upfront are to be |
---|
1683 | retrieved.</p> |
---|
1684 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1685 | <col class="field-name" /> |
---|
1686 | <col class="field-body" /> |
---|
1687 | <tbody valign="top"> |
---|
1688 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1689 | </tr> |
---|
1690 | </tbody> |
---|
1691 | </table> |
---|
1692 | </dd></dl> |
---|
1693 | |
---|
1694 | <dl class="attribute"> |
---|
1695 | <dt id="EcFlexpart.EcFlexpart.dtime"> |
---|
1696 | <code class="descname">dtime</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.dtime" title="Permalink to this definition">¶</a></dt> |
---|
1697 | <dd><p>Time step in hours.</p> |
---|
1698 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1699 | <col class="field-name" /> |
---|
1700 | <col class="field-body" /> |
---|
1701 | <tbody valign="top"> |
---|
1702 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1703 | </tr> |
---|
1704 | </tbody> |
---|
1705 | </table> |
---|
1706 | </dd></dl> |
---|
1707 | |
---|
1708 | <dl class="attribute"> |
---|
1709 | <dt id="EcFlexpart.EcFlexpart.acctype"> |
---|
1710 | <code class="descname">acctype</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.acctype" title="Permalink to this definition">¶</a></dt> |
---|
1711 | <dd><p>The field type for the accumulated forecast fields.</p> |
---|
1712 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1713 | <col class="field-name" /> |
---|
1714 | <col class="field-body" /> |
---|
1715 | <tbody valign="top"> |
---|
1716 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1717 | </tr> |
---|
1718 | </tbody> |
---|
1719 | </table> |
---|
1720 | </dd></dl> |
---|
1721 | |
---|
1722 | <dl class="attribute"> |
---|
1723 | <dt id="EcFlexpart.EcFlexpart.acctime"> |
---|
1724 | <code class="descname">acctime</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.acctime" title="Permalink to this definition">¶</a></dt> |
---|
1725 | <dd><p>The starting time from the accumulated forecasts.</p> |
---|
1726 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1727 | <col class="field-name" /> |
---|
1728 | <col class="field-body" /> |
---|
1729 | <tbody valign="top"> |
---|
1730 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1731 | </tr> |
---|
1732 | </tbody> |
---|
1733 | </table> |
---|
1734 | </dd></dl> |
---|
1735 | |
---|
1736 | <dl class="attribute"> |
---|
1737 | <dt id="EcFlexpart.EcFlexpart.accmaxstep"> |
---|
1738 | <code class="descname">accmaxstep</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.accmaxstep" title="Permalink to this definition">¶</a></dt> |
---|
1739 | <dd><p>The maximum forecast step for the accumulated forecast fields.</p> |
---|
1740 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1741 | <col class="field-name" /> |
---|
1742 | <col class="field-body" /> |
---|
1743 | <tbody valign="top"> |
---|
1744 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1745 | </tr> |
---|
1746 | </tbody> |
---|
1747 | </table> |
---|
1748 | </dd></dl> |
---|
1749 | |
---|
1750 | <dl class="attribute"> |
---|
1751 | <dt id="EcFlexpart.EcFlexpart.marsclass"> |
---|
1752 | <code class="descname">marsclass</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.marsclass" title="Permalink to this definition">¶</a></dt> |
---|
1753 | <dd><p>Characterisation of dataset.</p> |
---|
1754 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1755 | <col class="field-name" /> |
---|
1756 | <col class="field-body" /> |
---|
1757 | <tbody valign="top"> |
---|
1758 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1759 | </tr> |
---|
1760 | </tbody> |
---|
1761 | </table> |
---|
1762 | </dd></dl> |
---|
1763 | |
---|
1764 | <dl class="attribute"> |
---|
1765 | <dt id="EcFlexpart.EcFlexpart.stream"> |
---|
1766 | <code class="descname">stream</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.stream" title="Permalink to this definition">¶</a></dt> |
---|
1767 | <dd><p>Identifies the forecasting system used to generate the data.</p> |
---|
1768 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1769 | <col class="field-name" /> |
---|
1770 | <col class="field-body" /> |
---|
1771 | <tbody valign="top"> |
---|
1772 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1773 | </tr> |
---|
1774 | </tbody> |
---|
1775 | </table> |
---|
1776 | </dd></dl> |
---|
1777 | |
---|
1778 | <dl class="attribute"> |
---|
1779 | <dt id="EcFlexpart.EcFlexpart.number"> |
---|
1780 | <code class="descname">number</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.number" title="Permalink to this definition">¶</a></dt> |
---|
1781 | <dd><p>Selects the member in ensemble forecast run.</p> |
---|
1782 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1783 | <col class="field-name" /> |
---|
1784 | <col class="field-body" /> |
---|
1785 | <tbody valign="top"> |
---|
1786 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1787 | </tr> |
---|
1788 | </tbody> |
---|
1789 | </table> |
---|
1790 | </dd></dl> |
---|
1791 | |
---|
1792 | <dl class="attribute"> |
---|
1793 | <dt id="EcFlexpart.EcFlexpart.resol"> |
---|
1794 | <code class="descname">resol</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.resol" title="Permalink to this definition">¶</a></dt> |
---|
1795 | <dd><p>Specifies the desired triangular truncation of retrieved data, |
---|
1796 | before carrying out any other selected post-processing.</p> |
---|
1797 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1798 | <col class="field-name" /> |
---|
1799 | <col class="field-body" /> |
---|
1800 | <tbody valign="top"> |
---|
1801 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1802 | </tr> |
---|
1803 | </tbody> |
---|
1804 | </table> |
---|
1805 | </dd></dl> |
---|
1806 | |
---|
1807 | <dl class="attribute"> |
---|
1808 | <dt id="EcFlexpart.EcFlexpart.accuracy"> |
---|
1809 | <code class="descname">accuracy</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.accuracy" title="Permalink to this definition">¶</a></dt> |
---|
1810 | <dd><p>Specifies the number of bits per value to be used in the |
---|
1811 | generated GRIB coded fields.</p> |
---|
1812 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1813 | <col class="field-name" /> |
---|
1814 | <col class="field-body" /> |
---|
1815 | <tbody valign="top"> |
---|
1816 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1817 | </tr> |
---|
1818 | </tbody> |
---|
1819 | </table> |
---|
1820 | </dd></dl> |
---|
1821 | |
---|
1822 | <dl class="attribute"> |
---|
1823 | <dt id="EcFlexpart.EcFlexpart.addpar"> |
---|
1824 | <code class="descname">addpar</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.addpar" title="Permalink to this definition">¶</a></dt> |
---|
1825 | <dd><p>List of additional parameters to be retrieved.</p> |
---|
1826 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1827 | <col class="field-name" /> |
---|
1828 | <col class="field-body" /> |
---|
1829 | <tbody valign="top"> |
---|
1830 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1831 | </tr> |
---|
1832 | </tbody> |
---|
1833 | </table> |
---|
1834 | </dd></dl> |
---|
1835 | |
---|
1836 | <dl class="attribute"> |
---|
1837 | <dt id="EcFlexpart.EcFlexpart.level"> |
---|
1838 | <code class="descname">level</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.level" title="Permalink to this definition">¶</a></dt> |
---|
1839 | <dd><p>Specifies the maximum level.</p> |
---|
1840 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1841 | <col class="field-name" /> |
---|
1842 | <col class="field-body" /> |
---|
1843 | <tbody valign="top"> |
---|
1844 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1845 | </tr> |
---|
1846 | </tbody> |
---|
1847 | </table> |
---|
1848 | </dd></dl> |
---|
1849 | |
---|
1850 | <dl class="attribute"> |
---|
1851 | <dt id="EcFlexpart.EcFlexpart.expver"> |
---|
1852 | <code class="descname">expver</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.expver" title="Permalink to this definition">¶</a></dt> |
---|
1853 | <dd><p>The version of the dataset.</p> |
---|
1854 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1855 | <col class="field-name" /> |
---|
1856 | <col class="field-body" /> |
---|
1857 | <tbody valign="top"> |
---|
1858 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1859 | </tr> |
---|
1860 | </tbody> |
---|
1861 | </table> |
---|
1862 | </dd></dl> |
---|
1863 | |
---|
1864 | <dl class="attribute"> |
---|
1865 | <dt id="EcFlexpart.EcFlexpart.levelist"> |
---|
1866 | <code class="descname">levelist</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.levelist" title="Permalink to this definition">¶</a></dt> |
---|
1867 | <dd><p>Specifies the required levels.</p> |
---|
1868 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1869 | <col class="field-name" /> |
---|
1870 | <col class="field-body" /> |
---|
1871 | <tbody valign="top"> |
---|
1872 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1873 | </tr> |
---|
1874 | </tbody> |
---|
1875 | </table> |
---|
1876 | </dd></dl> |
---|
1877 | |
---|
1878 | <dl class="attribute"> |
---|
1879 | <dt id="EcFlexpart.EcFlexpart.glevelist"> |
---|
1880 | <code class="descname">glevelist</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.glevelist" title="Permalink to this definition">¶</a></dt> |
---|
1881 | <dd><p>Specifies the required levels for gaussian grids.</p> |
---|
1882 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1883 | <col class="field-name" /> |
---|
1884 | <col class="field-body" /> |
---|
1885 | <tbody valign="top"> |
---|
1886 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1887 | </tr> |
---|
1888 | </tbody> |
---|
1889 | </table> |
---|
1890 | </dd></dl> |
---|
1891 | |
---|
1892 | <dl class="attribute"> |
---|
1893 | <dt id="EcFlexpart.EcFlexpart.gaussian"> |
---|
1894 | <code class="descname">gaussian</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.gaussian" title="Permalink to this definition">¶</a></dt> |
---|
1895 | <dd><p>This parameter is deprecated and should no longer be used. |
---|
1896 | Specifies the desired type of Gaussian grid for the output.</p> |
---|
1897 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1898 | <col class="field-name" /> |
---|
1899 | <col class="field-body" /> |
---|
1900 | <tbody valign="top"> |
---|
1901 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1902 | </tr> |
---|
1903 | </tbody> |
---|
1904 | </table> |
---|
1905 | </dd></dl> |
---|
1906 | |
---|
1907 | <dl class="attribute"> |
---|
1908 | <dt id="EcFlexpart.EcFlexpart.grid"> |
---|
1909 | <code class="descname">grid</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.grid" title="Permalink to this definition">¶</a></dt> |
---|
1910 | <dd><p>Specifies the output grid which can be either a Gaussian grid |
---|
1911 | or a Latitude/Longitude grid.</p> |
---|
1912 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1913 | <col class="field-name" /> |
---|
1914 | <col class="field-body" /> |
---|
1915 | <tbody valign="top"> |
---|
1916 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1917 | </tr> |
---|
1918 | </tbody> |
---|
1919 | </table> |
---|
1920 | </dd></dl> |
---|
1921 | |
---|
1922 | <dl class="attribute"> |
---|
1923 | <dt id="EcFlexpart.EcFlexpart.area"> |
---|
1924 | <code class="descname">area</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.area" title="Permalink to this definition">¶</a></dt> |
---|
1925 | <dd><p>Specifies the desired sub-area of data to be extracted.</p> |
---|
1926 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1927 | <col class="field-name" /> |
---|
1928 | <col class="field-body" /> |
---|
1929 | <tbody valign="top"> |
---|
1930 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
1931 | </tr> |
---|
1932 | </tbody> |
---|
1933 | </table> |
---|
1934 | </dd></dl> |
---|
1935 | |
---|
1936 | <dl class="attribute"> |
---|
1937 | <dt id="EcFlexpart.EcFlexpart.purefc"> |
---|
1938 | <code class="descname">purefc</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.purefc" title="Permalink to this definition">¶</a></dt> |
---|
1939 | <dd><p>Switch for definition of pure forecast mode or not.</p> |
---|
1940 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1941 | <col class="field-name" /> |
---|
1942 | <col class="field-body" /> |
---|
1943 | <tbody valign="top"> |
---|
1944 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
1945 | </tr> |
---|
1946 | </tbody> |
---|
1947 | </table> |
---|
1948 | </dd></dl> |
---|
1949 | |
---|
1950 | <dl class="attribute"> |
---|
1951 | <dt id="EcFlexpart.EcFlexpart.outputfilelist"> |
---|
1952 | <code class="descname">outputfilelist</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.outputfilelist" title="Permalink to this definition">¶</a></dt> |
---|
1953 | <dd><p>The final list of FLEXPART ready input files.</p> |
---|
1954 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1955 | <col class="field-name" /> |
---|
1956 | <col class="field-body" /> |
---|
1957 | <tbody valign="top"> |
---|
1958 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
1959 | </tr> |
---|
1960 | </tbody> |
---|
1961 | </table> |
---|
1962 | </dd></dl> |
---|
1963 | |
---|
1964 | <dl class="attribute"> |
---|
1965 | <dt id="EcFlexpart.EcFlexpart.types"> |
---|
1966 | <code class="descname">types</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.types" title="Permalink to this definition">¶</a></dt> |
---|
1967 | <dd><p>Determines the combination of type of fields, time and forecast step |
---|
1968 | to be retrieved.</p> |
---|
1969 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1970 | <col class="field-name" /> |
---|
1971 | <col class="field-body" /> |
---|
1972 | <tbody valign="top"> |
---|
1973 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">dictionary</td> |
---|
1974 | </tr> |
---|
1975 | </tbody> |
---|
1976 | </table> |
---|
1977 | </dd></dl> |
---|
1978 | |
---|
1979 | <dl class="attribute"> |
---|
1980 | <dt id="EcFlexpart.EcFlexpart.params"> |
---|
1981 | <code class="descname">params</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.params" title="Permalink to this definition">¶</a></dt> |
---|
1982 | <dd><p>Collection of grid types and their corresponding parameters, |
---|
1983 | levels, level types and the grid definition.</p> |
---|
1984 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1985 | <col class="field-name" /> |
---|
1986 | <col class="field-body" /> |
---|
1987 | <tbody valign="top"> |
---|
1988 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">dictionary</td> |
---|
1989 | </tr> |
---|
1990 | </tbody> |
---|
1991 | </table> |
---|
1992 | </dd></dl> |
---|
1993 | |
---|
1994 | <dl class="attribute"> |
---|
1995 | <dt id="EcFlexpart.EcFlexpart.server"> |
---|
1996 | <code class="descname">server</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.server" title="Permalink to this definition">¶</a></dt> |
---|
1997 | <dd><p>This is the connection to the ECMWF data servers.</p> |
---|
1998 | <table class="docutils field-list" frame="void" rules="none"> |
---|
1999 | <col class="field-name" /> |
---|
2000 | <col class="field-body" /> |
---|
2001 | <tbody valign="top"> |
---|
2002 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">ECMWFService or ECMWFDataServer</td> |
---|
2003 | </tr> |
---|
2004 | </tbody> |
---|
2005 | </table> |
---|
2006 | </dd></dl> |
---|
2007 | |
---|
2008 | <dl class="attribute"> |
---|
2009 | <dt id="EcFlexpart.EcFlexpart.public"> |
---|
2010 | <code class="descname">public</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.public" title="Permalink to this definition">¶</a></dt> |
---|
2011 | <dd><p>Decides which Web API Server version is used.</p> |
---|
2012 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2013 | <col class="field-name" /> |
---|
2014 | <col class="field-body" /> |
---|
2015 | <tbody valign="top"> |
---|
2016 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
2017 | </tr> |
---|
2018 | </tbody> |
---|
2019 | </table> |
---|
2020 | </dd></dl> |
---|
2021 | |
---|
2022 | <dl class="attribute"> |
---|
2023 | <dt id="EcFlexpart.EcFlexpart.dates"> |
---|
2024 | <code class="descname">dates</code><a class="headerlink" href="#EcFlexpart.EcFlexpart.dates" title="Permalink to this definition">¶</a></dt> |
---|
2025 | <dd><p>Contains start and end date of the retrieval in the format |
---|
2026 | “YYYYMMDD/to/YYYYMMDD”</p> |
---|
2027 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2028 | <col class="field-name" /> |
---|
2029 | <col class="field-body" /> |
---|
2030 | <tbody valign="top"> |
---|
2031 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
2032 | </tr> |
---|
2033 | </tbody> |
---|
2034 | </table> |
---|
2035 | </dd></dl> |
---|
2036 | |
---|
2037 | <dl class="method"> |
---|
2038 | <dt id="EcFlexpart.EcFlexpart.calc_extra_elda"> |
---|
2039 | <code class="descname">calc_extra_elda</code><span class="sig-paren">(</span><em>path</em>, <em>prefix</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/EcFlexpart.html#EcFlexpart.calc_extra_elda"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.calc_extra_elda" title="Permalink to this definition">¶</a></dt> |
---|
2040 | <dd><p>Calculates extra ensemble members for ELDA - Stream.</p> |
---|
2041 | <p>This is a specific feature which doubles the number of ensemble members |
---|
2042 | for the ELDA Stream.</p> |
---|
2043 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2044 | <col class="field-name" /> |
---|
2045 | <col class="field-body" /> |
---|
2046 | <tbody valign="top"> |
---|
2047 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
2048 | <li><strong>path</strong> (<em>str</em>) – Path to the output files.</li> |
---|
2049 | <li><strong>prefix</strong> (<em>str</em>) – The prefix of the output filenames as defined in Control file.</li> |
---|
2050 | </ul> |
---|
2051 | </td> |
---|
2052 | </tr> |
---|
2053 | </tbody> |
---|
2054 | </table> |
---|
2055 | </dd></dl> |
---|
2056 | |
---|
2057 | <dl class="method"> |
---|
2058 | <dt id="EcFlexpart.EcFlexpart.create"> |
---|
2059 | <code class="descname">create</code><span class="sig-paren">(</span><em>inputfiles</em>, <em>c</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/EcFlexpart.html#EcFlexpart.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.create" title="Permalink to this definition">¶</a></dt> |
---|
2060 | <dd><p>An index file will be created which depends on the combination |
---|
2061 | of “date”, “time” and “stepRange” values. This is used to iterate |
---|
2062 | over all messages in each grib file which were passed through the |
---|
2063 | parameter “inputfiles” to seperate specific parameters into fort.* |
---|
2064 | files. Afterwards the FORTRAN program is called to convert |
---|
2065 | the data fields all to the same grid and put them in one file |
---|
2066 | per unique time step (combination of “date”, “time” and |
---|
2067 | “stepRange”).</p> |
---|
2068 | <div class="admonition note"> |
---|
2069 | <p class="first admonition-title">Note</p> |
---|
2070 | <p class="last">This method is based on the ECMWF example index.py |
---|
2071 | <a class="reference external" href="https://software.ecmwf.int/wiki/display/GRIB/index.py">https://software.ecmwf.int/wiki/display/GRIB/index.py</a></p> |
---|
2072 | </div> |
---|
2073 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2074 | <col class="field-name" /> |
---|
2075 | <col class="field-body" /> |
---|
2076 | <tbody valign="top"> |
---|
2077 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
2078 | <li><strong>inputfiles</strong> (<a class="reference internal" href="#UioFiles.UioFiles" title="UioFiles.UioFiles"><em>UioFiles</em></a>) – Contains a list of files.</li> |
---|
2079 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
2080 | command line.</li> |
---|
2081 | </ul> |
---|
2082 | </td> |
---|
2083 | </tr> |
---|
2084 | </tbody> |
---|
2085 | </table> |
---|
2086 | </dd></dl> |
---|
2087 | |
---|
2088 | <dl class="method"> |
---|
2089 | <dt id="EcFlexpart.EcFlexpart.deacc_fluxes"> |
---|
2090 | <code class="descname">deacc_fluxes</code><span class="sig-paren">(</span><em>inputfiles</em>, <em>c</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/EcFlexpart.html#EcFlexpart.deacc_fluxes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.deacc_fluxes" title="Permalink to this definition">¶</a></dt> |
---|
2091 | <dd><p>De-accumulate and disaggregate flux data.</p> |
---|
2092 | <p>Goes through all flux fields in ordered time and de-accumulate |
---|
2093 | the fields. Afterwards the fields are disaggregated in time. |
---|
2094 | Different versions of disaggregation is provided for rainfall |
---|
2095 | data (darain, modified linear) and the surface fluxes and |
---|
2096 | stress data (dapoly, cubic polynomial).</p> |
---|
2097 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2098 | <col class="field-name" /> |
---|
2099 | <col class="field-body" /> |
---|
2100 | <tbody valign="top"> |
---|
2101 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
2102 | <li><strong>inputfiles</strong> (<a class="reference internal" href="#UioFiles.UioFiles" title="UioFiles.UioFiles"><em>UioFiles</em></a>) – Contains the list of files that contain flux data.</li> |
---|
2103 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
2104 | command line.</li> |
---|
2105 | </ul> |
---|
2106 | </td> |
---|
2107 | </tr> |
---|
2108 | </tbody> |
---|
2109 | </table> |
---|
2110 | </dd></dl> |
---|
2111 | |
---|
2112 | <dl class="method"> |
---|
2113 | <dt id="EcFlexpart.EcFlexpart.process_output"> |
---|
2114 | <code class="descname">process_output</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/EcFlexpart.html#EcFlexpart.process_output"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.process_output" title="Permalink to this definition">¶</a></dt> |
---|
2115 | <dd><p>Postprocessing of FLEXPART input files.</p> |
---|
2116 | <p>The grib files are postprocessed depending on the selection in |
---|
2117 | CONTROL file. The resulting files are moved to the output |
---|
2118 | directory if its not equal to the input directory. |
---|
2119 | The following modifications might be done if |
---|
2120 | properly switched in CONTROL file: |
---|
2121 | GRIB2 - Conversion to GRIB2 |
---|
2122 | ECTRANS - Transfer of files to gateway server |
---|
2123 | ECSTORAGE - Storage at ECMWF server</p> |
---|
2124 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2125 | <col class="field-name" /> |
---|
2126 | <col class="field-body" /> |
---|
2127 | <tbody valign="top"> |
---|
2128 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
2129 | command line.</td> |
---|
2130 | </tr> |
---|
2131 | </tbody> |
---|
2132 | </table> |
---|
2133 | </dd></dl> |
---|
2134 | |
---|
2135 | <dl class="method"> |
---|
2136 | <dt id="EcFlexpart.EcFlexpart.retrieve"> |
---|
2137 | <code class="descname">retrieve</code><span class="sig-paren">(</span><em>server</em>, <em>dates</em>, <em>public</em>, <em>request</em>, <em>inputdir='.'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/EcFlexpart.html#EcFlexpart.retrieve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.retrieve" title="Permalink to this definition">¶</a></dt> |
---|
2138 | <dd><p>Finalizing the retrieval information by setting final details |
---|
2139 | depending on grid type. |
---|
2140 | Prepares MARS retrievals per grid type and submits them.</p> |
---|
2141 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2142 | <col class="field-name" /> |
---|
2143 | <col class="field-body" /> |
---|
2144 | <tbody valign="top"> |
---|
2145 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
2146 | <li><strong>server</strong> (<em>ECMWFService</em><em> or </em><em>ECMWFDataServer</em>) – The connection to the ECMWF server. This is different |
---|
2147 | for member state users which have full access and non |
---|
2148 | member state users which have only access to the public |
---|
2149 | data sets. The decision is made from command line argument |
---|
2150 | “public”; for public access its True (ECMWFDataServer) |
---|
2151 | for member state users its False (ECMWFService)</li> |
---|
2152 | <li><strong>dates</strong> (<em>str</em>) – Contains start and end date of the retrieval in the format |
---|
2153 | “YYYYMMDD/to/YYYYMMDD”</li> |
---|
2154 | <li><strong>request</strong> (<em>int</em>) – Selects the mode of retrieval. |
---|
2155 | 0: Retrieves the data from ECMWF. |
---|
2156 | 1: Prints the mars requests to an output file. |
---|
2157 | 2: Retrieves the data and prints the mars request.</li> |
---|
2158 | <li><strong>inputdir</strong> (<em>str</em><em>, </em><em>optional</em>) – Path to the directory where the retrieved data is about |
---|
2159 | to be stored. The default is the current directory (‘.’).</li> |
---|
2160 | </ul> |
---|
2161 | </td> |
---|
2162 | </tr> |
---|
2163 | </tbody> |
---|
2164 | </table> |
---|
2165 | </dd></dl> |
---|
2166 | |
---|
2167 | <dl class="method"> |
---|
2168 | <dt id="EcFlexpart.EcFlexpart.write_namelist"> |
---|
2169 | <code class="descname">write_namelist</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/EcFlexpart.html#EcFlexpart.write_namelist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#EcFlexpart.EcFlexpart.write_namelist" title="Permalink to this definition">¶</a></dt> |
---|
2170 | <dd><p>Creates a namelist file in the temporary directory and writes |
---|
2171 | the following values to it: maxl, maxb, mlevel, |
---|
2172 | mlevelist, mnauf, metapar, rlo0, rlo1, rla0, rla1, |
---|
2173 | momega, momegadiff, mgauss, msmooth, meta, metadiff, mdpdeta</p> |
---|
2174 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2175 | <col class="field-name" /> |
---|
2176 | <col class="field-body" /> |
---|
2177 | <tbody valign="top"> |
---|
2178 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
2179 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
2180 | command line.</li> |
---|
2181 | <li><strong>filename</strong> (<em>str</em>) – Name of the namelist file.</li> |
---|
2182 | </ul> |
---|
2183 | </td> |
---|
2184 | </tr> |
---|
2185 | </tbody> |
---|
2186 | </table> |
---|
2187 | </dd></dl> |
---|
2188 | |
---|
2189 | </dd></dl> |
---|
2190 | |
---|
2191 | </div> |
---|
2192 | <div class="section" id="module-GribUtil"> |
---|
2193 | <span id="gributil"></span><h3><a class="toc-backref" href="#id9">GribUtil</a><a class="headerlink" href="#module-GribUtil" title="Permalink to this headline">¶</a></h3> |
---|
2194 | <dl class="class"> |
---|
2195 | <dt id="GribUtil.GribUtil"> |
---|
2196 | <em class="property">class </em><code class="descclassname">GribUtil.</code><code class="descname">GribUtil</code><span class="sig-paren">(</span><em>filenames</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/GribUtil.html#GribUtil"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil" title="Permalink to this definition">¶</a></dt> |
---|
2197 | <dd><p>Class for GRIB utilities (new methods) based on GRIB API</p> |
---|
2198 | <p>The GRIB API provides all necessary tools to work directly with the |
---|
2199 | grib files. Nevertheless, the GRIB API tools are very basic and are in |
---|
2200 | direct connection with the grib files. This class provides some higher |
---|
2201 | functions which apply a set of GRIB API tools together in the respective |
---|
2202 | context. So, the class initially contains a list of grib files (their |
---|
2203 | names) and the using program then applies the methods directly on the |
---|
2204 | class objects without having to think about how the actual GRIB API |
---|
2205 | tools have to be arranged.</p> |
---|
2206 | <dl class="method"> |
---|
2207 | <dt id="GribUtil.GribUtil.copy_dummy_msg"> |
---|
2208 | <code class="descname">copy_dummy_msg</code><span class="sig-paren">(</span><em>filename_in</em>, <em>keynames</em>, <em>keyvalues</em>, <em>selectwhere=True</em>, <em>filemode='wb'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/GribUtil.html#GribUtil.copy_dummy_msg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.copy_dummy_msg" title="Permalink to this definition">¶</a></dt> |
---|
2209 | <dd><p>Add the content of another input grib file to the objects file but |
---|
2210 | only messages corresponding to keys/values passed to the function. |
---|
2211 | The selectWhere switch decides if to copy the keys equal to (True) or |
---|
2212 | different to (False) the keynames/keyvalues list passed to the function.</p> |
---|
2213 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2214 | <col class="field-name" /> |
---|
2215 | <col class="field-body" /> |
---|
2216 | <tbody valign="top"> |
---|
2217 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
2218 | <li><strong>filename_in</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Filename of the input file to read the grib messages from.</li> |
---|
2219 | <li><strong>selectwhere</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">boolean</span></code>, optional) – Decides if to copy the keynames and values equal to (True) or |
---|
2220 | different to (False) the keynames/keyvalues list passed to the |
---|
2221 | function. Default is True.</li> |
---|
2222 | <li><strong>keynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of keynames.</li> |
---|
2223 | <li><strong>keyvalues</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of keyvalues.</li> |
---|
2224 | <li><strong>filemode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Sets the mode for the output file. Default is “wb”.</li> |
---|
2225 | </ul> |
---|
2226 | </td> |
---|
2227 | </tr> |
---|
2228 | </tbody> |
---|
2229 | </table> |
---|
2230 | </dd></dl> |
---|
2231 | |
---|
2232 | <dl class="method"> |
---|
2233 | <dt id="GribUtil.GribUtil.get_keys"> |
---|
2234 | <code class="descname">get_keys</code><span class="sig-paren">(</span><em>keynames</em>, <em>wherekeynames</em>, <em>wherekeyvalues</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/GribUtil.html#GribUtil.get_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.get_keys" title="Permalink to this definition">¶</a></dt> |
---|
2235 | <dd><p>Get keyvalues for a given list of keynames a where statement |
---|
2236 | can be given (list of key and list of values)</p> |
---|
2237 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2238 | <col class="field-name" /> |
---|
2239 | <col class="field-body" /> |
---|
2240 | <tbody valign="top"> |
---|
2241 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
2242 | <li><strong>keynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of keynames.</li> |
---|
2243 | <li><strong>wherekeynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of key names for indexing grib message parameter.</li> |
---|
2244 | <li><strong>wherekeyvalues</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of key values corresponding the key names.</li> |
---|
2245 | </ul> |
---|
2246 | </td> |
---|
2247 | </tr> |
---|
2248 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>return_list</strong> – List of keyvalues for given keynames.</p> |
---|
2249 | </td> |
---|
2250 | </tr> |
---|
2251 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code></p> |
---|
2252 | </td> |
---|
2253 | </tr> |
---|
2254 | </tbody> |
---|
2255 | </table> |
---|
2256 | </dd></dl> |
---|
2257 | |
---|
2258 | <dl class="method"> |
---|
2259 | <dt id="GribUtil.GribUtil.index"> |
---|
2260 | <code class="descname">index</code><span class="sig-paren">(</span><em>index_keys</em>, <em>index_file='my.idx'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/GribUtil.html#GribUtil.index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.index" title="Permalink to this definition">¶</a></dt> |
---|
2261 | <dd><p>Create index file from a list of files if it does not exist or |
---|
2262 | read an index file.</p> |
---|
2263 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2264 | <col class="field-name" /> |
---|
2265 | <col class="field-body" /> |
---|
2266 | <tbody valign="top"> |
---|
2267 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
2268 | <li><strong>index_keys</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Contains the list of key parameter names from |
---|
2269 | which the index is to be created.</li> |
---|
2270 | <li><strong>index_file</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Filename where the indices are stored. |
---|
2271 | Default is “my.idx”.</li> |
---|
2272 | </ul> |
---|
2273 | </td> |
---|
2274 | </tr> |
---|
2275 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>iid</strong> – Grib index id.</p> |
---|
2276 | </td> |
---|
2277 | </tr> |
---|
2278 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">integer</span></code></p> |
---|
2279 | </td> |
---|
2280 | </tr> |
---|
2281 | </tbody> |
---|
2282 | </table> |
---|
2283 | </dd></dl> |
---|
2284 | |
---|
2285 | <dl class="method"> |
---|
2286 | <dt id="GribUtil.GribUtil.set_keys"> |
---|
2287 | <code class="descname">set_keys</code><span class="sig-paren">(</span><em>fromfile</em>, <em>keynames</em>, <em>keyvalues</em>, <em>wherekeynames</em>, <em>wherekeyvalues</em>, <em>filemode='wb'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/GribUtil.html#GribUtil.set_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#GribUtil.GribUtil.set_keys" title="Permalink to this definition">¶</a></dt> |
---|
2288 | <dd><p>Opens the file to read the grib messages and then write |
---|
2289 | the selected messages (with wherekeys) to a new output file. |
---|
2290 | Also, the keyvalues of the passed list of keynames are set.</p> |
---|
2291 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2292 | <col class="field-name" /> |
---|
2293 | <col class="field-body" /> |
---|
2294 | <tbody valign="top"> |
---|
2295 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
2296 | <li><strong>fromfile</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – Filename of the input file to read the grib messages from.</li> |
---|
2297 | <li><strong>keynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of keynames to set in the selected messages. |
---|
2298 | Default is an empty list.</li> |
---|
2299 | <li><strong>keyvalues</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of keyvalues to set in the selected messages. |
---|
2300 | Default is an empty list.</li> |
---|
2301 | <li><strong>wherekeynames</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of keynames to select correct message.</li> |
---|
2302 | <li><strong>wherekeyvalues</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>) – List of keyvalues for keynames to select correct message.</li> |
---|
2303 | <li><strong>filemode</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">string</span></code>, optional) – Sets the mode for the output file. Default is “wb”.</li> |
---|
2304 | </ul> |
---|
2305 | </td> |
---|
2306 | </tr> |
---|
2307 | </tbody> |
---|
2308 | </table> |
---|
2309 | </dd></dl> |
---|
2310 | |
---|
2311 | </dd></dl> |
---|
2312 | |
---|
2313 | </div> |
---|
2314 | <div class="section" id="module-MarsRetrieval"> |
---|
2315 | <span id="marsretrieval"></span><h3><a class="toc-backref" href="#id10">MarsRetrieval</a><a class="headerlink" href="#module-MarsRetrieval" title="Permalink to this headline">¶</a></h3> |
---|
2316 | <dl class="class"> |
---|
2317 | <dt id="MarsRetrieval.MarsRetrieval"> |
---|
2318 | <em class="property">class </em><code class="descclassname">MarsRetrieval.</code><code class="descname">MarsRetrieval</code><span class="sig-paren">(</span><em>server</em>, <em>public</em>, <em>marsclass='EA'</em>, <em>dataset=''</em>, <em>type=''</em>, <em>levtype=''</em>, <em>levelist=''</em>, <em>repres=''</em>, <em>date=''</em>, <em>resol=''</em>, <em>stream=''</em>, <em>area=''</em>, <em>time=''</em>, <em>step=''</em>, <em>expver='1'</em>, <em>number=''</em>, <em>accuracy=''</em>, <em>grid=''</em>, <em>gaussian=''</em>, <em>target=''</em>, <em>param=''</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/MarsRetrieval.html#MarsRetrieval"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval" title="Permalink to this definition">¶</a></dt> |
---|
2319 | <dd><p>Specific syntax and content for submission of MARS retrievals.</p> |
---|
2320 | <p>A MARS revtrieval has a specific syntax with a selection of keywords and |
---|
2321 | their corresponding values. This class provides the necessary functions |
---|
2322 | by displaying the selected parameters and their values and the actual |
---|
2323 | retrievement of the data through a mars request or a Python web api |
---|
2324 | interface. The initialization already expects all the keyword values.</p> |
---|
2325 | <p>A description of MARS keywords/arguments and examples of their |
---|
2326 | values can be found here: |
---|
2327 | <a class="reference external" href="https://software.ecmwf.int/wiki/display/UDOC/">https://software.ecmwf.int/wiki/display/UDOC/</a> Identification+keywords#Identificationkeywords-class</p> |
---|
2328 | <dl class="attribute"> |
---|
2329 | <dt id="MarsRetrieval.MarsRetrieval.server"> |
---|
2330 | <code class="descname">server</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.server" title="Permalink to this definition">¶</a></dt> |
---|
2331 | <dd><p>This is the connection to the ECMWF data servers.</p> |
---|
2332 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2333 | <col class="field-name" /> |
---|
2334 | <col class="field-body" /> |
---|
2335 | <tbody valign="top"> |
---|
2336 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">ECMWFService or ECMWFDataServer</td> |
---|
2337 | </tr> |
---|
2338 | </tbody> |
---|
2339 | </table> |
---|
2340 | </dd></dl> |
---|
2341 | |
---|
2342 | <dl class="attribute"> |
---|
2343 | <dt id="MarsRetrieval.MarsRetrieval.public"> |
---|
2344 | <code class="descname">public</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.public" title="Permalink to this definition">¶</a></dt> |
---|
2345 | <dd><p>Decides which Web API Server version is used.</p> |
---|
2346 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2347 | <col class="field-name" /> |
---|
2348 | <col class="field-body" /> |
---|
2349 | <tbody valign="top"> |
---|
2350 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">int</td> |
---|
2351 | </tr> |
---|
2352 | </tbody> |
---|
2353 | </table> |
---|
2354 | </dd></dl> |
---|
2355 | |
---|
2356 | <dl class="attribute"> |
---|
2357 | <dt id="MarsRetrieval.MarsRetrieval.marsclass"> |
---|
2358 | <code class="descname">marsclass</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.marsclass" title="Permalink to this definition">¶</a></dt> |
---|
2359 | <dd><p>Characterisation of dataset.</p> |
---|
2360 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2361 | <col class="field-name" /> |
---|
2362 | <col class="field-body" /> |
---|
2363 | <tbody valign="top"> |
---|
2364 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2365 | </tr> |
---|
2366 | </tbody> |
---|
2367 | </table> |
---|
2368 | </dd></dl> |
---|
2369 | |
---|
2370 | <dl class="attribute"> |
---|
2371 | <dt id="MarsRetrieval.MarsRetrieval.dataset"> |
---|
2372 | <code class="descname">dataset</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.dataset" title="Permalink to this definition">¶</a></dt> |
---|
2373 | <dd><p>For public datasets there is the specific naming and parameter |
---|
2374 | dataset which has to be used to characterize the type of |
---|
2375 | data.</p> |
---|
2376 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2377 | <col class="field-name" /> |
---|
2378 | <col class="field-body" /> |
---|
2379 | <tbody valign="top"> |
---|
2380 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2381 | </tr> |
---|
2382 | </tbody> |
---|
2383 | </table> |
---|
2384 | </dd></dl> |
---|
2385 | |
---|
2386 | <dl class="attribute"> |
---|
2387 | <dt id="MarsRetrieval.MarsRetrieval.type"> |
---|
2388 | <code class="descname">type</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.type" title="Permalink to this definition">¶</a></dt> |
---|
2389 | <dd><p>Determines the type of fields to be retrieved.</p> |
---|
2390 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2391 | <col class="field-name" /> |
---|
2392 | <col class="field-body" /> |
---|
2393 | <tbody valign="top"> |
---|
2394 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2395 | </tr> |
---|
2396 | </tbody> |
---|
2397 | </table> |
---|
2398 | </dd></dl> |
---|
2399 | |
---|
2400 | <dl class="attribute"> |
---|
2401 | <dt id="MarsRetrieval.MarsRetrieval.levtype"> |
---|
2402 | <code class="descname">levtype</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.levtype" title="Permalink to this definition">¶</a></dt> |
---|
2403 | <dd><p>Denotes type of level.</p> |
---|
2404 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2405 | <col class="field-name" /> |
---|
2406 | <col class="field-body" /> |
---|
2407 | <tbody valign="top"> |
---|
2408 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2409 | </tr> |
---|
2410 | </tbody> |
---|
2411 | </table> |
---|
2412 | </dd></dl> |
---|
2413 | |
---|
2414 | <dl class="attribute"> |
---|
2415 | <dt id="MarsRetrieval.MarsRetrieval.levelist"> |
---|
2416 | <code class="descname">levelist</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.levelist" title="Permalink to this definition">¶</a></dt> |
---|
2417 | <dd><p>Specifies the required levels.</p> |
---|
2418 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2419 | <col class="field-name" /> |
---|
2420 | <col class="field-body" /> |
---|
2421 | <tbody valign="top"> |
---|
2422 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2423 | </tr> |
---|
2424 | </tbody> |
---|
2425 | </table> |
---|
2426 | </dd></dl> |
---|
2427 | |
---|
2428 | <dl class="attribute"> |
---|
2429 | <dt id="MarsRetrieval.MarsRetrieval.repres"> |
---|
2430 | <code class="descname">repres</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.repres" title="Permalink to this definition">¶</a></dt> |
---|
2431 | <dd><p>Selects the representation of the archived data.</p> |
---|
2432 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2433 | <col class="field-name" /> |
---|
2434 | <col class="field-body" /> |
---|
2435 | <tbody valign="top"> |
---|
2436 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2437 | </tr> |
---|
2438 | </tbody> |
---|
2439 | </table> |
---|
2440 | </dd></dl> |
---|
2441 | |
---|
2442 | <dl class="attribute"> |
---|
2443 | <dt id="MarsRetrieval.MarsRetrieval.date"> |
---|
2444 | <code class="descname">date</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.date" title="Permalink to this definition">¶</a></dt> |
---|
2445 | <dd><p>Specifies the Analysis date, the Forecast base date or |
---|
2446 | Observations date.</p> |
---|
2447 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2448 | <col class="field-name" /> |
---|
2449 | <col class="field-body" /> |
---|
2450 | <tbody valign="top"> |
---|
2451 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2452 | </tr> |
---|
2453 | </tbody> |
---|
2454 | </table> |
---|
2455 | </dd></dl> |
---|
2456 | |
---|
2457 | <dl class="attribute"> |
---|
2458 | <dt id="MarsRetrieval.MarsRetrieval.resol"> |
---|
2459 | <code class="descname">resol</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.resol" title="Permalink to this definition">¶</a></dt> |
---|
2460 | <dd><p>Specifies the desired triangular truncation of retrieved data, |
---|
2461 | before carrying out any other selected post-processing.</p> |
---|
2462 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2463 | <col class="field-name" /> |
---|
2464 | <col class="field-body" /> |
---|
2465 | <tbody valign="top"> |
---|
2466 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2467 | </tr> |
---|
2468 | </tbody> |
---|
2469 | </table> |
---|
2470 | </dd></dl> |
---|
2471 | |
---|
2472 | <dl class="attribute"> |
---|
2473 | <dt id="MarsRetrieval.MarsRetrieval.stream"> |
---|
2474 | <code class="descname">stream</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.stream" title="Permalink to this definition">¶</a></dt> |
---|
2475 | <dd><p>Identifies the forecasting system used to generate the data.</p> |
---|
2476 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2477 | <col class="field-name" /> |
---|
2478 | <col class="field-body" /> |
---|
2479 | <tbody valign="top"> |
---|
2480 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2481 | </tr> |
---|
2482 | </tbody> |
---|
2483 | </table> |
---|
2484 | </dd></dl> |
---|
2485 | |
---|
2486 | <dl class="attribute"> |
---|
2487 | <dt id="MarsRetrieval.MarsRetrieval.area"> |
---|
2488 | <code class="descname">area</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.area" title="Permalink to this definition">¶</a></dt> |
---|
2489 | <dd><p>Specifies the desired sub-area of data to be extracted.</p> |
---|
2490 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2491 | <col class="field-name" /> |
---|
2492 | <col class="field-body" /> |
---|
2493 | <tbody valign="top"> |
---|
2494 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2495 | </tr> |
---|
2496 | </tbody> |
---|
2497 | </table> |
---|
2498 | </dd></dl> |
---|
2499 | |
---|
2500 | <dl class="attribute"> |
---|
2501 | <dt id="MarsRetrieval.MarsRetrieval.time"> |
---|
2502 | <code class="descname">time</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.time" title="Permalink to this definition">¶</a></dt> |
---|
2503 | <dd><p>Specifies the time of the data in hours and minutes.</p> |
---|
2504 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2505 | <col class="field-name" /> |
---|
2506 | <col class="field-body" /> |
---|
2507 | <tbody valign="top"> |
---|
2508 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2509 | </tr> |
---|
2510 | </tbody> |
---|
2511 | </table> |
---|
2512 | </dd></dl> |
---|
2513 | |
---|
2514 | <dl class="attribute"> |
---|
2515 | <dt id="MarsRetrieval.MarsRetrieval.step"> |
---|
2516 | <code class="descname">step</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.step" title="Permalink to this definition">¶</a></dt> |
---|
2517 | <dd><p>Specifies the forecast time step from forecast base time.</p> |
---|
2518 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2519 | <col class="field-name" /> |
---|
2520 | <col class="field-body" /> |
---|
2521 | <tbody valign="top"> |
---|
2522 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2523 | </tr> |
---|
2524 | </tbody> |
---|
2525 | </table> |
---|
2526 | </dd></dl> |
---|
2527 | |
---|
2528 | <dl class="attribute"> |
---|
2529 | <dt id="MarsRetrieval.MarsRetrieval.expver"> |
---|
2530 | <code class="descname">expver</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.expver" title="Permalink to this definition">¶</a></dt> |
---|
2531 | <dd><p>The version of the dataset.</p> |
---|
2532 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2533 | <col class="field-name" /> |
---|
2534 | <col class="field-body" /> |
---|
2535 | <tbody valign="top"> |
---|
2536 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2537 | </tr> |
---|
2538 | </tbody> |
---|
2539 | </table> |
---|
2540 | </dd></dl> |
---|
2541 | |
---|
2542 | <dl class="attribute"> |
---|
2543 | <dt id="MarsRetrieval.MarsRetrieval.number"> |
---|
2544 | <code class="descname">number</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.number" title="Permalink to this definition">¶</a></dt> |
---|
2545 | <dd><p>Selects the member in ensemble forecast run.</p> |
---|
2546 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2547 | <col class="field-name" /> |
---|
2548 | <col class="field-body" /> |
---|
2549 | <tbody valign="top"> |
---|
2550 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2551 | </tr> |
---|
2552 | </tbody> |
---|
2553 | </table> |
---|
2554 | </dd></dl> |
---|
2555 | |
---|
2556 | <dl class="attribute"> |
---|
2557 | <dt id="MarsRetrieval.MarsRetrieval.accuracy"> |
---|
2558 | <code class="descname">accuracy</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.accuracy" title="Permalink to this definition">¶</a></dt> |
---|
2559 | <dd><p>Specifies the number of bits per value to be used in the |
---|
2560 | generated GRIB coded fields.</p> |
---|
2561 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2562 | <col class="field-name" /> |
---|
2563 | <col class="field-body" /> |
---|
2564 | <tbody valign="top"> |
---|
2565 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2566 | </tr> |
---|
2567 | </tbody> |
---|
2568 | </table> |
---|
2569 | </dd></dl> |
---|
2570 | |
---|
2571 | <dl class="attribute"> |
---|
2572 | <dt id="MarsRetrieval.MarsRetrieval.grid"> |
---|
2573 | <code class="descname">grid</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.grid" title="Permalink to this definition">¶</a></dt> |
---|
2574 | <dd><p>Specifies the output grid which can be either a Gaussian grid |
---|
2575 | or a Latitude/Longitude grid.</p> |
---|
2576 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2577 | <col class="field-name" /> |
---|
2578 | <col class="field-body" /> |
---|
2579 | <tbody valign="top"> |
---|
2580 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2581 | </tr> |
---|
2582 | </tbody> |
---|
2583 | </table> |
---|
2584 | </dd></dl> |
---|
2585 | |
---|
2586 | <dl class="attribute"> |
---|
2587 | <dt id="MarsRetrieval.MarsRetrieval.gaussian"> |
---|
2588 | <code class="descname">gaussian</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.gaussian" title="Permalink to this definition">¶</a></dt> |
---|
2589 | <dd><p>This parameter is deprecated and should no longer be used. |
---|
2590 | Specifies the desired type of Gaussian grid for the output.</p> |
---|
2591 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2592 | <col class="field-name" /> |
---|
2593 | <col class="field-body" /> |
---|
2594 | <tbody valign="top"> |
---|
2595 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2596 | </tr> |
---|
2597 | </tbody> |
---|
2598 | </table> |
---|
2599 | </dd></dl> |
---|
2600 | |
---|
2601 | <dl class="attribute"> |
---|
2602 | <dt id="MarsRetrieval.MarsRetrieval.target"> |
---|
2603 | <code class="descname">target</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.target" title="Permalink to this definition">¶</a></dt> |
---|
2604 | <dd><p>Specifies a file into which data is to be written after |
---|
2605 | retrieval or manipulation.</p> |
---|
2606 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2607 | <col class="field-name" /> |
---|
2608 | <col class="field-body" /> |
---|
2609 | <tbody valign="top"> |
---|
2610 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2611 | </tr> |
---|
2612 | </tbody> |
---|
2613 | </table> |
---|
2614 | </dd></dl> |
---|
2615 | |
---|
2616 | <dl class="attribute"> |
---|
2617 | <dt id="MarsRetrieval.MarsRetrieval.param"> |
---|
2618 | <code class="descname">param</code><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.param" title="Permalink to this definition">¶</a></dt> |
---|
2619 | <dd><p>Specifies the meteorological parameter.</p> |
---|
2620 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2621 | <col class="field-name" /> |
---|
2622 | <col class="field-body" /> |
---|
2623 | <tbody valign="top"> |
---|
2624 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str, optional</td> |
---|
2625 | </tr> |
---|
2626 | </tbody> |
---|
2627 | </table> |
---|
2628 | </dd></dl> |
---|
2629 | |
---|
2630 | <dl class="method"> |
---|
2631 | <dt id="MarsRetrieval.MarsRetrieval.data_retrieve"> |
---|
2632 | <code class="descname">data_retrieve</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/MarsRetrieval.html#MarsRetrieval.data_retrieve"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.data_retrieve" title="Permalink to this definition">¶</a></dt> |
---|
2633 | <dd><p>Submits a MARS retrieval. Depending on the existence of |
---|
2634 | ECMWF Web-API or CDS API it is submitted via Python or a |
---|
2635 | subprocess in the Shell. The parameter for the mars retrieval |
---|
2636 | are taken from the defined class attributes.</p> |
---|
2637 | </dd></dl> |
---|
2638 | |
---|
2639 | <dl class="method"> |
---|
2640 | <dt id="MarsRetrieval.MarsRetrieval.display_info"> |
---|
2641 | <code class="descname">display_info</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/MarsRetrieval.html#MarsRetrieval.display_info"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.display_info" title="Permalink to this definition">¶</a></dt> |
---|
2642 | <dd><p>Prints all class attributes and their values to the |
---|
2643 | standard output.</p> |
---|
2644 | </dd></dl> |
---|
2645 | |
---|
2646 | <dl class="method"> |
---|
2647 | <dt id="MarsRetrieval.MarsRetrieval.print_infodata_csv"> |
---|
2648 | <code class="descname">print_infodata_csv</code><span class="sig-paren">(</span><em>inputdir</em>, <em>request_number</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/MarsRetrieval.html#MarsRetrieval.print_infodata_csv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#MarsRetrieval.MarsRetrieval.print_infodata_csv" title="Permalink to this definition">¶</a></dt> |
---|
2649 | <dd><p>Write all request parameter in alpabetical order into a “csv” file.</p> |
---|
2650 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2651 | <col class="field-name" /> |
---|
2652 | <col class="field-body" /> |
---|
2653 | <tbody valign="top"> |
---|
2654 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
2655 | <li><strong>inputdir</strong> (<em>str</em>) – The path where all data from the retrievals are stored.</li> |
---|
2656 | <li><strong>request_number</strong> (<em>int</em>) – Number of mars requests for flux and non-flux data.</li> |
---|
2657 | </ul> |
---|
2658 | </td> |
---|
2659 | </tr> |
---|
2660 | </tbody> |
---|
2661 | </table> |
---|
2662 | </dd></dl> |
---|
2663 | |
---|
2664 | </dd></dl> |
---|
2665 | |
---|
2666 | </div> |
---|
2667 | <div class="section" id="module-UioFiles"> |
---|
2668 | <span id="uiofiles"></span><h3><a class="toc-backref" href="#id11">UioFiles</a><a class="headerlink" href="#module-UioFiles" title="Permalink to this headline">¶</a></h3> |
---|
2669 | <dl class="class"> |
---|
2670 | <dt id="UioFiles.UioFiles"> |
---|
2671 | <em class="property">class </em><code class="descclassname">UioFiles.</code><code class="descname">UioFiles</code><span class="sig-paren">(</span><em>path</em>, <em>pattern</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/UioFiles.html#UioFiles"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#UioFiles.UioFiles" title="Permalink to this definition">¶</a></dt> |
---|
2672 | <dd><p>Collection of files matching a specific pattern.</p> |
---|
2673 | <p>The pattern can contain regular expressions for the files. |
---|
2674 | The files are listed and can be transformed to a single string or |
---|
2675 | they can be deleted.</p> |
---|
2676 | <dl class="attribute"> |
---|
2677 | <dt id="UioFiles.UioFiles.path"> |
---|
2678 | <code class="descname">path</code><a class="headerlink" href="#UioFiles.UioFiles.path" title="Permalink to this definition">¶</a></dt> |
---|
2679 | <dd><p>Directory where to list the files.</p> |
---|
2680 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2681 | <col class="field-name" /> |
---|
2682 | <col class="field-body" /> |
---|
2683 | <tbody valign="top"> |
---|
2684 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
2685 | </tr> |
---|
2686 | </tbody> |
---|
2687 | </table> |
---|
2688 | </dd></dl> |
---|
2689 | |
---|
2690 | <dl class="attribute"> |
---|
2691 | <dt id="UioFiles.UioFiles.pattern"> |
---|
2692 | <code class="descname">pattern</code><a class="headerlink" href="#UioFiles.UioFiles.pattern" title="Permalink to this definition">¶</a></dt> |
---|
2693 | <dd><p>Regular expression pattern. For example: ‘<a href="#id1"><span class="problematic" id="id2">*</span></a>.grb’</p> |
---|
2694 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2695 | <col class="field-name" /> |
---|
2696 | <col class="field-body" /> |
---|
2697 | <tbody valign="top"> |
---|
2698 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">str</td> |
---|
2699 | </tr> |
---|
2700 | </tbody> |
---|
2701 | </table> |
---|
2702 | </dd></dl> |
---|
2703 | |
---|
2704 | <dl class="attribute"> |
---|
2705 | <dt id="UioFiles.UioFiles.files"> |
---|
2706 | <code class="descname">files</code><a class="headerlink" href="#UioFiles.UioFiles.files" title="Permalink to this definition">¶</a></dt> |
---|
2707 | <dd><p>List of files matching the pattern in the path.</p> |
---|
2708 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2709 | <col class="field-name" /> |
---|
2710 | <col class="field-body" /> |
---|
2711 | <tbody valign="top"> |
---|
2712 | <tr class="field-odd field"><th class="field-name">Type:</th><td class="field-body">list of str</td> |
---|
2713 | </tr> |
---|
2714 | </tbody> |
---|
2715 | </table> |
---|
2716 | </dd></dl> |
---|
2717 | |
---|
2718 | <dl class="method"> |
---|
2719 | <dt id="UioFiles.UioFiles.delete_files"> |
---|
2720 | <code class="descname">delete_files</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/UioFiles.html#UioFiles.delete_files"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#UioFiles.UioFiles.delete_files" title="Permalink to this definition">¶</a></dt> |
---|
2721 | <dd><p>Deletes the files.</p> |
---|
2722 | </dd></dl> |
---|
2723 | |
---|
2724 | </dd></dl> |
---|
2725 | |
---|
2726 | </div> |
---|
2727 | </div> |
---|
2728 | <div class="section" id="modules"> |
---|
2729 | <h2><a class="toc-backref" href="#id12">Modules</a><a class="headerlink" href="#modules" title="Permalink to this headline">¶</a></h2> |
---|
2730 | <div class="section" id="module-get_mars_data"> |
---|
2731 | <span id="get-mars-data"></span><h3><a class="toc-backref" href="#id13">get_mars_data</a><a class="headerlink" href="#module-get_mars_data" title="Permalink to this headline">¶</a></h3> |
---|
2732 | <p>This script extracts MARS data from ECMWF servers.</p> |
---|
2733 | <p>At first, the necessary parameters from command line and CONTROL files are |
---|
2734 | extracted. They define the data set to be extracted from MARS.</p> |
---|
2735 | <p>This file can also be imported as a module and contains the following |
---|
2736 | functions:</p> |
---|
2737 | <blockquote> |
---|
2738 | <div><ul class="simple"> |
---|
2739 | <li>main - the main function of the script</li> |
---|
2740 | <li>get_mars_data - overall control of ECMWF data retrievment</li> |
---|
2741 | <li>write_reqheader - writes the header into the mars_request file</li> |
---|
2742 | <li>mk_server - creates the server connection to ECMWF servers</li> |
---|
2743 | <li>mk_dates - defines the start and end date</li> |
---|
2744 | <li>remove_old - deletes old retrieved grib files</li> |
---|
2745 | <li>do_retrievement - creates individual retrievals</li> |
---|
2746 | </ul> |
---|
2747 | </div></blockquote> |
---|
2748 | <p>Type: get_mars_data.py –help |
---|
2749 | to get information about command line parameters. |
---|
2750 | Read the documentation for usage instructions.</p> |
---|
2751 | <dl class="function"> |
---|
2752 | <dt id="get_mars_data.check_dates_for_nonflux_fc_times"> |
---|
2753 | <code class="descclassname">get_mars_data.</code><code class="descname">check_dates_for_nonflux_fc_times</code><span class="sig-paren">(</span><em>types</em>, <em>times</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/get_mars_data.html#check_dates_for_nonflux_fc_times"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.check_dates_for_nonflux_fc_times" title="Permalink to this definition">¶</a></dt> |
---|
2754 | <dd><p>Checks if the time 18UTC corresponds to forecast field.</p> |
---|
2755 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2756 | <col class="field-name" /> |
---|
2757 | <col class="field-body" /> |
---|
2758 | <tbody valign="top"> |
---|
2759 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
2760 | <li><strong>types</strong> (<em>list of str</em>) – List of field types.</li> |
---|
2761 | <li><strong>times</strong> (<em>list of str</em><em> or </em><em>str</em>) – The time in hours of the field.</li> |
---|
2762 | </ul> |
---|
2763 | </td> |
---|
2764 | </tr> |
---|
2765 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"></p> |
---|
2766 | </td> |
---|
2767 | </tr> |
---|
2768 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">True or False</p> |
---|
2769 | </td> |
---|
2770 | </tr> |
---|
2771 | </tbody> |
---|
2772 | </table> |
---|
2773 | </dd></dl> |
---|
2774 | |
---|
2775 | <dl class="function"> |
---|
2776 | <dt id="get_mars_data.do_retrievement"> |
---|
2777 | <code class="descclassname">get_mars_data.</code><code class="descname">do_retrievement</code><span class="sig-paren">(</span><em>c</em>, <em>server</em>, <em>start</em>, <em>end</em>, <em>delta_t</em>, <em>fluxes=False</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/get_mars_data.html#do_retrievement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.do_retrievement" title="Permalink to this definition">¶</a></dt> |
---|
2778 | <dd><p>Divides the complete retrieval period in smaller chunks and |
---|
2779 | retrieves the data from MARS.</p> |
---|
2780 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2781 | <col class="field-name" /> |
---|
2782 | <col class="field-body" /> |
---|
2783 | <tbody valign="top"> |
---|
2784 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
2785 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
2786 | command line.</li> |
---|
2787 | <li><strong>server</strong> (<em>ECMWFService</em><em> or </em><em>ECMWFDataServer</em>) – The server connection to ECMWF.</li> |
---|
2788 | <li><strong>start</strong> (<em>datetime</em>) – The start date of the retrieval.</li> |
---|
2789 | <li><strong>end</strong> (<em>datetime</em>) – The end date of the retrieval.</li> |
---|
2790 | <li><strong>delta_t</strong> (<em>datetime</em>) – Delta_t + 1 is the maximal time period of a single |
---|
2791 | retrieval.</li> |
---|
2792 | <li><strong>fluxes</strong> (<em>boolean</em><em>, </em><em>optional</em>) – Decides if the flux parameters are to be retrieved or |
---|
2793 | the rest of the parameter list. |
---|
2794 | Default value is False.</li> |
---|
2795 | </ul> |
---|
2796 | </td> |
---|
2797 | </tr> |
---|
2798 | </tbody> |
---|
2799 | </table> |
---|
2800 | </dd></dl> |
---|
2801 | |
---|
2802 | <dl class="function"> |
---|
2803 | <dt id="get_mars_data.get_mars_data"> |
---|
2804 | <code class="descclassname">get_mars_data.</code><code class="descname">get_mars_data</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/get_mars_data.html#get_mars_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.get_mars_data" title="Permalink to this definition">¶</a></dt> |
---|
2805 | <dd><p>Retrieves the EC data needed for a FLEXPART simulation.</p> |
---|
2806 | <p>Start and end dates for retrieval period is set. Retrievals |
---|
2807 | are divided into smaller periods if necessary and datechunk parameter |
---|
2808 | is set.</p> |
---|
2809 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2810 | <col class="field-name" /> |
---|
2811 | <col class="field-body" /> |
---|
2812 | <tbody valign="top"> |
---|
2813 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
2814 | command line.</td> |
---|
2815 | </tr> |
---|
2816 | </tbody> |
---|
2817 | </table> |
---|
2818 | </dd></dl> |
---|
2819 | |
---|
2820 | <dl class="function"> |
---|
2821 | <dt id="get_mars_data.main"> |
---|
2822 | <code class="descclassname">get_mars_data.</code><code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/get_mars_data.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.main" title="Permalink to this definition">¶</a></dt> |
---|
2823 | <dd><p>Controls the program to get data out of mars.</p> |
---|
2824 | <p>This is done if it is called directly from command line. |
---|
2825 | Then it also takes program call arguments and control file input.</p> |
---|
2826 | </dd></dl> |
---|
2827 | |
---|
2828 | <dl class="function"> |
---|
2829 | <dt id="get_mars_data.mk_dates"> |
---|
2830 | <code class="descclassname">get_mars_data.</code><code class="descname">mk_dates</code><span class="sig-paren">(</span><em>c</em>, <em>fluxes</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/get_mars_data.html#mk_dates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.mk_dates" title="Permalink to this definition">¶</a></dt> |
---|
2831 | <dd><p>Prepares start and end date depending on flux or non flux data.</p> |
---|
2832 | <p>If forecast for maximum one day (upto 24h) are to be retrieved, then |
---|
2833 | collect accumulation data (flux data) with additional days in the |
---|
2834 | beginning and at the end (used for complete disaggregation of |
---|
2835 | original period)</p> |
---|
2836 | <p>If forecast data longer than 24h are to be retrieved, then |
---|
2837 | collect accumulation data (flux data) with the exact start and end date |
---|
2838 | (disaggregation will be done for the exact time period with |
---|
2839 | boundary conditions)</p> |
---|
2840 | <p>Since for basetime the extraction contains the 12 hours upfront, |
---|
2841 | if basetime is 0, the starting date has to be the day before</p> |
---|
2842 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2843 | <col class="field-name" /> |
---|
2844 | <col class="field-body" /> |
---|
2845 | <tbody valign="top"> |
---|
2846 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
2847 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
2848 | command line.</li> |
---|
2849 | <li><strong>fluxes</strong> (<em>boolean</em><em>, </em><em>optional</em>) – Decides if the flux parameter settings are stored or |
---|
2850 | the rest of the parameter list. |
---|
2851 | Default value is False.</li> |
---|
2852 | </ul> |
---|
2853 | </td> |
---|
2854 | </tr> |
---|
2855 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><ul class="simple"> |
---|
2856 | <li><strong>start</strong> (<em>datetime</em>) – The start date of the retrieving data set.</li> |
---|
2857 | <li><strong>end</strong> (<em>datetime</em>) – The end date of the retrieving data set.</li> |
---|
2858 | <li><strong>chunk</strong> (<em>datetime</em>) – Time period in days for one single mars retrieval.</li> |
---|
2859 | </ul> |
---|
2860 | </p> |
---|
2861 | </td> |
---|
2862 | </tr> |
---|
2863 | </tbody> |
---|
2864 | </table> |
---|
2865 | </dd></dl> |
---|
2866 | |
---|
2867 | <dl class="function"> |
---|
2868 | <dt id="get_mars_data.mk_server"> |
---|
2869 | <code class="descclassname">get_mars_data.</code><code class="descname">mk_server</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/get_mars_data.html#mk_server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.mk_server" title="Permalink to this definition">¶</a></dt> |
---|
2870 | <dd><p>Creates a server connection with available python API.</p> |
---|
2871 | <p>Which API is used depends on availability and the dataset to be retrieved. |
---|
2872 | The CDS API is used for ERA5 dataset no matter if the user is a member or |
---|
2873 | a public user. ECMWF WebAPI is used for all other available datasets.</p> |
---|
2874 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2875 | <col class="field-name" /> |
---|
2876 | <col class="field-body" /> |
---|
2877 | <tbody valign="top"> |
---|
2878 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
2879 | command line.</td> |
---|
2880 | </tr> |
---|
2881 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>server</strong> – Connection to ECMWF server via python interface ECMWF WebAPI or CDS API.</td> |
---|
2882 | </tr> |
---|
2883 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">ECMWFDataServer, ECMWFService or Client</td> |
---|
2884 | </tr> |
---|
2885 | </tbody> |
---|
2886 | </table> |
---|
2887 | </dd></dl> |
---|
2888 | |
---|
2889 | <dl class="function"> |
---|
2890 | <dt id="get_mars_data.remove_old"> |
---|
2891 | <code class="descclassname">get_mars_data.</code><code class="descname">remove_old</code><span class="sig-paren">(</span><em>pattern</em>, <em>inputdir</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/get_mars_data.html#remove_old"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.remove_old" title="Permalink to this definition">¶</a></dt> |
---|
2892 | <dd><p>Deletes old retrieval files from current input directory |
---|
2893 | matching the pattern.</p> |
---|
2894 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2895 | <col class="field-name" /> |
---|
2896 | <col class="field-body" /> |
---|
2897 | <tbody valign="top"> |
---|
2898 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
2899 | <li><strong>pattern</strong> (<em>str</em>) – The sub string pattern which identifies the files to be deleted.</li> |
---|
2900 | <li><strong>inputdir</strong> (<em>str</em><em>, </em><em>optional</em>) – Path to the directory where the retrieved data is stored.</li> |
---|
2901 | </ul> |
---|
2902 | </td> |
---|
2903 | </tr> |
---|
2904 | </tbody> |
---|
2905 | </table> |
---|
2906 | </dd></dl> |
---|
2907 | |
---|
2908 | <dl class="function"> |
---|
2909 | <dt id="get_mars_data.write_reqheader"> |
---|
2910 | <code class="descclassname">get_mars_data.</code><code class="descname">write_reqheader</code><span class="sig-paren">(</span><em>marsfile</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/get_mars_data.html#write_reqheader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#get_mars_data.write_reqheader" title="Permalink to this definition">¶</a></dt> |
---|
2911 | <dd><p>Writes header with column names into mars request file.</p> |
---|
2912 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2913 | <col class="field-name" /> |
---|
2914 | <col class="field-body" /> |
---|
2915 | <tbody valign="top"> |
---|
2916 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>marsfile</strong> (<em>str</em>) – Path to the mars request file.</td> |
---|
2917 | </tr> |
---|
2918 | </tbody> |
---|
2919 | </table> |
---|
2920 | </dd></dl> |
---|
2921 | |
---|
2922 | </div> |
---|
2923 | <div class="section" id="module-prepare_flexpart"> |
---|
2924 | <span id="prepare-flexpart"></span><h3><a class="toc-backref" href="#id14">prepare_flexpart</a><a class="headerlink" href="#module-prepare_flexpart" title="Permalink to this headline">¶</a></h3> |
---|
2925 | <p>This script prepares the final version of the grib files which are |
---|
2926 | then used by FLEXPART.</p> |
---|
2927 | <p>It converts the bunch of grib files extracted via get_mars_data before, |
---|
2928 | by doing the necessary conversion to get consistent grids or the |
---|
2929 | disaggregation of flux data. Finally, the data fields are combined |
---|
2930 | in files per available hour with the naming convention xxYYMMDDHH, |
---|
2931 | where xx should be 2 arbitrary letters (mostly xx is chosen to be “EN”).</p> |
---|
2932 | <p>This file can also be imported as a module which then contains the following |
---|
2933 | functions:</p> |
---|
2934 | <blockquote> |
---|
2935 | <div><ul class="simple"> |
---|
2936 | <li>main</li> |
---|
2937 | <li>prepare_flexpart</li> |
---|
2938 | </ul> |
---|
2939 | </div></blockquote> |
---|
2940 | <p>Type: prepare_flexpart.py –help |
---|
2941 | to get information about command line parameters. |
---|
2942 | Read the documentation for usage instructions.</p> |
---|
2943 | <dl class="function"> |
---|
2944 | <dt id="prepare_flexpart.main"> |
---|
2945 | <code class="descclassname">prepare_flexpart.</code><code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/prepare_flexpart.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#prepare_flexpart.main" title="Permalink to this definition">¶</a></dt> |
---|
2946 | <dd><p>Controls the program to prepare flexpart input files from mars data.</p> |
---|
2947 | <p>This is done if it is called directly from command line. |
---|
2948 | Then it also takes program call arguments and control file input.</p> |
---|
2949 | </dd></dl> |
---|
2950 | |
---|
2951 | <dl class="function"> |
---|
2952 | <dt id="prepare_flexpart.prepare_flexpart"> |
---|
2953 | <code class="descclassname">prepare_flexpart.</code><code class="descname">prepare_flexpart</code><span class="sig-paren">(</span><em>ppid</em>, <em>c</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/prepare_flexpart.html#prepare_flexpart"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#prepare_flexpart.prepare_flexpart" title="Permalink to this definition">¶</a></dt> |
---|
2954 | <dd><p>Converts the mars data into flexpart ready input files.</p> |
---|
2955 | <p>Specific data fields are converted to a different grid and the flux |
---|
2956 | data are going to be disaggregated. The data fields are collected by |
---|
2957 | hour and stored in a file with a specific FLEXPART relevant naming |
---|
2958 | convention.</p> |
---|
2959 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2960 | <col class="field-name" /> |
---|
2961 | <col class="field-body" /> |
---|
2962 | <tbody valign="top"> |
---|
2963 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
2964 | <li><strong>ppid</strong> (<em>int</em>) – Contains the ppid number of the current ECMWF job. It will be None if |
---|
2965 | the method was called within this module.</li> |
---|
2966 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
2967 | command line.</li> |
---|
2968 | </ul> |
---|
2969 | </td> |
---|
2970 | </tr> |
---|
2971 | </tbody> |
---|
2972 | </table> |
---|
2973 | </dd></dl> |
---|
2974 | |
---|
2975 | </div> |
---|
2976 | <div class="section" id="module-tools"> |
---|
2977 | <span id="tools"></span><h3><a class="toc-backref" href="#id15">tools</a><a class="headerlink" href="#module-tools" title="Permalink to this headline">¶</a></h3> |
---|
2978 | <p>This module contains a collection of diverse tasks within flex_extract.</p> |
---|
2979 | <dl class="function"> |
---|
2980 | <dt id="tools.clean_up"> |
---|
2981 | <code class="descclassname">tools.</code><code class="descname">clean_up</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#clean_up"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.clean_up" title="Permalink to this definition">¶</a></dt> |
---|
2982 | <dd><p>Remove files from the intermediate directory (inputdir).</p> |
---|
2983 | <p>It keeps the final FLEXPART input files if program runs without |
---|
2984 | ECMWF Api and keywords “ectrans” or “ecstorage” are set to “1”.</p> |
---|
2985 | <table class="docutils field-list" frame="void" rules="none"> |
---|
2986 | <col class="field-name" /> |
---|
2987 | <col class="field-body" /> |
---|
2988 | <tbody valign="top"> |
---|
2989 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
2990 | command line.</td> |
---|
2991 | </tr> |
---|
2992 | </tbody> |
---|
2993 | </table> |
---|
2994 | </dd></dl> |
---|
2995 | |
---|
2996 | <dl class="function"> |
---|
2997 | <dt id="tools.execute_subprocess"> |
---|
2998 | <code class="descclassname">tools.</code><code class="descname">execute_subprocess</code><span class="sig-paren">(</span><em>cmd_list</em>, <em>error_msg='SUBPROCESS FAILED!'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#execute_subprocess"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.execute_subprocess" title="Permalink to this definition">¶</a></dt> |
---|
2999 | <dd><p>Executes a command line instruction via a subprocess.</p> |
---|
3000 | <p>Error handling is done if an error occures.</p> |
---|
3001 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3002 | <col class="field-name" /> |
---|
3003 | <col class="field-body" /> |
---|
3004 | <tbody valign="top"> |
---|
3005 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>cmd_list</strong> (<em>list of str</em>) – A list of the components for the command line execution. Each |
---|
3006 | list entry is a single part of the command which is seperated from |
---|
3007 | the rest by a blank space. |
---|
3008 | E.g. [‘mv’, file1, file2]</td> |
---|
3009 | </tr> |
---|
3010 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>error_msg</strong> – The possible error message if the subprocess failed. |
---|
3011 | By default it will just tell “SUBPROCESS FAILED!”.</td> |
---|
3012 | </tr> |
---|
3013 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str, optional</td> |
---|
3014 | </tr> |
---|
3015 | </tbody> |
---|
3016 | </table> |
---|
3017 | </dd></dl> |
---|
3018 | |
---|
3019 | <dl class="function"> |
---|
3020 | <dt id="tools.generate_retrieval_period_boundary"> |
---|
3021 | <code class="descclassname">tools.</code><code class="descname">generate_retrieval_period_boundary</code><span class="sig-paren">(</span><em>c</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#generate_retrieval_period_boundary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.generate_retrieval_period_boundary" title="Permalink to this definition">¶</a></dt> |
---|
3022 | <dd><p>Generates retrieval period boundary datetimes from CONTROL information.</p> |
---|
3023 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3024 | <col class="field-name" /> |
---|
3025 | <col class="field-body" /> |
---|
3026 | <tbody valign="top"> |
---|
3027 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
3028 | command line.</td> |
---|
3029 | </tr> |
---|
3030 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><ul class="simple"> |
---|
3031 | <li><strong>start_period</strong> (<em>datetime</em>) – The first timestamp of the actual retrieval period disregarding |
---|
3032 | the temporary times which were used for processing reasons.</li> |
---|
3033 | <li><strong>end_period</strong> (<em>datetime</em>) – The last timestamp of the actual retrieval period disregarding |
---|
3034 | the temporary times which were used for processing reasons.</li> |
---|
3035 | </ul> |
---|
3036 | </td> |
---|
3037 | </tr> |
---|
3038 | </tbody> |
---|
3039 | </table> |
---|
3040 | </dd></dl> |
---|
3041 | |
---|
3042 | <dl class="function"> |
---|
3043 | <dt id="tools.get_cmdline_args"> |
---|
3044 | <code class="descclassname">tools.</code><code class="descname">get_cmdline_args</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#get_cmdline_args"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_cmdline_args" title="Permalink to this definition">¶</a></dt> |
---|
3045 | <dd><p>Decomposes the command line arguments and assigns them to variables. |
---|
3046 | Apply default values for non mentioned arguments.</p> |
---|
3047 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3048 | <col class="field-name" /> |
---|
3049 | <col class="field-body" /> |
---|
3050 | <tbody valign="top"> |
---|
3051 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><strong>args</strong> – Contains the commandline arguments from script/program call.</td> |
---|
3052 | </tr> |
---|
3053 | <tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Namespace</td> |
---|
3054 | </tr> |
---|
3055 | </tbody> |
---|
3056 | </table> |
---|
3057 | </dd></dl> |
---|
3058 | |
---|
3059 | <dl class="function"> |
---|
3060 | <dt id="tools.get_dimensions"> |
---|
3061 | <code class="descclassname">tools.</code><code class="descname">get_dimensions</code><span class="sig-paren">(</span><em>info</em>, <em>purefc</em>, <em>dtime</em>, <em>index_vals</em>, <em>start_date</em>, <em>end_date</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#get_dimensions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_dimensions" title="Permalink to this definition">¶</a></dt> |
---|
3062 | <dd><p>This function specifies the correct dimensions for x, y and t.</p> |
---|
3063 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3064 | <col class="field-name" /> |
---|
3065 | <col class="field-body" /> |
---|
3066 | <tbody valign="top"> |
---|
3067 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3068 | <li><strong>info</strong> (<em>dict</em>) – Contains basic informations of the ECMWF grib files, e.g. |
---|
3069 | ‘Ni’, ‘Nj’, ‘latitudeOfFirstGridPointInDegrees’, |
---|
3070 | ‘longitudeOfFirstGridPointInDegrees’, ‘latitudeOfLastGridPointInDegrees’, |
---|
3071 | ‘longitudeOfLastGridPointInDegrees’, ‘jDirectionIncrementInDegrees’, |
---|
3072 | ‘iDirectionIncrementInDegrees’, ‘missingValue’</li> |
---|
3073 | <li><strong>purefc</strong> (<em>int</em>) – Switch for definition of pure forecast mode or not.</li> |
---|
3074 | <li><strong>dtime</strong> (<em>str</em>) – Time step in hours.</li> |
---|
3075 | <li><strong>index_vals</strong> (<em>list of list of str</em>) – Contains the values from the keys used for a distinct selection |
---|
3076 | of grib messages in processing the grib files. |
---|
3077 | Content looks like e.g.: |
---|
3078 | index_vals[0]: (‘20171106’, ‘20171107’, ‘20171108’) ; date |
---|
3079 | index_vals[1]: (‘0’, ‘1200’, ‘1800’, ‘600’) ; time |
---|
3080 | index_vals[2]: (‘0’, ‘12’, ‘3’, ‘6’, ‘9’) ; stepRange</li> |
---|
3081 | <li><strong>start_date</strong> (<em>str</em>) – The start date of the retrieval job.</li> |
---|
3082 | <li><strong>end_date</strong> (<em>str</em>) – The end date of the retrieval job.</li> |
---|
3083 | </ul> |
---|
3084 | </td> |
---|
3085 | </tr> |
---|
3086 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>(ix, jy, it)</strong> – Dimension in x-direction, y-direction and in time.</p> |
---|
3087 | </td> |
---|
3088 | </tr> |
---|
3089 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">tuple of int</p> |
---|
3090 | </td> |
---|
3091 | </tr> |
---|
3092 | </tbody> |
---|
3093 | </table> |
---|
3094 | </dd></dl> |
---|
3095 | |
---|
3096 | <dl class="function"> |
---|
3097 | <dt id="tools.get_informations"> |
---|
3098 | <code class="descclassname">tools.</code><code class="descname">get_informations</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#get_informations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_informations" title="Permalink to this definition">¶</a></dt> |
---|
3099 | <dd><p>Gets basic information from an example grib file.</p> |
---|
3100 | <p>These information are important for later use and the |
---|
3101 | initialization of numpy arrays for data storing.</p> |
---|
3102 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3103 | <col class="field-name" /> |
---|
3104 | <col class="field-body" /> |
---|
3105 | <tbody valign="top"> |
---|
3106 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>str</em>) – Name of the file which will be opened to extract basic information.</td> |
---|
3107 | </tr> |
---|
3108 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>data</strong> – Contains basic informations of the ECMWF grib files, e.g. |
---|
3109 | ‘Ni’, ‘Nj’, ‘latitudeOfFirstGridPointInDegrees’, |
---|
3110 | ‘longitudeOfFirstGridPointInDegrees’, ‘latitudeOfLastGridPointInDegrees’, |
---|
3111 | ‘longitudeOfLastGridPointInDegrees’, ‘jDirectionIncrementInDegrees’, |
---|
3112 | ‘iDirectionIncrementInDegrees’, ‘missingValue’</td> |
---|
3113 | </tr> |
---|
3114 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td> |
---|
3115 | </tr> |
---|
3116 | </tbody> |
---|
3117 | </table> |
---|
3118 | </dd></dl> |
---|
3119 | |
---|
3120 | <dl class="function"> |
---|
3121 | <dt id="tools.get_list_as_string"> |
---|
3122 | <code class="descclassname">tools.</code><code class="descname">get_list_as_string</code><span class="sig-paren">(</span><em>list_obj</em>, <em>concatenate_sign='</em>, <em>'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#get_list_as_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.get_list_as_string" title="Permalink to this definition">¶</a></dt> |
---|
3123 | <dd><p>Converts a list of arbitrary content into a single string.</p> |
---|
3124 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3125 | <col class="field-name" /> |
---|
3126 | <col class="field-body" /> |
---|
3127 | <tbody valign="top"> |
---|
3128 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3129 | <li><strong>list_obj</strong> (<em>list of *</em>) – A list with arbitrary content.</li> |
---|
3130 | <li><strong>concatenate_sign</strong> (<em>str</em><em>, </em><em>optional</em>) – A string which is used to concatenate the single |
---|
3131 | list elements. Default value is “, “.</li> |
---|
3132 | </ul> |
---|
3133 | </td> |
---|
3134 | </tr> |
---|
3135 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>str_of_list</strong> – The content of the list as a single string.</p> |
---|
3136 | </td> |
---|
3137 | </tr> |
---|
3138 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p> |
---|
3139 | </td> |
---|
3140 | </tr> |
---|
3141 | </tbody> |
---|
3142 | </table> |
---|
3143 | </dd></dl> |
---|
3144 | |
---|
3145 | <dl class="function"> |
---|
3146 | <dt id="tools.init128"> |
---|
3147 | <code class="descclassname">tools.</code><code class="descname">init128</code><span class="sig-paren">(</span><em>filepath</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#init128"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.init128" title="Permalink to this definition">¶</a></dt> |
---|
3148 | <dd><p>Opens and reads the grib file with table 128 information.</p> |
---|
3149 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3150 | <col class="field-name" /> |
---|
3151 | <col class="field-body" /> |
---|
3152 | <tbody valign="top"> |
---|
3153 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filepath</strong> (<em>str</em>) – Path to file of ECMWF grib table number 128.</td> |
---|
3154 | </tr> |
---|
3155 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>table128</strong> – Contains the ECMWF grib table 128 information. |
---|
3156 | The key is the parameter number and the value is the |
---|
3157 | short name of the parameter.</td> |
---|
3158 | </tr> |
---|
3159 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td> |
---|
3160 | </tr> |
---|
3161 | </tbody> |
---|
3162 | </table> |
---|
3163 | </dd></dl> |
---|
3164 | |
---|
3165 | <dl class="function"> |
---|
3166 | <dt id="tools.make_dir"> |
---|
3167 | <code class="descclassname">tools.</code><code class="descname">make_dir</code><span class="sig-paren">(</span><em>directory</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#make_dir"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.make_dir" title="Permalink to this definition">¶</a></dt> |
---|
3168 | <dd><p>Creates a directory.</p> |
---|
3169 | <p>It gives a warning if the directory already exists and skips process. |
---|
3170 | The program stops only if there is another problem.</p> |
---|
3171 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3172 | <col class="field-name" /> |
---|
3173 | <col class="field-body" /> |
---|
3174 | <tbody valign="top"> |
---|
3175 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>directory</strong> (<em>str</em>) – The path to directory which should be created.</td> |
---|
3176 | </tr> |
---|
3177 | </tbody> |
---|
3178 | </table> |
---|
3179 | </dd></dl> |
---|
3180 | |
---|
3181 | <dl class="function"> |
---|
3182 | <dt id="tools.my_error"> |
---|
3183 | <code class="descclassname">tools.</code><code class="descname">my_error</code><span class="sig-paren">(</span><em>message='ERROR'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#my_error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.my_error" title="Permalink to this definition">¶</a></dt> |
---|
3184 | <dd><p>Prints a specified error message which can be passed to the function |
---|
3185 | before exiting the program.</p> |
---|
3186 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3187 | <col class="field-name" /> |
---|
3188 | <col class="field-body" /> |
---|
3189 | <tbody valign="top"> |
---|
3190 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> (<em>str</em><em>, </em><em>optional</em>) – Error message. Default value is “ERROR”.</td> |
---|
3191 | </tr> |
---|
3192 | </tbody> |
---|
3193 | </table> |
---|
3194 | </dd></dl> |
---|
3195 | |
---|
3196 | <dl class="function"> |
---|
3197 | <dt id="tools.none_or_int"> |
---|
3198 | <code class="descclassname">tools.</code><code class="descname">none_or_int</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#none_or_int"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.none_or_int" title="Permalink to this definition">¶</a></dt> |
---|
3199 | <dd><p>Converts the input string into pythons None-type if the string |
---|
3200 | contains string “None”. Otherwise it is converted to an integer value.</p> |
---|
3201 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3202 | <col class="field-name" /> |
---|
3203 | <col class="field-body" /> |
---|
3204 | <tbody valign="top"> |
---|
3205 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> (<em>str</em>) – String to be checked for the “None” word.</td> |
---|
3206 | </tr> |
---|
3207 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Return depends on the content of the input value. If it was “None”, |
---|
3208 | then the python type None is returned. Otherwise the string is |
---|
3209 | converted into an integer value.</td> |
---|
3210 | </tr> |
---|
3211 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None or int(value)</td> |
---|
3212 | </tr> |
---|
3213 | </tbody> |
---|
3214 | </table> |
---|
3215 | </dd></dl> |
---|
3216 | |
---|
3217 | <dl class="function"> |
---|
3218 | <dt id="tools.none_or_str"> |
---|
3219 | <code class="descclassname">tools.</code><code class="descname">none_or_str</code><span class="sig-paren">(</span><em>value</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#none_or_str"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.none_or_str" title="Permalink to this definition">¶</a></dt> |
---|
3220 | <dd><p>Converts the input string into pythons None-type if the string |
---|
3221 | contains string “None”.</p> |
---|
3222 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3223 | <col class="field-name" /> |
---|
3224 | <col class="field-body" /> |
---|
3225 | <tbody valign="top"> |
---|
3226 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> (<em>str</em>) – String to be checked for the “None” word.</td> |
---|
3227 | </tr> |
---|
3228 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Return depends on the content of the input value. If it was “None”, |
---|
3229 | then the python type None is returned. Otherwise the string itself.</td> |
---|
3230 | </tr> |
---|
3231 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">None or value</td> |
---|
3232 | </tr> |
---|
3233 | </tbody> |
---|
3234 | </table> |
---|
3235 | </dd></dl> |
---|
3236 | |
---|
3237 | <dl class="function"> |
---|
3238 | <dt id="tools.normal_exit"> |
---|
3239 | <code class="descclassname">tools.</code><code class="descname">normal_exit</code><span class="sig-paren">(</span><em>message='Done!'</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#normal_exit"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.normal_exit" title="Permalink to this definition">¶</a></dt> |
---|
3240 | <dd><p>Prints a specific exit message which can be passed to the function.</p> |
---|
3241 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3242 | <col class="field-name" /> |
---|
3243 | <col class="field-body" /> |
---|
3244 | <tbody valign="top"> |
---|
3245 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>message</strong> (<em>str</em><em>, </em><em>optional</em>) – Message for exiting program. Default value is “Done!”.</td> |
---|
3246 | </tr> |
---|
3247 | </tbody> |
---|
3248 | </table> |
---|
3249 | </dd></dl> |
---|
3250 | |
---|
3251 | <dl class="function"> |
---|
3252 | <dt id="tools.product"> |
---|
3253 | <code class="descclassname">tools.</code><code class="descname">product</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwds</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#product"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.product" title="Permalink to this definition">¶</a></dt> |
---|
3254 | <dd><p>Creates combinations of all passed arguments.</p> |
---|
3255 | <p>This method combines the single characters of the passed arguments |
---|
3256 | with each other. So that each character of each argument value |
---|
3257 | will be combined with each character of the other arguments as a tuple.</p> |
---|
3258 | <div class="admonition note"> |
---|
3259 | <p class="first admonition-title">Note</p> |
---|
3260 | <p class="last">This method is taken from an example at the ECMWF wiki website. |
---|
3261 | <a class="reference external" href="https://software.ecmwf.int/wiki/display/GRIB/index.py">https://software.ecmwf.int/wiki/display/GRIB/index.py</a>; 2018-03-16</p> |
---|
3262 | </div> |
---|
3263 | <p class="rubric">Example</p> |
---|
3264 | <p>product(‘ABCD’, ‘xy’) –> Ax Ay Bx By Cx Cy Dx Dy</p> |
---|
3265 | <p>product(range(2), repeat = 3) –> 000 001 010 011 100 101 110 111</p> |
---|
3266 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3267 | <col class="field-name" /> |
---|
3268 | <col class="field-body" /> |
---|
3269 | <tbody valign="top"> |
---|
3270 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3271 | <li><strong>*args</strong> (<em>list</em><em> or </em><em>str</em>) – Positional arguments (arbitrary number).</li> |
---|
3272 | <li><strong>**kwds</strong> (<em>dict</em>) – Contains all the keyword arguments from *args.</li> |
---|
3273 | </ul> |
---|
3274 | </td> |
---|
3275 | </tr> |
---|
3276 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>prod</strong> – Return will be done with “yield”. A tuple of combined arguments. |
---|
3277 | See example in description above.</p> |
---|
3278 | </td> |
---|
3279 | </tr> |
---|
3280 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">tuple</span></code></p> |
---|
3281 | </td> |
---|
3282 | </tr> |
---|
3283 | </tbody> |
---|
3284 | </table> |
---|
3285 | </dd></dl> |
---|
3286 | |
---|
3287 | <dl class="function"> |
---|
3288 | <dt id="tools.put_file_to_ecserver"> |
---|
3289 | <code class="descclassname">tools.</code><code class="descname">put_file_to_ecserver</code><span class="sig-paren">(</span><em>ecd</em>, <em>filename</em>, <em>target</em>, <em>ecuid</em>, <em>ecgid</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#put_file_to_ecserver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.put_file_to_ecserver" title="Permalink to this definition">¶</a></dt> |
---|
3290 | <dd><p>Uses the ecaccess-file-put command to send a file to the ECMWF servers.</p> |
---|
3291 | <div class="admonition note"> |
---|
3292 | <p class="first admonition-title">Note</p> |
---|
3293 | <p class="last">The return value is just for testing reasons. It does not have |
---|
3294 | to be used from the calling function since the whole error handling |
---|
3295 | is done in here.</p> |
---|
3296 | </div> |
---|
3297 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3298 | <col class="field-name" /> |
---|
3299 | <col class="field-body" /> |
---|
3300 | <tbody valign="top"> |
---|
3301 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
3302 | <li><strong>ecd</strong> (<em>str</em>) – The path were the file is stored.</li> |
---|
3303 | <li><strong>filename</strong> (<em>str</em>) – The name of the file to send to the ECMWF server.</li> |
---|
3304 | <li><strong>target</strong> (<em>str</em>) – The target queue where the file should be sent to.</li> |
---|
3305 | <li><strong>ecuid</strong> (<em>str</em>) – The user id on ECMWF server.</li> |
---|
3306 | <li><strong>ecgid</strong> (<em>str</em>) – The group id on ECMWF server.</li> |
---|
3307 | </ul> |
---|
3308 | </td> |
---|
3309 | </tr> |
---|
3310 | </tbody> |
---|
3311 | </table> |
---|
3312 | </dd></dl> |
---|
3313 | |
---|
3314 | <dl class="function"> |
---|
3315 | <dt id="tools.read_ecenv"> |
---|
3316 | <code class="descclassname">tools.</code><code class="descname">read_ecenv</code><span class="sig-paren">(</span><em>filepath</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#read_ecenv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.read_ecenv" title="Permalink to this definition">¶</a></dt> |
---|
3317 | <dd><p>Reads the file into a dictionary where the key values are the parameter |
---|
3318 | names.</p> |
---|
3319 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3320 | <col class="field-name" /> |
---|
3321 | <col class="field-body" /> |
---|
3322 | <tbody valign="top"> |
---|
3323 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filepath</strong> (<em>str</em>) – Path to file where the ECMWF environment parameters are stored.</td> |
---|
3324 | </tr> |
---|
3325 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>envs</strong> – Contains the environment parameter ecuid, ecgid, gateway |
---|
3326 | and destination for ECMWF server environments.</td> |
---|
3327 | </tr> |
---|
3328 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td> |
---|
3329 | </tr> |
---|
3330 | </tbody> |
---|
3331 | </table> |
---|
3332 | </dd></dl> |
---|
3333 | |
---|
3334 | <dl class="function"> |
---|
3335 | <dt id="tools.send_mail"> |
---|
3336 | <code class="descclassname">tools.</code><code class="descname">send_mail</code><span class="sig-paren">(</span><em>users</em>, <em>success_mode</em>, <em>message</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#send_mail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.send_mail" title="Permalink to this definition">¶</a></dt> |
---|
3337 | <dd><p>Prints a specific exit message which can be passed to the function.</p> |
---|
3338 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3339 | <col class="field-name" /> |
---|
3340 | <col class="field-body" /> |
---|
3341 | <tbody valign="top"> |
---|
3342 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
3343 | <li><strong>users</strong> (<em>list of str</em>) – Contains all email addresses which should be notified. |
---|
3344 | It might also contain just the ecmwf user name which wil trigger |
---|
3345 | mailing to the associated email address for this user.</li> |
---|
3346 | <li><strong>success_mode</strong> (<em>str</em>) – States the exit mode of the program to put into |
---|
3347 | the mail subject line.</li> |
---|
3348 | <li><strong>message</strong> (<em>str</em><em>, </em><em>optional</em>) – Message for exiting program. Default value is “Done!”.</li> |
---|
3349 | </ul> |
---|
3350 | </td> |
---|
3351 | </tr> |
---|
3352 | </tbody> |
---|
3353 | </table> |
---|
3354 | </dd></dl> |
---|
3355 | |
---|
3356 | <dl class="function"> |
---|
3357 | <dt id="tools.setup_controldata"> |
---|
3358 | <code class="descclassname">tools.</code><code class="descname">setup_controldata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#setup_controldata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.setup_controldata" title="Permalink to this definition">¶</a></dt> |
---|
3359 | <dd><p>Collects, stores and checks controlling arguments from command line, |
---|
3360 | CONTROL file and ECMWF_ENV file.</p> |
---|
3361 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3362 | <col class="field-name" /> |
---|
3363 | <col class="field-body" /> |
---|
3364 | <tbody valign="top"> |
---|
3365 | <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><ul class="simple"> |
---|
3366 | <li><strong>c</strong> (<em>ControlFile</em>) – Contains all the parameters of CONTROL file and |
---|
3367 | command line.</li> |
---|
3368 | <li><strong>ppid</strong> (<em>str</em>) – Parent process id.</li> |
---|
3369 | <li><strong>queue</strong> (<em>str</em>) – Name of queue for submission to ECMWF (e.g. ecgate or cca )</li> |
---|
3370 | <li><strong>job_template</strong> (<em>str</em>) – Name of the job template file for submission to ECMWF server.</li> |
---|
3371 | </ul> |
---|
3372 | </td> |
---|
3373 | </tr> |
---|
3374 | </tbody> |
---|
3375 | </table> |
---|
3376 | </dd></dl> |
---|
3377 | |
---|
3378 | <dl class="function"> |
---|
3379 | <dt id="tools.silent_remove"> |
---|
3380 | <code class="descclassname">tools.</code><code class="descname">silent_remove</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#silent_remove"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.silent_remove" title="Permalink to this definition">¶</a></dt> |
---|
3381 | <dd><p>Remove file if it exists. |
---|
3382 | The function does not fail if the file does not exist.</p> |
---|
3383 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3384 | <col class="field-name" /> |
---|
3385 | <col class="field-body" /> |
---|
3386 | <tbody valign="top"> |
---|
3387 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>str</em>) – The name of the file to be removed without notification.</td> |
---|
3388 | </tr> |
---|
3389 | </tbody> |
---|
3390 | </table> |
---|
3391 | </dd></dl> |
---|
3392 | |
---|
3393 | <dl class="function"> |
---|
3394 | <dt id="tools.submit_job_to_ecserver"> |
---|
3395 | <code class="descclassname">tools.</code><code class="descname">submit_job_to_ecserver</code><span class="sig-paren">(</span><em>target</em>, <em>jobname</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#submit_job_to_ecserver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.submit_job_to_ecserver" title="Permalink to this definition">¶</a></dt> |
---|
3396 | <dd><p>Uses ecaccess-job-submit command to submit a job to the ECMWF server.</p> |
---|
3397 | <div class="admonition note"> |
---|
3398 | <p class="first admonition-title">Note</p> |
---|
3399 | <p class="last">The return value is just for testing reasons. It does not have |
---|
3400 | to be used from the calling function since the whole error handling |
---|
3401 | is done in here.</p> |
---|
3402 | </div> |
---|
3403 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3404 | <col class="field-name" /> |
---|
3405 | <col class="field-body" /> |
---|
3406 | <tbody valign="top"> |
---|
3407 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3408 | <li><strong>target</strong> (<em>str</em>) – The target where the file should be sent to, e.g. the queue.</li> |
---|
3409 | <li><strong>jobname</strong> (<em>str</em>) – The name of the jobfile to be submitted to the ECMWF server.</li> |
---|
3410 | </ul> |
---|
3411 | </td> |
---|
3412 | </tr> |
---|
3413 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>job_id</strong> – The id number of the job as a reference at the ecmwf server.</p> |
---|
3414 | </td> |
---|
3415 | </tr> |
---|
3416 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">int</p> |
---|
3417 | </td> |
---|
3418 | </tr> |
---|
3419 | </tbody> |
---|
3420 | </table> |
---|
3421 | </dd></dl> |
---|
3422 | |
---|
3423 | <dl class="function"> |
---|
3424 | <dt id="tools.to_param_id"> |
---|
3425 | <code class="descclassname">tools.</code><code class="descname">to_param_id</code><span class="sig-paren">(</span><em>pars</em>, <em>table</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#to_param_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.to_param_id" title="Permalink to this definition">¶</a></dt> |
---|
3426 | <dd><p>Transform parameter names to parameter ids with ECMWF grib table 128.</p> |
---|
3427 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3428 | <col class="field-name" /> |
---|
3429 | <col class="field-body" /> |
---|
3430 | <tbody valign="top"> |
---|
3431 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3432 | <li><strong>pars</strong> (<em>str</em>) – Addpar argument from CONTROL file in the format of |
---|
3433 | parameter names instead of ids. The parameter short |
---|
3434 | names are sepearted with “/” and they are passed as |
---|
3435 | one single string.</li> |
---|
3436 | <li><strong>table</strong> (<em>dict</em>) – Contains the ECMWF grib table 128 information. |
---|
3437 | The key is the parameter number and the value is the |
---|
3438 | short name of the parameter.</li> |
---|
3439 | </ul> |
---|
3440 | </td> |
---|
3441 | </tr> |
---|
3442 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ipar</strong> – List of addpar parameters from CONTROL file transformed to |
---|
3443 | parameter ids in the format of integer.</p> |
---|
3444 | </td> |
---|
3445 | </tr> |
---|
3446 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of int</p> |
---|
3447 | </td> |
---|
3448 | </tr> |
---|
3449 | </tbody> |
---|
3450 | </table> |
---|
3451 | </dd></dl> |
---|
3452 | |
---|
3453 | <dl class="function"> |
---|
3454 | <dt id="tools.to_param_id_with_tablenumber"> |
---|
3455 | <code class="descclassname">tools.</code><code class="descname">to_param_id_with_tablenumber</code><span class="sig-paren">(</span><em>pars</em>, <em>table</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/tools.html#to_param_id_with_tablenumber"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#tools.to_param_id_with_tablenumber" title="Permalink to this definition">¶</a></dt> |
---|
3456 | <dd><p>Transform parameter names to parameter ids and add table id.</p> |
---|
3457 | <p>Conversion with ECMWF grib table 128.</p> |
---|
3458 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3459 | <col class="field-name" /> |
---|
3460 | <col class="field-body" /> |
---|
3461 | <tbody valign="top"> |
---|
3462 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3463 | <li><strong>pars</strong> (<em>str</em>) – Addpar argument from CONTROL file in the format of |
---|
3464 | parameter names instead of ids. The parameter short |
---|
3465 | names are sepearted with “/” and they are passed as |
---|
3466 | one single string.</li> |
---|
3467 | <li><strong>table</strong> (<em>dict</em>) – Contains the ECMWF grib table 128 information. |
---|
3468 | The key is the parameter number and the value is the |
---|
3469 | short name of the parameter.</li> |
---|
3470 | </ul> |
---|
3471 | </td> |
---|
3472 | </tr> |
---|
3473 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>spar</strong> – List of addpar parameters from CONTROL file transformed to |
---|
3474 | parameter ids in the format of integer.</p> |
---|
3475 | </td> |
---|
3476 | </tr> |
---|
3477 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p> |
---|
3478 | </td> |
---|
3479 | </tr> |
---|
3480 | </tbody> |
---|
3481 | </table> |
---|
3482 | </dd></dl> |
---|
3483 | |
---|
3484 | </div> |
---|
3485 | <div class="section" id="module-checks"> |
---|
3486 | <span id="checks"></span><h3><a class="toc-backref" href="#id16">checks</a><a class="headerlink" href="#module-checks" title="Permalink to this headline">¶</a></h3> |
---|
3487 | <p>This module contains check methods for the CONTROL paramaters.</p> |
---|
3488 | <dl class="function"> |
---|
3489 | <dt id="checks.check_accmaxstep"> |
---|
3490 | <code class="descclassname">checks.</code><code class="descname">check_accmaxstep</code><span class="sig-paren">(</span><em>accmaxstep</em>, <em>marsclass</em>, <em>purefc</em>, <em>maxstep</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_accmaxstep"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_accmaxstep" title="Permalink to this definition">¶</a></dt> |
---|
3491 | <dd><p>Guarantees that the accumulation forecast step were set.</p> |
---|
3492 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3493 | <col class="field-name" /> |
---|
3494 | <col class="field-body" /> |
---|
3495 | <tbody valign="top"> |
---|
3496 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3497 | <li><strong>accmaxstep</strong> (<em>str</em>) – The maximum forecast step for the accumulated forecast fields.</li> |
---|
3498 | <li><strong>marsclass</strong> (<em>str</em>) – ECMWF data classification identifier.</li> |
---|
3499 | <li><strong>purefc</strong> (<em>int</em>) – Switch for definition of pure forecast mode or not.</li> |
---|
3500 | <li><strong>maxstep</strong> (<em>str</em>) – The maximum forecast time step in hours from the forecast base time. |
---|
3501 | This is the maximum step for non flux (accumulated) forecast data.</li> |
---|
3502 | </ul> |
---|
3503 | </td> |
---|
3504 | </tr> |
---|
3505 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>accmaxstep</strong> – The maximum forecast step for the accumulated forecast fields.</p> |
---|
3506 | </td> |
---|
3507 | </tr> |
---|
3508 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p> |
---|
3509 | </td> |
---|
3510 | </tr> |
---|
3511 | </tbody> |
---|
3512 | </table> |
---|
3513 | </dd></dl> |
---|
3514 | |
---|
3515 | <dl class="function"> |
---|
3516 | <dt id="checks.check_acctime"> |
---|
3517 | <code class="descclassname">checks.</code><code class="descname">check_acctime</code><span class="sig-paren">(</span><em>acctime</em>, <em>marsclass</em>, <em>purefc</em>, <em>time</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_acctime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_acctime" title="Permalink to this definition">¶</a></dt> |
---|
3518 | <dd><p>Guarantees that the accumulation forecast times were set.</p> |
---|
3519 | <p>If it is not set, it tries to set the value for some of the |
---|
3520 | most commonly used data sets. Otherwise it raises an error.</p> |
---|
3521 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3522 | <col class="field-name" /> |
---|
3523 | <col class="field-body" /> |
---|
3524 | <tbody valign="top"> |
---|
3525 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3526 | <li><strong>acctime</strong> (<em>str</em>) – The starting time from the accumulated forecasts.</li> |
---|
3527 | <li><strong>marsclass</strong> (<em>str</em>) – ECMWF data classification identifier.</li> |
---|
3528 | <li><strong>purefc</strong> (<em>int</em>) – Switch for definition of pure forecast mode or not.</li> |
---|
3529 | </ul> |
---|
3530 | </td> |
---|
3531 | </tr> |
---|
3532 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>acctime</strong> – The starting time from the accumulated forecasts.</p> |
---|
3533 | </td> |
---|
3534 | </tr> |
---|
3535 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p> |
---|
3536 | </td> |
---|
3537 | </tr> |
---|
3538 | </tbody> |
---|
3539 | </table> |
---|
3540 | </dd></dl> |
---|
3541 | |
---|
3542 | <dl class="function"> |
---|
3543 | <dt id="checks.check_acctype"> |
---|
3544 | <code class="descclassname">checks.</code><code class="descname">check_acctype</code><span class="sig-paren">(</span><em>acctype</em>, <em>ftype</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_acctype"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_acctype" title="Permalink to this definition">¶</a></dt> |
---|
3545 | <dd><p>Guarantees that the accumulation field type is set.</p> |
---|
3546 | <p>If not set, it is derivated as in the old method (TYPE[1]).</p> |
---|
3547 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3548 | <col class="field-name" /> |
---|
3549 | <col class="field-body" /> |
---|
3550 | <tbody valign="top"> |
---|
3551 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3552 | <li><strong>acctype</strong> (<em>str</em>) – The field type for the accumulated forecast fields.</li> |
---|
3553 | <li><strong>ftype</strong> (<em>list of str</em>) – List of field types.</li> |
---|
3554 | </ul> |
---|
3555 | </td> |
---|
3556 | </tr> |
---|
3557 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>acctype</strong> – The field type for the accumulated forecast fields.</p> |
---|
3558 | </td> |
---|
3559 | </tr> |
---|
3560 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p> |
---|
3561 | </td> |
---|
3562 | </tr> |
---|
3563 | </tbody> |
---|
3564 | </table> |
---|
3565 | </dd></dl> |
---|
3566 | |
---|
3567 | <dl class="function"> |
---|
3568 | <dt id="checks.check_addpar"> |
---|
3569 | <code class="descclassname">checks.</code><code class="descname">check_addpar</code><span class="sig-paren">(</span><em>addpar</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_addpar"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_addpar" title="Permalink to this definition">¶</a></dt> |
---|
3570 | <dd><p>Check that addpar has correct format of additional parameters in |
---|
3571 | a single string, so that it can be easily appended to the hard coded |
---|
3572 | parameters that are retrieved in any case.</p> |
---|
3573 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3574 | <col class="field-name" /> |
---|
3575 | <col class="field-body" /> |
---|
3576 | <tbody valign="top"> |
---|
3577 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>addpar</strong> (<em>str</em><em> or </em><em>list of str</em>) – List of additional parameters to be retrieved.</td> |
---|
3578 | </tr> |
---|
3579 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>addpar</strong> – List of additional parameters to be retrieved.</td> |
---|
3580 | </tr> |
---|
3581 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td> |
---|
3582 | </tr> |
---|
3583 | </tbody> |
---|
3584 | </table> |
---|
3585 | </dd></dl> |
---|
3586 | |
---|
3587 | <dl class="function"> |
---|
3588 | <dt id="checks.check_area"> |
---|
3589 | <code class="descclassname">checks.</code><code class="descname">check_area</code><span class="sig-paren">(</span><em>grid</em>, <em>area</em>, <em>upper</em>, <em>lower</em>, <em>left</em>, <em>right</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_area"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_area" title="Permalink to this definition">¶</a></dt> |
---|
3590 | <dd><p>Defines the correct area string.</p> |
---|
3591 | <p>Checks on the format of the four area components. Wether it is of |
---|
3592 | the order of 1000 or 1. Also checks wether area was already set by command |
---|
3593 | line, then the four components are overwritten. |
---|
3594 | Convert to correct format of the order of magnitude “1” and sets the |
---|
3595 | area parameter (North/West/South/East). |
---|
3596 | E.g.: -5./20./10./10.</p> |
---|
3597 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3598 | <col class="field-name" /> |
---|
3599 | <col class="field-body" /> |
---|
3600 | <tbody valign="top"> |
---|
3601 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3602 | <li><strong>grid</strong> (<em>str</em>) – Contains grid information.</li> |
---|
3603 | <li><strong>area</strong> (<em>str</em>) – Contains area informtion.</li> |
---|
3604 | <li><strong>upper</strong> (<em>str</em>) – The northern most latitude.</li> |
---|
3605 | <li><strong>lower</strong> (<em>str</em>) – The souther most latitude.</li> |
---|
3606 | <li><strong>left</strong> (<em>str</em>) – The western most longitude.</li> |
---|
3607 | <li><strong>right</strong> (<em>str</em>) – The eastern most longiude.</li> |
---|
3608 | </ul> |
---|
3609 | </td> |
---|
3610 | </tr> |
---|
3611 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>grid</strong> – Contains grid in format Lat/lon. E.g. 0.1/0.1</p> |
---|
3612 | </td> |
---|
3613 | </tr> |
---|
3614 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p> |
---|
3615 | </td> |
---|
3616 | </tr> |
---|
3617 | </tbody> |
---|
3618 | </table> |
---|
3619 | </dd></dl> |
---|
3620 | |
---|
3621 | <dl class="function"> |
---|
3622 | <dt id="checks.check_basetime"> |
---|
3623 | <code class="descclassname">checks.</code><code class="descname">check_basetime</code><span class="sig-paren">(</span><em>basetime</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_basetime"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_basetime" title="Permalink to this definition">¶</a></dt> |
---|
3624 | <dd><p>Check if basetime is set and contains one of the two |
---|
3625 | possible values (0, 12).</p> |
---|
3626 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3627 | <col class="field-name" /> |
---|
3628 | <col class="field-body" /> |
---|
3629 | <tbody valign="top"> |
---|
3630 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>basetime</strong> (<em>int</em><em> or </em><em>str</em><em> or </em><em>None</em>) – The time for a half day retrieval. The 12 hours upfront are to be |
---|
3631 | retrieved.</td> |
---|
3632 | </tr> |
---|
3633 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>basetime</strong> – The time for a half day retrieval. The 12 hours upfront are to be |
---|
3634 | retrieved.</td> |
---|
3635 | </tr> |
---|
3636 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">int or None</td> |
---|
3637 | </tr> |
---|
3638 | </tbody> |
---|
3639 | </table> |
---|
3640 | </dd></dl> |
---|
3641 | |
---|
3642 | <dl class="function"> |
---|
3643 | <dt id="checks.check_dates"> |
---|
3644 | <code class="descclassname">checks.</code><code class="descname">check_dates</code><span class="sig-paren">(</span><em>start</em>, <em>end</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_dates"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_dates" title="Permalink to this definition">¶</a></dt> |
---|
3645 | <dd><p>Checks if there is at least a start date for a one day retrieval.</p> |
---|
3646 | <p>Checks if end date lies after start date and end date is set.</p> |
---|
3647 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3648 | <col class="field-name" /> |
---|
3649 | <col class="field-body" /> |
---|
3650 | <tbody valign="top"> |
---|
3651 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3652 | <li><strong>start</strong> (<em>str</em>) – The start date of the retrieval job.</li> |
---|
3653 | <li><strong>end</strong> (<em>str</em>) – The end date of the retrieval job.</li> |
---|
3654 | </ul> |
---|
3655 | </td> |
---|
3656 | </tr> |
---|
3657 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><ul class="simple"> |
---|
3658 | <li><strong>start</strong> (<em>str</em>) – The start date of the retrieval job.</li> |
---|
3659 | <li><strong>end</strong> (<em>str</em>) – The end date of the retrieval job.</li> |
---|
3660 | </ul> |
---|
3661 | </p> |
---|
3662 | </td> |
---|
3663 | </tr> |
---|
3664 | </tbody> |
---|
3665 | </table> |
---|
3666 | </dd></dl> |
---|
3667 | |
---|
3668 | <dl class="function"> |
---|
3669 | <dt id="checks.check_grid"> |
---|
3670 | <code class="descclassname">checks.</code><code class="descname">check_grid</code><span class="sig-paren">(</span><em>grid</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_grid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_grid" title="Permalink to this definition">¶</a></dt> |
---|
3671 | <dd><p>Convert grid into correct Lat/Lon format. E.g. ‘0.5/0.5’</p> |
---|
3672 | <p>Checks on format of original grid. Wether it is in the order of 1000 or 1. |
---|
3673 | Convert to correct grid format and substitute into “Lat/Lon” format string.</p> |
---|
3674 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3675 | <col class="field-name" /> |
---|
3676 | <col class="field-body" /> |
---|
3677 | <tbody valign="top"> |
---|
3678 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>grid</strong> (<em>str</em>) – Contains grid information</td> |
---|
3679 | </tr> |
---|
3680 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>grid</strong> – Contains grid in format Lat/lon. E.g. 0.1/0.1</td> |
---|
3681 | </tr> |
---|
3682 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td> |
---|
3683 | </tr> |
---|
3684 | </tbody> |
---|
3685 | </table> |
---|
3686 | </dd></dl> |
---|
3687 | |
---|
3688 | <dl class="function"> |
---|
3689 | <dt id="checks.check_job_chunk"> |
---|
3690 | <code class="descclassname">checks.</code><code class="descname">check_job_chunk</code><span class="sig-paren">(</span><em>job_chunk</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_job_chunk"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_job_chunk" title="Permalink to this definition">¶</a></dt> |
---|
3691 | <dd><p>Checks that if job chunk is set, the number is positive and non zero.</p> |
---|
3692 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3693 | <col class="field-name" /> |
---|
3694 | <col class="field-body" /> |
---|
3695 | <tbody valign="top"> |
---|
3696 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>job_chunk</strong> (<em>int</em>) – The number of days for a single job script.</td> |
---|
3697 | </tr> |
---|
3698 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>job_chunk</strong> – The number of days for a single job script.</td> |
---|
3699 | </tr> |
---|
3700 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">int</td> |
---|
3701 | </tr> |
---|
3702 | </tbody> |
---|
3703 | </table> |
---|
3704 | </dd></dl> |
---|
3705 | |
---|
3706 | <dl class="function"> |
---|
3707 | <dt id="checks.check_len_type_time_step"> |
---|
3708 | <code class="descclassname">checks.</code><code class="descname">check_len_type_time_step</code><span class="sig-paren">(</span><em>ftype</em>, <em>ftime</em>, <em>steps</em>, <em>maxstep</em>, <em>purefc</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_len_type_time_step"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_len_type_time_step" title="Permalink to this definition">¶</a></dt> |
---|
3709 | <dd><p>Check if</p> |
---|
3710 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3711 | <col class="field-name" /> |
---|
3712 | <col class="field-body" /> |
---|
3713 | <tbody valign="top"> |
---|
3714 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3715 | <li><strong>ftype</strong> (<em>list of str</em>) – List of field types.</li> |
---|
3716 | <li><strong>ftime</strong> (<em>list of str</em><em> or </em><em>str</em>) – The time in hours of the field.</li> |
---|
3717 | <li><strong>steps</strong> (<em>str</em>) – Specifies the forecast time step from forecast base time. |
---|
3718 | Valid values are hours (HH) from forecast base time.</li> |
---|
3719 | <li><strong>maxstep</strong> (<em>int</em>) – The maximum forecast time step in hours from the forecast base time. |
---|
3720 | This is the maximum step for non flux (accumulated) forecast data.</li> |
---|
3721 | <li><strong>purefc</strong> (<em>int</em>) – Switch for definition of pure forecast mode or not.</li> |
---|
3722 | </ul> |
---|
3723 | </td> |
---|
3724 | </tr> |
---|
3725 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><ul class="simple"> |
---|
3726 | <li><strong>ftype</strong> (<em>list of str</em>) – List of field types.</li> |
---|
3727 | <li><strong>ftime</strong> (<em>list of str</em>) – The time in hours of the field.</li> |
---|
3728 | <li><strong>steps</strong> (<em>str</em>) – Specifies the forecast time step from forecast base time. |
---|
3729 | Valid values are hours (HH) from forecast base time.</li> |
---|
3730 | </ul> |
---|
3731 | </p> |
---|
3732 | </td> |
---|
3733 | </tr> |
---|
3734 | </tbody> |
---|
3735 | </table> |
---|
3736 | </dd></dl> |
---|
3737 | |
---|
3738 | <dl class="function"> |
---|
3739 | <dt id="checks.check_levels"> |
---|
3740 | <code class="descclassname">checks.</code><code class="descname">check_levels</code><span class="sig-paren">(</span><em>levelist</em>, <em>level</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_levels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_levels" title="Permalink to this definition">¶</a></dt> |
---|
3741 | <dd><p>Defines correct level list and guarantees that the maximum level is |
---|
3742 | one of the available maximum levels.</p> |
---|
3743 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3744 | <col class="field-name" /> |
---|
3745 | <col class="field-body" /> |
---|
3746 | <tbody valign="top"> |
---|
3747 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3748 | <li><strong>levelist</strong> (<em>str</em>) – Specifies the level list. |
---|
3749 | Examples: model level: 1/to/137, pressure levels: 500/to/1000</li> |
---|
3750 | <li><strong>level</strong> (<em>str</em>) – Specifies the maximum level.</li> |
---|
3751 | </ul> |
---|
3752 | </td> |
---|
3753 | </tr> |
---|
3754 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><ul class="simple"> |
---|
3755 | <li><strong>levelist</strong> (<em>str</em>) – Specifies the required levels. It has to have a valid |
---|
3756 | correspondence to the selected levtype. |
---|
3757 | Examples: model level: 1/to/137, pressure levels: 500/to/1000</li> |
---|
3758 | <li><strong>level</strong> (<em>str</em>) – Specifies the maximum level. It has to be one of the |
---|
3759 | available maximum level number as contained in the variable |
---|
3760 | MAX_LEVEL_LIST in “_config”. E.g. [16, 19, 31, 40, 50, 60, 62, 91, 137]</li> |
---|
3761 | </ul> |
---|
3762 | </p> |
---|
3763 | </td> |
---|
3764 | </tr> |
---|
3765 | </tbody> |
---|
3766 | </table> |
---|
3767 | </dd></dl> |
---|
3768 | |
---|
3769 | <dl class="function"> |
---|
3770 | <dt id="checks.check_logicals_type"> |
---|
3771 | <code class="descclassname">checks.</code><code class="descname">check_logicals_type</code><span class="sig-paren">(</span><em>c</em>, <em>logicals</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_logicals_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_logicals_type" title="Permalink to this definition">¶</a></dt> |
---|
3772 | <dd><p>Check that the logical variables have correct type integer.</p> |
---|
3773 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3774 | <col class="field-name" /> |
---|
3775 | <col class="field-body" /> |
---|
3776 | <tbody valign="top"> |
---|
3777 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
3778 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
3779 | command line.</li> |
---|
3780 | <li><strong>logicals</strong> (<em>list of</em><em> (</em><em>str</em><em> or </em><em>int</em><em>)</em>) – Names of the switches that are used to control the flow of the |
---|
3781 | program.</li> |
---|
3782 | </ul> |
---|
3783 | </td> |
---|
3784 | </tr> |
---|
3785 | </tbody> |
---|
3786 | </table> |
---|
3787 | </dd></dl> |
---|
3788 | |
---|
3789 | <dl class="function"> |
---|
3790 | <dt id="checks.check_mail"> |
---|
3791 | <code class="descclassname">checks.</code><code class="descname">check_mail</code><span class="sig-paren">(</span><em>mail</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_mail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_mail" title="Permalink to this definition">¶</a></dt> |
---|
3792 | <dd><p>Check the string of mail addresses, seperate them and convert to a list.</p> |
---|
3793 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3794 | <col class="field-name" /> |
---|
3795 | <col class="field-body" /> |
---|
3796 | <tbody valign="top"> |
---|
3797 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mail</strong> (<em>list of str</em><em> or </em><em>str</em>) – Contains email addresses for notifications. |
---|
3798 | It might also contain just the ecmwf user name which will trigger |
---|
3799 | mailing to the associated email address for this user.</td> |
---|
3800 | </tr> |
---|
3801 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>mail</strong> – Contains email addresses for notifications. |
---|
3802 | It might also contain just the ecmwf user name which will trigger |
---|
3803 | mailing to the associated email address for this user.</td> |
---|
3804 | </tr> |
---|
3805 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list of str</td> |
---|
3806 | </tr> |
---|
3807 | </tbody> |
---|
3808 | </table> |
---|
3809 | </dd></dl> |
---|
3810 | |
---|
3811 | <dl class="function"> |
---|
3812 | <dt id="checks.check_maxstep"> |
---|
3813 | <code class="descclassname">checks.</code><code class="descname">check_maxstep</code><span class="sig-paren">(</span><em>maxstep</em>, <em>steps</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_maxstep"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_maxstep" title="Permalink to this definition">¶</a></dt> |
---|
3814 | <dd><p>Convert maxstep into integer if it is already given. Otherwise, select |
---|
3815 | maxstep by going through the steps list.</p> |
---|
3816 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3817 | <col class="field-name" /> |
---|
3818 | <col class="field-body" /> |
---|
3819 | <tbody valign="top"> |
---|
3820 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3821 | <li><strong>maxstep</strong> (<em>str</em>) – The maximum forecast time step in hours from the forecast base time. |
---|
3822 | This is the maximum step for non flux (accumulated) forecast data.</li> |
---|
3823 | <li><strong>steps</strong> (<em>str</em>) – Specifies the forecast time step from forecast base time. |
---|
3824 | Valid values are hours (HH) from forecast base time.</li> |
---|
3825 | </ul> |
---|
3826 | </td> |
---|
3827 | </tr> |
---|
3828 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>maxstep</strong> – The maximum forecast time step in hours from the forecast base time. |
---|
3829 | This is the maximum step for non flux (accumulated) forecast data.</p> |
---|
3830 | </td> |
---|
3831 | </tr> |
---|
3832 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">int</p> |
---|
3833 | </td> |
---|
3834 | </tr> |
---|
3835 | </tbody> |
---|
3836 | </table> |
---|
3837 | </dd></dl> |
---|
3838 | |
---|
3839 | <dl class="function"> |
---|
3840 | <dt id="checks.check_number"> |
---|
3841 | <code class="descclassname">checks.</code><code class="descname">check_number</code><span class="sig-paren">(</span><em>number</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_number"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_number" title="Permalink to this definition">¶</a></dt> |
---|
3842 | <dd><p>Check for correct string format of ensemble member numbers.</p> |
---|
3843 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3844 | <col class="field-name" /> |
---|
3845 | <col class="field-body" /> |
---|
3846 | <tbody valign="top"> |
---|
3847 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>number</strong> (<em>str</em>) – List of ensemble member forecast runs.</td> |
---|
3848 | </tr> |
---|
3849 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>number</strong> – String with list of ensemble member forecast runs. E.g. ‘01/02/03/04’</td> |
---|
3850 | </tr> |
---|
3851 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td> |
---|
3852 | </tr> |
---|
3853 | </tbody> |
---|
3854 | </table> |
---|
3855 | </dd></dl> |
---|
3856 | |
---|
3857 | <dl class="function"> |
---|
3858 | <dt id="checks.check_pathes"> |
---|
3859 | <code class="descclassname">checks.</code><code class="descname">check_pathes</code><span class="sig-paren">(</span><em>idir</em>, <em>odir</em>, <em>fpdir</em>, <em>fedir</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_pathes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_pathes" title="Permalink to this definition">¶</a></dt> |
---|
3860 | <dd><p>Check if output and flexpart pathes are set.</p> |
---|
3861 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3862 | <col class="field-name" /> |
---|
3863 | <col class="field-body" /> |
---|
3864 | <tbody valign="top"> |
---|
3865 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
3866 | <li><strong>idir</strong> (<em>str</em>) – Path to the temporary directory for MARS retrieval data.</li> |
---|
3867 | <li><strong>odir</strong> (<em>str</em>) – Path to the final output directory where the FLEXPART input files |
---|
3868 | will be stored.</li> |
---|
3869 | <li><strong>fpdir</strong> (<em>str</em>) – Path to FLEXPART root directory.</li> |
---|
3870 | <li><strong>fedir</strong> (<em>str</em>) – Path to flex_extract root directory.</li> |
---|
3871 | </ul> |
---|
3872 | </td> |
---|
3873 | </tr> |
---|
3874 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><ul class="simple"> |
---|
3875 | <li><strong>odir</strong> (<em>str</em>) – Path to the final output directory where the FLEXPART input files |
---|
3876 | will be stored.</li> |
---|
3877 | <li><strong>fpdir</strong> (<em>str</em>) – Path to FLEXPART root directory.</li> |
---|
3878 | </ul> |
---|
3879 | </p> |
---|
3880 | </td> |
---|
3881 | </tr> |
---|
3882 | </tbody> |
---|
3883 | </table> |
---|
3884 | </dd></dl> |
---|
3885 | |
---|
3886 | <dl class="function"> |
---|
3887 | <dt id="checks.check_ppid"> |
---|
3888 | <code class="descclassname">checks.</code><code class="descname">check_ppid</code><span class="sig-paren">(</span><em>c</em>, <em>ppid</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_ppid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_ppid" title="Permalink to this definition">¶</a></dt> |
---|
3889 | <dd><p>Sets the current PPID.</p> |
---|
3890 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3891 | <col class="field-name" /> |
---|
3892 | <col class="field-body" /> |
---|
3893 | <tbody valign="top"> |
---|
3894 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
3895 | <li><strong>c</strong> (<a class="reference internal" href="#ControlFile.ControlFile" title="ControlFile.ControlFile"><em>ControlFile</em></a>) – Contains all the parameters of CONTROL file and |
---|
3896 | command line.</li> |
---|
3897 | <li><strong>ppid</strong> (<em>int</em><em> or </em><em>None</em>) – Contains the ppid number provided by the command line parameter |
---|
3898 | of is None otherwise.</li> |
---|
3899 | </ul> |
---|
3900 | </td> |
---|
3901 | </tr> |
---|
3902 | </tbody> |
---|
3903 | </table> |
---|
3904 | </dd></dl> |
---|
3905 | |
---|
3906 | <dl class="function"> |
---|
3907 | <dt id="checks.check_public"> |
---|
3908 | <code class="descclassname">checks.</code><code class="descname">check_public</code><span class="sig-paren">(</span><em>public</em>, <em>dataset</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_public"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_public" title="Permalink to this definition">¶</a></dt> |
---|
3909 | <dd><p>Check wether the dataset parameter is set for a |
---|
3910 | public data set retrieval.</p> |
---|
3911 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3912 | <col class="field-name" /> |
---|
3913 | <col class="field-body" /> |
---|
3914 | <tbody valign="top"> |
---|
3915 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
3916 | <li><strong>public</strong> (<em>int</em>) – Specifies if public data are to be retrieved or not.</li> |
---|
3917 | <li><strong>dataset</strong> (<em>str</em>) – Specific name which identifies the public dataset.</li> |
---|
3918 | </ul> |
---|
3919 | </td> |
---|
3920 | </tr> |
---|
3921 | </tbody> |
---|
3922 | </table> |
---|
3923 | </dd></dl> |
---|
3924 | |
---|
3925 | <dl class="function"> |
---|
3926 | <dt id="checks.check_purefc"> |
---|
3927 | <code class="descclassname">checks.</code><code class="descname">check_purefc</code><span class="sig-paren">(</span><em>ftype</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_purefc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_purefc" title="Permalink to this definition">¶</a></dt> |
---|
3928 | <dd><p>Check for a pure forecast mode.</p> |
---|
3929 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3930 | <col class="field-name" /> |
---|
3931 | <col class="field-body" /> |
---|
3932 | <tbody valign="top"> |
---|
3933 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ftype</strong> (<em>list of str</em>) – List of field types.</td> |
---|
3934 | </tr> |
---|
3935 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if pure forecasts are to be retrieved. False if there are |
---|
3936 | analysis fields in between.</td> |
---|
3937 | </tr> |
---|
3938 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">True or False</td> |
---|
3939 | </tr> |
---|
3940 | </tbody> |
---|
3941 | </table> |
---|
3942 | </dd></dl> |
---|
3943 | |
---|
3944 | <dl class="function"> |
---|
3945 | <dt id="checks.check_queue"> |
---|
3946 | <code class="descclassname">checks.</code><code class="descname">check_queue</code><span class="sig-paren">(</span><em>queue</em>, <em>gateway</em>, <em>destination</em>, <em>ecuid</em>, <em>ecgid</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_queue"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_queue" title="Permalink to this definition">¶</a></dt> |
---|
3947 | <dd><p>Check if the necessary ECMWF parameters are set if the queue is |
---|
3948 | one of the QUEUES_LIST (in _config).</p> |
---|
3949 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3950 | <col class="field-name" /> |
---|
3951 | <col class="field-body" /> |
---|
3952 | <tbody valign="top"> |
---|
3953 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
3954 | <li><strong>queue</strong> (<em>str</em>) – Name of the queue if submitted to the ECMWF servers. |
---|
3955 | Used to check if ecuid, ecgid, gateway and destination |
---|
3956 | are set correctly and are not empty.</li> |
---|
3957 | <li><strong>gateway</strong> (<em>str</em>) – The address of the gateway server.</li> |
---|
3958 | <li><strong>destination</strong> (<em>str</em>) – The name of the destination of the gateway server for data |
---|
3959 | transfer through ectrans. E.g. <a class="reference external" href="mailto:name%40genericSftp">name<span>@</span>genericSftp</a></li> |
---|
3960 | <li><strong>ecuid</strong> (<em>str</em>) – ECMWF user id.</li> |
---|
3961 | <li><strong>ecgid</strong> (<em>str</em>) – ECMWF group id.</li> |
---|
3962 | </ul> |
---|
3963 | </td> |
---|
3964 | </tr> |
---|
3965 | </tbody> |
---|
3966 | </table> |
---|
3967 | </dd></dl> |
---|
3968 | |
---|
3969 | <dl class="function"> |
---|
3970 | <dt id="checks.check_request"> |
---|
3971 | <code class="descclassname">checks.</code><code class="descname">check_request</code><span class="sig-paren">(</span><em>request</em>, <em>marsfile</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_request" title="Permalink to this definition">¶</a></dt> |
---|
3972 | <dd><p>Check if there is an old mars request file and remove it.</p> |
---|
3973 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3974 | <col class="field-name" /> |
---|
3975 | <col class="field-body" /> |
---|
3976 | <tbody valign="top"> |
---|
3977 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
---|
3978 | <li><strong>request</strong> (<em>int</em>) – Selects the mode of retrieval. |
---|
3979 | 0: Retrieves the data from ECMWF. |
---|
3980 | 1: Prints the mars requests to an output file. |
---|
3981 | 2: Retrieves the data and prints the mars request.</li> |
---|
3982 | <li><strong>marsfile</strong> (<em>str</em>) – Path to the mars request file.</li> |
---|
3983 | </ul> |
---|
3984 | </td> |
---|
3985 | </tr> |
---|
3986 | </tbody> |
---|
3987 | </table> |
---|
3988 | </dd></dl> |
---|
3989 | |
---|
3990 | <dl class="function"> |
---|
3991 | <dt id="checks.check_step"> |
---|
3992 | <code class="descclassname">checks.</code><code class="descname">check_step</code><span class="sig-paren">(</span><em>step</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_step"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_step" title="Permalink to this definition">¶</a></dt> |
---|
3993 | <dd><p>Checks on step format and convert into a list of steps.</p> |
---|
3994 | <p>If the steps were defined with “to” and “by” they are converted into |
---|
3995 | a list of steps. If the steps were set in a string, it is |
---|
3996 | converted into a list.</p> |
---|
3997 | <table class="docutils field-list" frame="void" rules="none"> |
---|
3998 | <col class="field-name" /> |
---|
3999 | <col class="field-body" /> |
---|
4000 | <tbody valign="top"> |
---|
4001 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>step</strong> (<em>list of str</em><em> or </em><em>str</em>) – Specifies the forecast time step from forecast base time. |
---|
4002 | Valid values are hours (HH) from forecast base time.</td> |
---|
4003 | </tr> |
---|
4004 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>step</strong> – List of forecast steps in format e.g. [001, 002, …]</td> |
---|
4005 | </tr> |
---|
4006 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list of str</td> |
---|
4007 | </tr> |
---|
4008 | </tbody> |
---|
4009 | </table> |
---|
4010 | </dd></dl> |
---|
4011 | |
---|
4012 | <dl class="function"> |
---|
4013 | <dt id="checks.check_time"> |
---|
4014 | <code class="descclassname">checks.</code><code class="descname">check_time</code><span class="sig-paren">(</span><em>ftime</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_time"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_time" title="Permalink to this definition">¶</a></dt> |
---|
4015 | <dd><p>Check if time variable is of type list. Otherwise convert to list.</p> |
---|
4016 | <table class="docutils field-list" frame="void" rules="none"> |
---|
4017 | <col class="field-name" /> |
---|
4018 | <col class="field-body" /> |
---|
4019 | <tbody valign="top"> |
---|
4020 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ftime</strong> (<em>list of str</em><em> or </em><em>str</em>) – The time in hours of the field.</td> |
---|
4021 | </tr> |
---|
4022 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>ftime</strong> – The time in hours of the field.</td> |
---|
4023 | </tr> |
---|
4024 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list of str</td> |
---|
4025 | </tr> |
---|
4026 | </tbody> |
---|
4027 | </table> |
---|
4028 | </dd></dl> |
---|
4029 | |
---|
4030 | <dl class="function"> |
---|
4031 | <dt id="checks.check_type"> |
---|
4032 | <code class="descclassname">checks.</code><code class="descname">check_type</code><span class="sig-paren">(</span><em>ftype</em>, <em>steps</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/checks.html#check_type"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#checks.check_type" title="Permalink to this definition">¶</a></dt> |
---|
4033 | <dd><p>Check if type variable is of type list and if analysis field has |
---|
4034 | forecast step 0.</p> |
---|
4035 | <table class="docutils field-list" frame="void" rules="none"> |
---|
4036 | <col class="field-name" /> |
---|
4037 | <col class="field-body" /> |
---|
4038 | <tbody valign="top"> |
---|
4039 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple"> |
---|
4040 | <li><strong>ftype</strong> (<em>list of str</em><em> or </em><em>str</em>) – List of field types.</li> |
---|
4041 | <li><strong>steps</strong> (<em>str</em>) – Specifies the forecast time step from forecast base time. |
---|
4042 | Valid values are hours (HH) from forecast base time.</li> |
---|
4043 | </ul> |
---|
4044 | </td> |
---|
4045 | </tr> |
---|
4046 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><strong>ftype</strong> – List of field types.</p> |
---|
4047 | </td> |
---|
4048 | </tr> |
---|
4049 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">list of str</p> |
---|
4050 | </td> |
---|
4051 | </tr> |
---|
4052 | </tbody> |
---|
4053 | </table> |
---|
4054 | </dd></dl> |
---|
4055 | |
---|
4056 | </div> |
---|
4057 | <div class="section" id="module-disaggregation"> |
---|
4058 | <span id="disaggregation"></span><h3><a class="toc-backref" href="#id17">disaggregation</a><a class="headerlink" href="#module-disaggregation" title="Permalink to this headline">¶</a></h3> |
---|
4059 | <p>Disaggregation of deaccumulated flux data from an ECMWF model FG field.</p> |
---|
4060 | <dl class="docutils"> |
---|
4061 | <dt>Initially the flux data to be concerned are:</dt> |
---|
4062 | <dd><ul class="first last simple"> |
---|
4063 | <li>large-scale precipitation</li> |
---|
4064 | <li>convective precipitation</li> |
---|
4065 | <li>surface sensible heat flux</li> |
---|
4066 | <li>surface solar radiation</li> |
---|
4067 | <li>u stress</li> |
---|
4068 | <li>v stress</li> |
---|
4069 | </ul> |
---|
4070 | </dd> |
---|
4071 | </dl> |
---|
4072 | <p>Different versions of disaggregation is provided for rainfall |
---|
4073 | data (darain, modified linear) and the surface fluxes and |
---|
4074 | stress data (dapoly, cubic polynomial).</p> |
---|
4075 | <dl class="function"> |
---|
4076 | <dt id="disaggregation.IA3"> |
---|
4077 | <code class="descclassname">disaggregation.</code><code class="descname">IA3</code><span class="sig-paren">(</span><em>g</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/disaggregation.html#IA3"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#disaggregation.IA3" title="Permalink to this definition">¶</a></dt> |
---|
4078 | <dd><p>Interpolation with a non-negative geometric mean based algorithm.</p> |
---|
4079 | <p>The original grid is reconstructed by adding two sampling points in each |
---|
4080 | data series interval. This subgrid is used to keep all information during |
---|
4081 | the interpolation within the associated interval. Additionally, an advanced |
---|
4082 | monotonicity filter is applied to improve the monotonicity properties of |
---|
4083 | the series.</p> |
---|
4084 | <div class="admonition note"> |
---|
4085 | <p class="first admonition-title">Note</p> |
---|
4086 | <p>(C) Copyright 2017-2019 |
---|
4087 | Sabine Hittmeir, Anne Philipp, Petra Seibert</p> |
---|
4088 | <p class="last">This work is licensed under the Creative Commons Attribution 4.0 |
---|
4089 | International License. To view a copy of this license, visit |
---|
4090 | <a class="reference external" href="http://creativecommons.org/licenses/by/4.0/">http://creativecommons.org/licenses/by/4.0/</a> or send a letter to |
---|
4091 | Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</p> |
---|
4092 | </div> |
---|
4093 | <table class="docutils field-list" frame="void" rules="none"> |
---|
4094 | <col class="field-name" /> |
---|
4095 | <col class="field-body" /> |
---|
4096 | <tbody valign="top"> |
---|
4097 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>g</strong> (<em>list of float</em>) – Complete data series that will be interpolated having |
---|
4098 | the dimension of the original raw series.</td> |
---|
4099 | </tr> |
---|
4100 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>f</strong> – The interpolated data series with additional subgrid points. |
---|
4101 | Its dimension is equal to the length of the input data series |
---|
4102 | times three.</td> |
---|
4103 | </tr> |
---|
4104 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list of float</td> |
---|
4105 | </tr> |
---|
4106 | </tbody> |
---|
4107 | </table> |
---|
4108 | <p class="rubric">References</p> |
---|
4109 | <p>For more information see article: |
---|
4110 | Hittmeir, S.; Philipp, A.; Seibert, P. (2017): A conservative |
---|
4111 | interpolation scheme for extensive quantities with application to the |
---|
4112 | Lagrangian particle dispersion model FLEXPART., |
---|
4113 | Geoscientific Model Development</p> |
---|
4114 | </dd></dl> |
---|
4115 | |
---|
4116 | <dl class="function"> |
---|
4117 | <dt id="disaggregation.dapoly"> |
---|
4118 | <code class="descclassname">disaggregation.</code><code class="descname">dapoly</code><span class="sig-paren">(</span><em>alist</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/disaggregation.html#dapoly"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#disaggregation.dapoly" title="Permalink to this definition">¶</a></dt> |
---|
4119 | <dd><p>Cubic polynomial interpolation of deaccumulated fluxes.</p> |
---|
4120 | <p>Interpolation of deaccumulated fluxes of an ECMWF model FG field |
---|
4121 | using a cubic polynomial solution which conserves the integrals |
---|
4122 | of the fluxes within each timespan. |
---|
4123 | Disaggregation is done for 4 accumluated timespans which |
---|
4124 | generates a new, disaggregated value which is output at the |
---|
4125 | central point of the 4 accumulation timespans. |
---|
4126 | This new point is used for linear interpolation of the complete |
---|
4127 | timeseries afterwards.</p> |
---|
4128 | <table class="docutils field-list" frame="void" rules="none"> |
---|
4129 | <col class="field-name" /> |
---|
4130 | <col class="field-body" /> |
---|
4131 | <tbody valign="top"> |
---|
4132 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>alist</strong> (<em>list of array of float</em>) – List of 4 timespans as 2-dimensional, horizontal fields. |
---|
4133 | E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</td> |
---|
4134 | </tr> |
---|
4135 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>nfield</strong> – Interpolated flux at central point of accumulation timespan.</td> |
---|
4136 | </tr> |
---|
4137 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">array of float</td> |
---|
4138 | </tr> |
---|
4139 | </tbody> |
---|
4140 | </table> |
---|
4141 | <div class="admonition note"> |
---|
4142 | <p class="first admonition-title">Note</p> |
---|
4143 | <dl class="last docutils"> |
---|
4144 | <dt>March 2000 <span class="classifier-delimiter">:</span> <span class="classifier">P. JAMES</span></dt> |
---|
4145 | <dd>Original author</dd> |
---|
4146 | <dt>June 2003 <span class="classifier-delimiter">:</span> <span class="classifier">A. BECK</span></dt> |
---|
4147 | <dd>Adaptations</dd> |
---|
4148 | <dt>November 2015 <span class="classifier-delimiter">:</span> <span class="classifier">Leopold Haimberger (University of Vienna)</span></dt> |
---|
4149 | <dd>Migration from Fortran to Python</dd> |
---|
4150 | </dl> |
---|
4151 | </div> |
---|
4152 | </dd></dl> |
---|
4153 | |
---|
4154 | <dl class="function"> |
---|
4155 | <dt id="disaggregation.darain"> |
---|
4156 | <code class="descclassname">disaggregation.</code><code class="descname">darain</code><span class="sig-paren">(</span><em>alist</em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/disaggregation.html#darain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#disaggregation.darain" title="Permalink to this definition">¶</a></dt> |
---|
4157 | <dd><p>Linear interpolation of deaccumulated fluxes.</p> |
---|
4158 | <p>Interpolation of deaccumulated fluxes of an ECMWF model FG rainfall |
---|
4159 | field using a modified linear solution which conserves the integrals |
---|
4160 | of the fluxes within each timespan. |
---|
4161 | Disaggregation is done for 4 accumluated timespans which generates |
---|
4162 | a new, disaggregated value which is output at the central point |
---|
4163 | of the 4 accumulation timespans. This new point is used for linear |
---|
4164 | interpolation of the complete timeseries afterwards.</p> |
---|
4165 | <table class="docutils field-list" frame="void" rules="none"> |
---|
4166 | <col class="field-name" /> |
---|
4167 | <col class="field-body" /> |
---|
4168 | <tbody valign="top"> |
---|
4169 | <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>alist</strong> (<em>list of array of float</em>) – List of 4 timespans as 2-dimensional, horizontal fields. |
---|
4170 | E.g. [[array_t1], [array_t2], [array_t3], [array_t4]]</td> |
---|
4171 | </tr> |
---|
4172 | <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><strong>nfield</strong> – Interpolated flux at central point of accumulation timespan.</td> |
---|
4173 | </tr> |
---|
4174 | <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">array of float</td> |
---|
4175 | </tr> |
---|
4176 | </tbody> |
---|
4177 | </table> |
---|
4178 | <div class="admonition note"> |
---|
4179 | <p class="first admonition-title">Note</p> |
---|
4180 | <dl class="last docutils"> |
---|
4181 | <dt>March 2000 <span class="classifier-delimiter">:</span> <span class="classifier">P. JAMES</span></dt> |
---|
4182 | <dd>Original author</dd> |
---|
4183 | <dt>June 2003 <span class="classifier-delimiter">:</span> <span class="classifier">A. BECK</span></dt> |
---|
4184 | <dd>Adaptations</dd> |
---|
4185 | <dt>November 2015 <span class="classifier-delimiter">:</span> <span class="classifier">Leopold Haimberger (University of Vienna)</span></dt> |
---|
4186 | <dd>Migration from Fortran to Python</dd> |
---|
4187 | </dl> |
---|
4188 | </div> |
---|
4189 | </dd></dl> |
---|
4190 | |
---|
4191 | <div class="toctree-wrapper compound"> |
---|
4192 | </div> |
---|
4193 | </div> |
---|
4194 | </div> |
---|
4195 | </div> |
---|
4196 | |
---|
4197 | |
---|
4198 | </div> |
---|
4199 | |
---|
4200 | </div> |
---|
4201 | <footer> |
---|
4202 | |
---|
4203 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
---|
4204 | |
---|
4205 | <a href="api_fortran.html" class="btn btn-neutral float-right" title="Fortran’s Auto Generated Documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
---|
4206 | |
---|
4207 | |
---|
4208 | <a href="../api.html" class="btn btn-neutral float-left" title="Auto Generated Documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
---|
4209 | |
---|
4210 | </div> |
---|
4211 | |
---|
4212 | |
---|
4213 | <hr/> |
---|
4214 | |
---|
4215 | <div role="contentinfo"> |
---|
4216 | <p> |
---|
4217 | © Copyright 2019, Anne Philipp and Leopold Haimberger |
---|
4218 | |
---|
4219 | </p> |
---|
4220 | </div> |
---|
4221 | 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>. |
---|
4222 | |
---|
4223 | </footer> |
---|
4224 | |
---|
4225 | </div> |
---|
4226 | </div> |
---|
4227 | |
---|
4228 | </section> |
---|
4229 | |
---|
4230 | </div> |
---|
4231 | |
---|
4232 | |
---|
4233 | |
---|
4234 | <script type="text/javascript"> |
---|
4235 | jQuery(function () { |
---|
4236 | SphinxRtdTheme.Navigation.enable(true); |
---|
4237 | }); |
---|
4238 | </script> |
---|
4239 | |
---|
4240 | |
---|
4241 | |
---|
4242 | |
---|
4243 | |
---|
4244 | |
---|
4245 | </body> |
---|
4246 | </html> |
---|