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

ctbtodev
Last change on this file since 274f9ef was 274f9ef, checked in by Anne Philipp <anne.philipp@…>, 5 years ago

Converted docstrings to numpy style and build first structure for sphinxdocumentation (incl API)

  • Property mode set to 100644
File size: 31.3 KB
Line 
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7  <meta charset="utf-8">
8 
9  <meta name="viewport" content="width=device-width, initial-scale=1.0">
10 
11  <title>get_mars_data &mdash; flex_extract 7.1 alpha documentation</title>
12 
13
14 
15 
16 
17 
18
19 
20
21 
22 
23   
24
25 
26
27  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
28  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
29    <link rel="index" title="Index" href="../genindex.html" />
30    <link rel="search" title="Search" href="../search.html" /> 
31
32 
33  <script src="../_static/js/modernizr.min.js"></script>
34
35</head>
36
37<body class="wy-body-for-nav">
38
39   
40  <div class="wy-grid-for-nav">
41
42   
43    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
44      <div class="wy-side-scroll">
45        <div class="wy-side-nav-search">
46         
47
48         
49            <a href="../index.html" class="icon icon-home"> flex_extract
50         
51
52         
53          </a>
54
55         
56           
57           
58              <div class="version">
59                7.1
60              </div>
61           
62         
63
64         
65<div role="search">
66  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
67    <input type="text" name="q" placeholder="Search docs" />
68    <input type="hidden" name="check_keywords" value="yes" />
69    <input type="hidden" name="area" value="default" />
70  </form>
71</div>
72
73         
74        </div>
75
76        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
77         
78           
79           
80             
81           
82           
83              <p class="caption"><span class="caption-text">Table of Contents:</span></p>
84<ul>
85<li class="toctree-l1"><a class="reference internal" href="../downloads.html">Downloads</a></li>
86<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
87<li class="toctree-l1"><a class="reference internal" href="../program_structure.html">Program Structure</a></li>
88<li class="toctree-l1"><a class="reference internal" href="../user_guide.html">User Guide</a></li>
89<li class="toctree-l1"><a class="reference internal" href="../api.html">Auto Generated Documentation</a></li>
90<li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li>
91</ul>
92
93           
94         
95        </div>
96      </div>
97    </nav>
98
99    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
100
101     
102      <nav class="wy-nav-top" aria-label="top navigation">
103       
104          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
105          <a href="../index.html">flex_extract</a>
106       
107      </nav>
108
109
110      <div class="wy-nav-content">
111       
112        <div class="rst-content">
113       
114         
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130<div role="navigation" aria-label="breadcrumbs navigation">
131
132  <ul class="wy-breadcrumbs">
133   
134      <li><a href="../index.html">Docs</a> &raquo;</li>
135       
136          <li><a href="index.html">Module code</a> &raquo;</li>
137       
138      <li>get_mars_data</li>
139   
140   
141      <li class="wy-breadcrumbs-aside">
142       
143      </li>
144   
145  </ul>
146
147 
148  <hr/>
149</div>
150          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
151           <div itemprop="articleBody">
152           
153  <h1>Source code for get_mars_data</h1><div class="highlight"><pre>
154<span></span><span class="ch">#!/usr/bin/env python</span>
155<span class="c1"># -*- coding: utf-8 -*-</span>
156<span class="c1">#*******************************************************************************</span>
157<span class="c1"># @Author: Anne Fouilloux (University of Oslo)</span>
158<span class="c1">#</span>
159<span class="c1"># @Date: October 2014</span>
160<span class="c1">#</span>
161<span class="c1"># @Change History:</span>
162<span class="c1">#</span>
163<span class="c1">#    November 2015 - Leopold Haimberger (University of Vienna):</span>
164<span class="c1">#        - moved the getEIdata program into a function &quot;get_mars_data&quot;</span>
165<span class="c1">#        - moved the AgurmentParser into a seperate function</span>
166<span class="c1">#        - adatpted the function for the use in flex_extract</span>
167<span class="c1">#        - renamed file to get_mars_data</span>
168<span class="c1">#</span>
169<span class="c1">#    February 2018 - Anne Philipp (University of Vienna):</span>
170<span class="c1">#        - applied PEP8 style guide</span>
171<span class="c1">#        - added structured documentation</span>
172<span class="c1">#        - minor changes in programming style for consistence</span>
173<span class="c1">#        - added function main and moved function calls vom __main__ there</span>
174<span class="c1">#          (necessary for better documentation with docstrings for later</span>
175<span class="c1">#          online documentation)</span>
176<span class="c1">#        - use of UIFiles class for file selection and deletion</span>
177<span class="c1">#</span>
178<span class="c1">#</span>
179<span class="c1"># @License:</span>
180<span class="c1">#    (C) Copyright 2014-2018.</span>
181<span class="c1">#</span>
182<span class="c1">#    This software is licensed under the terms of the Apache Licence Version 2.0</span>
183<span class="c1">#    which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.</span>
184<span class="c1">#</span>
185<span class="c1"># @Program Functionality:</span>
186<span class="c1">#    This program can be used as a module in the whole flex_extract process</span>
187<span class="c1">#    or can be run by itself to just extract MARS data from ECMWF. To do so,</span>
188<span class="c1">#    a couple of necessary parameters has to be passed with the program call.</span>
189<span class="c1">#    See documentation for more details.</span>
190<span class="c1">#</span>
191<span class="c1"># @Program Content:</span>
192<span class="c1">#    - main</span>
193<span class="c1">#    - get_mars_data</span>
194<span class="c1">#    - do_retrievement</span>
195<span class="c1">#</span>
196<span class="c1">#*******************************************************************************</span>
197
198<span class="c1"># ------------------------------------------------------------------------------</span>
199<span class="c1"># MODULES</span>
200<span class="c1"># ------------------------------------------------------------------------------</span>
201<span class="kn">import</span> <span class="nn">os</span>
202<span class="kn">import</span> <span class="nn">sys</span>
203<span class="kn">import</span> <span class="nn">inspect</span>
204<span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timedelta</span>
205
206<span class="c1"># software specific classes and modules from flex_extract</span>
207<span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span>
208    <span class="n">inspect</span><span class="o">.</span><span class="n">getfile</span><span class="p">(</span><span class="n">inspect</span><span class="o">.</span><span class="n">currentframe</span><span class="p">())))</span> <span class="o">+</span> <span class="s1">&#39;/../&#39;</span><span class="p">)</span>
209<span class="kn">import</span> <span class="nn">_config</span>
210<span class="kn">from</span> <span class="nn">tools</span> <span class="k">import</span> <span class="p">(</span><span class="n">my_error</span><span class="p">,</span> <span class="n">normal_exit</span><span class="p">,</span> <span class="n">get_cmdline_arguments</span><span class="p">,</span>
211                   <span class="n">read_ecenv</span><span class="p">,</span> <span class="n">make_dir</span><span class="p">)</span>
212<span class="kn">from</span> <span class="nn">classes.EcFlexpart</span> <span class="k">import</span> <span class="n">EcFlexpart</span>
213<span class="kn">from</span> <span class="nn">classes.UioFiles</span> <span class="k">import</span> <span class="n">UioFiles</span>
214
215<span class="k">try</span><span class="p">:</span>
216    <span class="n">ecapi</span> <span class="o">=</span> <span class="kc">True</span>
217    <span class="kn">import</span> <span class="nn">ecmwfapi</span>
218<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
219    <span class="n">ecapi</span> <span class="o">=</span> <span class="kc">False</span>
220<span class="c1"># ------------------------------------------------------------------------------</span>
221<span class="c1"># FUNCTION</span>
222<span class="c1"># ------------------------------------------------------------------------------</span>
223<div class="viewcode-block" id="main"><a class="viewcode-back" href="../api.html#get_mars_data.main">[docs]</a><span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
224    <span class="sd">&#39;&#39;&#39;Controls the program to get data out of mars.</span>
225
226<span class="sd">    This is done if it is called directly from command line.</span>
227<span class="sd">    Then it also takes program call arguments and control file input.</span>
228
229<span class="sd">    Parameters</span>
230<span class="sd">    ----------</span>
231
232<span class="sd">    Return</span>
233<span class="sd">    ------</span>
234
235<span class="sd">    &#39;&#39;&#39;</span>
236
237    <span class="n">args</span> <span class="o">=</span> <span class="n">get_cmdline_arguments</span><span class="p">()</span>
238    <span class="n">c</span> <span class="o">=</span> <span class="n">ControlFile</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">controlfile</span><span class="p">)</span>
239
240    <span class="n">env_parameter</span> <span class="o">=</span> <span class="n">read_ecenv</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">PATH_ECMWF_ENV</span><span class="p">)</span>
241    <span class="n">c</span><span class="o">.</span><span class="n">assign_args_to_control</span><span class="p">(</span><span class="n">args</span><span class="p">)</span>
242    <span class="n">c</span><span class="o">.</span><span class="n">assign_envs_to_control</span><span class="p">(</span><span class="n">env_parameter</span><span class="p">)</span>
243    <span class="n">c</span><span class="o">.</span><span class="n">check_conditions</span><span class="p">(</span><span class="n">args</span><span class="o">.</span><span class="n">queue</span><span class="p">)</span>
244
245    <span class="n">get_mars_data</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
246    <span class="n">normal_exit</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">mailfail</span><span class="p">,</span> <span class="s1">&#39;Done!&#39;</span><span class="p">)</span>
247
248    <span class="k">return</span></div>
249
250<div class="viewcode-block" id="get_mars_data"><a class="viewcode-back" href="../api.html#get_mars_data.get_mars_data">[docs]</a><span class="k">def</span> <span class="nf">get_mars_data</span><span class="p">(</span><span class="n">c</span><span class="p">):</span>
251    <span class="sd">&#39;&#39;&#39;Retrieves the EC data needed for a FLEXPART simulation.</span>
252
253<span class="sd">    Start and end dates for retrieval period is set. Retrievals</span>
254<span class="sd">    are divided into smaller periods if necessary and datechunk parameter</span>
255<span class="sd">    is set.</span>
256
257<span class="sd">    Parameters</span>
258<span class="sd">    ----------</span>
259<span class="sd">    c : :obj:`ControlFile`</span>
260<span class="sd">        Contains all the parameters of CONTROL file and</span>
261<span class="sd">        command line.</span>
262
263<span class="sd">    Return</span>
264<span class="sd">    ------</span>
265
266<span class="sd">    &#39;&#39;&#39;</span>
267
268    <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">inputdir</span><span class="p">):</span>
269        <span class="n">make_dir</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">inputdir</span><span class="p">)</span>
270
271    <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">request</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">c</span><span class="o">.</span><span class="n">request</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
272        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Retrieving EC data!&quot;</span><span class="p">)</span>
273    <span class="k">elif</span> <span class="n">c</span><span class="o">.</span><span class="n">request</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
274        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Printing mars requests!&quot;</span><span class="p">)</span>
275
276    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;start date </span><span class="si">%s</span><span class="s2"> &quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">start_date</span><span class="p">))</span>
277    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;end date </span><span class="si">%s</span><span class="s2"> &quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">end_date</span><span class="p">))</span>
278
279    <span class="k">if</span> <span class="n">ecapi</span><span class="p">:</span>
280        <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">public</span><span class="p">:</span>
281            <span class="n">server</span> <span class="o">=</span> <span class="n">ecmwfapi</span><span class="o">.</span><span class="n">ECMWFDataServer</span><span class="p">()</span>
282        <span class="k">else</span><span class="p">:</span>
283            <span class="n">server</span> <span class="o">=</span> <span class="n">ecmwfapi</span><span class="o">.</span><span class="n">ECMWFService</span><span class="p">(</span><span class="s2">&quot;mars&quot;</span><span class="p">)</span>
284    <span class="k">else</span><span class="p">:</span>
285        <span class="n">server</span> <span class="o">=</span> <span class="kc">False</span>
286
287    <span class="n">c</span><span class="o">.</span><span class="n">ecapi</span> <span class="o">=</span> <span class="n">ecapi</span>
288    <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Using ECMWF WebAPI: &#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">ecapi</span><span class="p">))</span>
289
290    <span class="c1"># basetime geht rückwärts</span>
291
292    <span class="c1"># if basetime 00</span>
293    <span class="c1"># dann wird von 12 am vortag bis 00 am start tag geholt</span>
294    <span class="c1"># aber ohne 12 selbst sondern 12 + step</span>
295
296    <span class="c1"># if basetime 12</span>
297    <span class="c1"># dann wird von 00 + step bis 12 am start tag geholt</span>
298
299    <span class="c1"># purer forecast wird vorwärts bestimmt.</span>
300    <span class="c1"># purer forecast mode ist dann wenn  größer 24 stunden</span>
301    <span class="c1"># wie kann das noch festgestellt werden ????</span>
302    <span class="c1"># nur FC und steps mehr als 24 ?</span>
303    <span class="c1"># die einzige problematik beim reinen forecast ist die benennung der files!</span>
304    <span class="c1"># also sobald es Tagesüberschneidungen gibt</span>
305    <span class="c1"># allerdings ist das relevant und ersichtlich an den NICHT FLUSS DATEN</span>
306
307    <span class="n">start</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">start_date</span><span class="p">,</span> <span class="s1">&#39;%Y%m</span><span class="si">%d</span><span class="s1">&#39;</span><span class="p">)</span>
308    <span class="n">end</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">strptime</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">end_date</span><span class="p">,</span> <span class="s1">&#39;%Y%m</span><span class="si">%d</span><span class="s1">&#39;</span><span class="p">)</span>
309    <span class="c1"># time period for one single retrieval</span>
310    <span class="n">datechunk</span> <span class="o">=</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">date_chunk</span><span class="p">))</span>
311
312    <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">basetime</span> <span class="o">==</span> <span class="s1">&#39;00&#39;</span><span class="p">:</span>
313        <span class="n">start</span> <span class="o">=</span> <span class="n">start</span> <span class="o">-</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
314
315    <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">maxstep</span> <span class="o">&lt;=</span> <span class="mi">24</span><span class="p">:</span>
316        <span class="n">startm1</span> <span class="o">=</span> <span class="n">start</span> <span class="o">-</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
317
318    <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">basetime</span> <span class="o">==</span> <span class="s1">&#39;00&#39;</span> <span class="ow">or</span> <span class="n">c</span><span class="o">.</span><span class="n">basetime</span> <span class="o">==</span> <span class="s1">&#39;12&#39;</span><span class="p">:</span>
319        <span class="c1"># endp1 = end + timedelta(days=1)</span>
320        <span class="n">endp1</span> <span class="o">=</span> <span class="n">end</span>
321    <span class="k">else</span><span class="p">:</span>
322        <span class="c1"># endp1 = end + timedelta(days=2)</span>
323        <span class="n">endp1</span> <span class="o">=</span> <span class="n">end</span> <span class="o">+</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
324
325    <span class="c1"># --------------  flux data ------------------------------------------------</span>
326    <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">request</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">c</span><span class="o">.</span><span class="n">request</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
327        <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;... removing old flux content of &#39;</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">inputdir</span><span class="p">)</span>
328        <span class="n">tobecleaned</span> <span class="o">=</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">inputdir</span><span class="p">,</span>
329                               <span class="s1">&#39;*_acc_*.&#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getppid</span><span class="p">())</span> <span class="o">+</span> <span class="s1">&#39;.*.grb&#39;</span><span class="p">)</span>
330        <span class="n">tobecleaned</span><span class="o">.</span><span class="n">delete_files</span><span class="p">()</span>
331
332    <span class="c1"># if forecast for maximum one day (upto 24h) are to be retrieved,</span>
333    <span class="c1"># collect accumulation data (flux data)</span>
334    <span class="c1"># with additional days in the beginning and at the end</span>
335    <span class="c1"># (used for complete disaggregation of original period)</span>
336    <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">maxstep</span> <span class="o">&lt;=</span> <span class="mi">24</span><span class="p">:</span>
337        <span class="n">do_retrievement</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">startm1</span><span class="p">,</span> <span class="n">endp1</span><span class="p">,</span> <span class="n">datechunk</span><span class="p">,</span> <span class="n">fluxes</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
338
339    <span class="c1"># if forecast data longer than 24h are to be retrieved,</span>
340    <span class="c1"># collect accumulation data (flux data)</span>
341    <span class="c1"># with the exact start and end date</span>
342    <span class="c1"># (disaggregation will be done for the</span>
343    <span class="c1"># exact time period with boundary conditions)</span>
344    <span class="k">else</span><span class="p">:</span>
345        <span class="n">do_retrievement</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">,</span> <span class="n">datechunk</span><span class="p">,</span> <span class="n">fluxes</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
346
347    <span class="c1"># --------------  non flux data --------------------------------------------</span>
348    <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">request</span> <span class="o">==</span> <span class="mi">0</span> <span class="ow">or</span> <span class="n">c</span><span class="o">.</span><span class="n">request</span> <span class="o">==</span> <span class="mi">2</span><span class="p">:</span>
349        <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;... removing old non flux content of &#39;</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">inputdir</span><span class="p">)</span>
350        <span class="n">tobecleaned</span> <span class="o">=</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">inputdir</span><span class="p">,</span>
351                               <span class="s1">&#39;*__*.&#39;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">getppid</span><span class="p">())</span> <span class="o">+</span> <span class="s1">&#39;.*.grb&#39;</span><span class="p">)</span>
352        <span class="n">tobecleaned</span><span class="o">.</span><span class="n">delete_files</span><span class="p">()</span>
353
354    <span class="n">do_retrievement</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">,</span> <span class="n">datechunk</span><span class="p">,</span> <span class="n">fluxes</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
355
356    <span class="k">return</span></div>
357
358<div class="viewcode-block" id="do_retrievement"><a class="viewcode-back" href="../api.html#get_mars_data.do_retrievement">[docs]</a><span class="k">def</span> <span class="nf">do_retrievement</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">,</span> <span class="n">delta_t</span><span class="p">,</span> <span class="n">fluxes</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
359    <span class="sd">&#39;&#39;&#39;Divides the complete retrieval period in smaller chunks and</span>
360<span class="sd">    retrieves the data from MARS.</span>
361
362<span class="sd">    Parameters</span>
363<span class="sd">    ----------</span>
364<span class="sd">    c : :obj:`ControlFile`</span>
365<span class="sd">        Contains all the parameters of CONTROL file and</span>
366<span class="sd">        command line.</span>
367
368<span class="sd">    server : :obj:`ECMWFService`</span>
369<span class="sd">            The server connection to ECMWF.</span>
370
371<span class="sd">    start : :obj:`datetime`</span>
372<span class="sd">        The start date of the retrieval.</span>
373
374<span class="sd">    end : :obj:`datetime`</span>
375<span class="sd">        The end date of the retrieval.</span>
376
377<span class="sd">    delta_t : :obj:`datetime`</span>
378<span class="sd">        Delta_t + 1 is the maximal time period of a single</span>
379<span class="sd">        retrieval.</span>
380
381<span class="sd">    fluxes : :obj:`boolean`, optional</span>
382<span class="sd">        Decides if the flux parameters are to be retrieved or</span>
383<span class="sd">        the rest of the parameter list.</span>
384<span class="sd">        Default value is False.</span>
385
386<span class="sd">    Return</span>
387<span class="sd">    ------</span>
388
389<span class="sd">    &#39;&#39;&#39;</span>
390
391    <span class="c1"># since actual day also counts as one day,</span>
392    <span class="c1"># we only need to add datechunk - 1 days to retrieval</span>
393    <span class="c1"># for a period</span>
394    <span class="n">delta_t_m1</span> <span class="o">=</span> <span class="n">delta_t</span> <span class="o">-</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
395
396    <span class="n">day</span> <span class="o">=</span> <span class="n">start</span>
397    <span class="k">while</span> <span class="n">day</span> <span class="o">&lt;=</span> <span class="n">end</span><span class="p">:</span>
398        <span class="n">flexpart</span> <span class="o">=</span> <span class="n">EcFlexpart</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">fluxes</span><span class="p">)</span>
399        <span class="n">tmpday</span> <span class="o">=</span> <span class="n">day</span> <span class="o">+</span> <span class="n">delta_t_m1</span>
400        <span class="k">if</span> <span class="n">tmpday</span> <span class="o">&lt;</span> <span class="n">end</span><span class="p">:</span>
401            <span class="n">dates</span> <span class="o">=</span> <span class="n">day</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%Y%m</span><span class="si">%d</span><span class="s2">&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;/to/&quot;</span> <span class="o">+</span> \
402                    <span class="n">tmpday</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%Y%m</span><span class="si">%d</span><span class="s2">&quot;</span><span class="p">)</span>
403        <span class="k">else</span><span class="p">:</span>
404            <span class="n">dates</span> <span class="o">=</span> <span class="n">day</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%Y%m</span><span class="si">%d</span><span class="s2">&quot;</span><span class="p">)</span> <span class="o">+</span> <span class="s2">&quot;/to/&quot;</span> <span class="o">+</span> \
405                    <span class="n">end</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%Y%m</span><span class="si">%d</span><span class="s2">&quot;</span><span class="p">)</span>
406
407        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;... retrieve &quot;</span> <span class="o">+</span> <span class="n">dates</span> <span class="o">+</span> <span class="s2">&quot; in dir &quot;</span> <span class="o">+</span> <span class="n">c</span><span class="o">.</span><span class="n">inputdir</span><span class="p">)</span>
408
409        <span class="k">try</span><span class="p">:</span>
410            <span class="n">flexpart</span><span class="o">.</span><span class="n">retrieve</span><span class="p">(</span><span class="n">server</span><span class="p">,</span> <span class="n">dates</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">public</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">request</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">inputdir</span><span class="p">)</span>
411        <span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
412            <span class="n">my_error</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">mailfail</span><span class="p">,</span> <span class="s1">&#39;MARS request failed&#39;</span><span class="p">)</span>
413
414        <span class="n">day</span> <span class="o">+=</span> <span class="n">delta_t</span>
415
416    <span class="k">return</span></div>
417
418<span class="k">if</span> <span class="vm">__name__</span> <span class="o">==</span> <span class="s2">&quot;__main__&quot;</span><span class="p">:</span>
419    <span class="n">main</span><span class="p">()</span>
420</pre></div>
421
422           </div>
423           
424          </div>
425          <footer>
426 
427
428  <hr/>
429
430  <div role="contentinfo">
431    <p>
432        &copy; Copyright 2018, Anne Philipp and Leopold Haimberger.
433
434    </p>
435  </div>
436  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>.
437
438</footer>
439
440        </div>
441      </div>
442
443    </section>
444
445  </div>
446 
447
448
449 
450
451    <script type="text/javascript">
452        var DOCUMENTATION_OPTIONS = {
453            URL_ROOT:'../',
454            VERSION:'7.1 alpha',
455            LANGUAGE:'None',
456            COLLAPSE_INDEX:false,
457            FILE_SUFFIX:'.html',
458            HAS_SOURCE:  true,
459            SOURCELINK_SUFFIX: '.txt'
460        };
461    </script>
462      <script type="text/javascript" src="../_static/jquery.js"></script>
463      <script type="text/javascript" src="../_static/underscore.js"></script>
464      <script type="text/javascript" src="../_static/doctools.js"></script>
465      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
466
467 
468
469  <script type="text/javascript" src="../_static/js/theme.js"></script>
470
471  <script type="text/javascript">
472      jQuery(function () {
473          SphinxRtdTheme.Navigation.enable(true);
474      });
475  </script> 
476
477</body>
478</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG