source: flex_extract.git/Documentation/html/_modules/get_mars_data.html @ 30f7911

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

reviewed installation section of online documentation; minor corrections
  • Property mode set to 100644
File size: 41.7 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  <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</head>
42
43<body class="wy-body-for-nav">
44
45   
46  <div class="wy-grid-for-nav">
47   
48    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
49      <div class="wy-side-scroll">
50        <div class="wy-side-nav-search" >
51         
52
53         
54            <a href="../index.html" class="icon icon-home"> flex_extract
55         
56
57         
58          </a>
59
60         
61           
62           
63              <div class="version">
64                7.1
65              </div>
66           
67         
68
69         
70<div role="search">
71  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
72    <input type="text" name="q" placeholder="Search docs" />
73    <input type="hidden" name="check_keywords" value="yes" />
74    <input type="hidden" name="area" value="default" />
75  </form>
76</div>
77
78         
79        </div>
80
81        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
82         
83           
84           
85             
86           
87           
88              <p class="caption"><span class="caption-text">Table of Contents:</span></p>
89<ul>
90<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
91<li class="toctree-l1"><a class="reference internal" href="../quick_start.html">Quick Start</a></li>
92<li class="toctree-l1"><a class="reference internal" href="../ecmwf_data.html">ECMWF Data</a></li>
93<li class="toctree-l1"><a class="reference internal" href="../documentation.html">Documentation</a></li>
94<li class="toctree-l1"><a class="reference internal" href="../evaluation.html">Evaluation</a></li>
95<li class="toctree-l1"><a class="reference internal" href="../dev_guide.html">Developer Guide</a></li>
96<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
97<li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li>
98<li class="toctree-l1"><a class="reference internal" href="../Support/faq.html">FAQ - Frequently asked questions</a></li>
99<li class="toctree-l1"><a class="reference internal" href="../authors.html">Developer Team</a></li>
100</ul>
101
102           
103         
104        </div>
105      </div>
106    </nav>
107
108    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
109
110     
111      <nav class="wy-nav-top" aria-label="top navigation">
112       
113          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
114          <a href="../index.html">flex_extract</a>
115       
116      </nav>
117
118
119      <div class="wy-nav-content">
120       
121        <div class="rst-content">
122       
123         
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139<div role="navigation" aria-label="breadcrumbs navigation">
140
141  <ul class="wy-breadcrumbs">
142   
143      <li><a href="../index.html">Docs</a> &raquo;</li>
144       
145          <li><a href="index.html">Module code</a> &raquo;</li>
146       
147      <li>get_mars_data</li>
148   
149   
150      <li class="wy-breadcrumbs-aside">
151       
152      </li>
153   
154  </ul>
155
156 
157  <hr/>
158</div>
159          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
160           <div itemprop="articleBody">
161           
162  <h1>Source code for get_mars_data</h1><div class="highlight"><pre>
163<span></span><span class="ch">#!/usr/bin/env python3</span>
164<span class="c1"># -*- coding: utf-8 -*-</span>
165<span class="c1">#*******************************************************************************</span>
166<span class="c1"># @Author: Anne Fouilloux (University of Oslo)</span>
167<span class="c1">#</span>
168<span class="c1"># @Date: October 2014</span>
169<span class="c1">#</span>
170<span class="c1"># @Change History:</span>
171<span class="c1">#</span>
172<span class="c1">#    November 2015 - Leopold Haimberger (University of Vienna):</span>
173<span class="c1">#        - moved the getEIdata program into a function &quot;get_mars_data&quot;</span>
174<span class="c1">#        - moved the AgurmentParser into a seperate function</span>
175<span class="c1">#        - adatpted the function for the use in flex_extract</span>
176<span class="c1">#        - renamed file to get_mars_data</span>
177<span class="c1">#</span>
178<span class="c1">#    February 2018 - Anne Philipp (University of Vienna):</span>
179<span class="c1">#        - applied PEP8 style guide</span>
180<span class="c1">#        - added structured documentation</span>
181<span class="c1">#        - minor changes in programming style for consistence</span>
182<span class="c1">#        - added function main and moved function calls vom __main__ there</span>
183<span class="c1">#          (necessary for better documentation with docstrings for later</span>
184<span class="c1">#          online documentation)</span>
185<span class="c1">#        - use of UIFiles class for file selection and deletion</span>
186<span class="c1">#        - seperated get_mars_data function into several smaller pieces:</span>
187<span class="c1">#          write_reqheader, mk_server, mk_dates, remove_old, do_retrievment</span>
188<span class="c1">#</span>
189<span class="c1"># @License:</span>
190<span class="c1">#    (C) Copyright 2014-2019.</span>
191<span class="c1">#    Anne Philipp, Leopold Haimberger</span>
192<span class="c1">#</span>
193<span class="c1">#    SPDX-License-Identifier: CC-BY-4.0</span>
194<span class="c1">#</span>
195<span class="c1">#    This work is licensed under the Creative Commons Attribution 4.0</span>
196<span class="c1">#    International License. To view a copy of this license, visit</span>
197<span class="c1">#    http://creativecommons.org/licenses/by/4.0/ or send a letter to</span>
198<span class="c1">#    Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</span>
199<span class="c1">#*******************************************************************************</span>
200<span class="sd">&#39;&#39;&#39;This script extracts MARS data from ECMWF servers.</span>
201
202<span class="sd">At first, the necessary parameters from command line and CONTROL files are</span>
203<span class="sd">extracted. They define the data set to be extracted from MARS.</span>
204
205<span class="sd">This file can also be imported as a module and contains the following</span>
206<span class="sd">functions:</span>
207
208<span class="sd">    * main - the main function of the script</span>
209<span class="sd">    * get_mars_data - overall control of ECMWF data retrievment</span>
210<span class="sd">    * write_reqheader - writes the header into the mars_request file</span>
211<span class="sd">    * mk_server - creates the server connection to ECMWF servers</span>
212<span class="sd">    * mk_dates - defines the start and end date</span>
213<span class="sd">    * remove_old - deletes old retrieved grib files</span>
214<span class="sd">    * do_retrievement - creates individual retrievals</span>
215
216<span class="sd">Type: get_mars_data.py --help</span>
217<span class="sd">to get information about command line parameters.</span>
218<span class="sd">Read the documentation for usage instructions.</span>
219<span class="sd">&#39;&#39;&#39;</span>
220<span class="c1"># ------------------------------------------------------------------------------</span>
221<span class="c1"># MODULES</span>
222<span class="c1"># ------------------------------------------------------------------------------</span>
223<span class="kn">from</span> <span class="nn">__future__</span> <span class="k">import</span> <span class="n">print_function</span>
224
225<span class="kn">import</span> <span class="nn">os</span>
226<span class="kn">import</span> <span class="nn">sys</span>
227<span class="kn">import</span> <span class="nn">inspect</span>
228<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>
229
230<span class="c1"># software specific classes and modules from flex_extract</span>
231<span class="c1"># add path to local main python path for flex_extract to get full access</span>
232<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>
233    <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>
234<span class="kn">import</span> <span class="nn">_config</span>
235<span class="kn">from</span> <span class="nn">Mods.tools</span> <span class="k">import</span> <span class="p">(</span><span class="n">setup_controldata</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_args</span><span class="p">,</span>
236                   <span class="n">read_ecenv</span><span class="p">,</span> <span class="n">make_dir</span><span class="p">)</span>
237<span class="kn">from</span> <span class="nn">Classes.EcFlexpart</span> <span class="k">import</span> <span class="n">EcFlexpart</span>
238<span class="kn">from</span> <span class="nn">Classes.UioFiles</span> <span class="k">import</span> <span class="n">UioFiles</span>
239<span class="kn">from</span> <span class="nn">Classes.MarsRetrieval</span> <span class="k">import</span> <span class="n">MarsRetrieval</span>
240
241<span class="k">try</span><span class="p">:</span>
242    <span class="n">ec_api</span> <span class="o">=</span> <span class="kc">True</span>
243    <span class="kn">import</span> <span class="nn">ecmwfapi</span>
244<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
245    <span class="n">ec_api</span> <span class="o">=</span> <span class="kc">False</span>
246
247<span class="k">try</span><span class="p">:</span>
248    <span class="n">cds_api</span> <span class="o">=</span> <span class="kc">True</span>
249    <span class="kn">import</span> <span class="nn">cdsapi</span>
250<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
251    <span class="n">cds_api</span> <span class="o">=</span> <span class="kc">False</span>
252<span class="c1"># ------------------------------------------------------------------------------</span>
253<span class="c1"># FUNCTION</span>
254<span class="c1"># ------------------------------------------------------------------------------</span>
255<div class="viewcode-block" id="main"><a class="viewcode-back" href="../Documentation/Api/api_python.html#get_mars_data.main">[docs]</a><span class="k">def</span> <span class="nf">main</span><span class="p">():</span>
256    <span class="sd">&#39;&#39;&#39;Controls the program to get data out of mars.</span>
257
258<span class="sd">    This is done if it is called directly from command line.</span>
259<span class="sd">    Then it also takes program call arguments and control file input.</span>
260
261<span class="sd">    Parameters</span>
262<span class="sd">    ----------</span>
263
264<span class="sd">    Return</span>
265<span class="sd">    ------</span>
266
267<span class="sd">    &#39;&#39;&#39;</span>
268
269    <span class="n">c</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">setup_controldata</span><span class="p">()</span>
270    <span class="n">get_mars_data</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
271    <span class="n">normal_exit</span><span class="p">(</span><span class="s1">&#39;Retrieving MARS data: Done!&#39;</span><span class="p">)</span>
272
273    <span class="k">return</span></div>
274
275<div class="viewcode-block" id="get_mars_data"><a class="viewcode-back" href="../Documentation/Api/api_python.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>
276    <span class="sd">&#39;&#39;&#39;Retrieves the EC data needed for a FLEXPART simulation.</span>
277
278<span class="sd">    Start and end dates for retrieval period is set. Retrievals</span>
279<span class="sd">    are divided into smaller periods if necessary and datechunk parameter</span>
280<span class="sd">    is set.</span>
281
282<span class="sd">    Parameters</span>
283<span class="sd">    ----------</span>
284<span class="sd">    c : ControlFile</span>
285<span class="sd">        Contains all the parameters of CONTROL file and</span>
286<span class="sd">        command line.</span>
287
288<span class="sd">    Return</span>
289<span class="sd">    ------</span>
290
291<span class="sd">    &#39;&#39;&#39;</span>
292    <span class="n">c</span><span class="o">.</span><span class="n">ec_api</span> <span class="o">=</span> <span class="n">ec_api</span>
293    <span class="n">c</span><span class="o">.</span><span class="n">cds_api</span> <span class="o">=</span> <span class="n">cds_api</span>
294
295    <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>
296        <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>
297
298    <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="p">:</span>
299        <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Retrieving EC data!&quot;</span><span class="p">)</span>
300    <span class="k">else</span><span class="p">:</span>
301        <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">1</span><span class="p">:</span>
302            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Printing mars requests!&quot;</span><span class="p">)</span>
303        <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">2</span><span class="p">:</span>
304            <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Retrieving EC data and printing mars request!&quot;</span><span class="p">)</span>
305        <span class="n">write_reqheader</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">inputdir</span><span class="p">,</span> <span class="n">_config</span><span class="o">.</span><span class="n">FILE_MARS_REQUESTS</span><span class="p">))</span>
306
307    <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>
308    <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>
309
310    <span class="n">server</span> <span class="o">=</span> <span class="n">mk_server</span><span class="p">(</span><span class="n">c</span><span class="p">)</span>
311
312    <span class="c1"># if data are to be retrieved, clean up any old grib files</span>
313    <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>
314        <span class="n">remove_old</span><span class="p">(</span><span class="s1">&#39;*grb&#39;</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">inputdir</span><span class="p">)</span>
315
316    <span class="c1"># --------------  flux data ------------------------------------------------</span>
317    <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="o">=</span> <span class="n">mk_dates</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">fluxes</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
318    <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>
319
320    <span class="c1"># --------------  non flux data --------------------------------------------</span>
321    <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="o">=</span> <span class="n">mk_dates</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">fluxes</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
322    <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>
323
324    <span class="k">return</span></div>
325
326<div class="viewcode-block" id="write_reqheader"><a class="viewcode-back" href="../Documentation/Api/api_python.html#get_mars_data.write_reqheader">[docs]</a><span class="k">def</span> <span class="nf">write_reqheader</span><span class="p">(</span><span class="n">marsfile</span><span class="p">):</span>
327    <span class="sd">&#39;&#39;&#39;Writes header with column names into mars request file.</span>
328
329<span class="sd">    Parameters</span>
330<span class="sd">    ----------</span>
331<span class="sd">    marsfile : str</span>
332<span class="sd">        Path to the mars request file.</span>
333
334<span class="sd">    Return</span>
335<span class="sd">    ------</span>
336
337<span class="sd">    &#39;&#39;&#39;</span>
338    <span class="n">MR</span> <span class="o">=</span> <span class="n">MarsRetrieval</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
339    <span class="n">attrs</span> <span class="o">=</span> <span class="nb">vars</span><span class="p">(</span><span class="n">MR</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
340    <span class="k">del</span> <span class="n">attrs</span><span class="p">[</span><span class="s1">&#39;server&#39;</span><span class="p">]</span>
341    <span class="k">del</span> <span class="n">attrs</span><span class="p">[</span><span class="s1">&#39;public&#39;</span><span class="p">]</span>
342    <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">marsfile</span><span class="p">,</span> <span class="s1">&#39;w&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
343        <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;request_number&#39;</span> <span class="o">+</span> <span class="s1">&#39;, &#39;</span><span class="p">)</span>
344        <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;, &#39;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">attrs</span><span class="o">.</span><span class="n">keys</span><span class="p">())))</span>
345        <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">&#39;</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">)</span>
346
347    <span class="k">return</span></div>
348
349<div class="viewcode-block" id="mk_server"><a class="viewcode-back" href="../Documentation/Api/api_python.html#get_mars_data.mk_server">[docs]</a><span class="k">def</span> <span class="nf">mk_server</span><span class="p">(</span><span class="n">c</span><span class="p">):</span>
350    <span class="sd">&#39;&#39;&#39;Creates a server connection with available python API.</span>
351
352<span class="sd">    Which API is used depends on availability and the dataset to be retrieved.</span>
353<span class="sd">    The CDS API is used for ERA5 dataset no matter if the user is a member or</span>
354<span class="sd">    a public user. ECMWF WebAPI is used for all other available datasets.</span>
355
356<span class="sd">    Parameters</span>
357<span class="sd">    ----------</span>
358<span class="sd">    c : ControlFile</span>
359<span class="sd">        Contains all the parameters of CONTROL file and</span>
360<span class="sd">        command line.</span>
361
362<span class="sd">    Return</span>
363<span class="sd">    ------</span>
364<span class="sd">    server : ECMWFDataServer, ECMWFService or Client</span>
365<span class="sd">        Connection to ECMWF server via python interface ECMWF WebAPI or CDS API.</span>
366
367<span class="sd">    &#39;&#39;&#39;</span>
368    <span class="k">if</span> <span class="n">cds_api</span> <span class="ow">and</span> <span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">marsclass</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;EA&#39;</span><span class="p">):</span>
369        <span class="n">server</span> <span class="o">=</span> <span class="n">cdsapi</span><span class="o">.</span><span class="n">Client</span><span class="p">()</span>
370        <span class="n">c</span><span class="o">.</span><span class="n">ec_api</span> <span class="o">=</span> <span class="kc">False</span>
371    <span class="k">elif</span> <span class="n">c</span><span class="o">.</span><span class="n">ec_api</span><span class="p">:</span>
372        <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">public</span><span class="p">:</span>
373            <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>
374        <span class="k">else</span><span class="p">:</span>
375            <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>
376        <span class="n">c</span><span class="o">.</span><span class="n">cds_api</span> <span class="o">=</span> <span class="kc">False</span>
377    <span class="k">else</span><span class="p">:</span>
378        <span class="n">server</span> <span class="o">=</span> <span class="kc">False</span>
379
380    <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">ec_api</span><span class="p">))</span>
381    <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Using CDS API: &#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">cds_api</span><span class="p">))</span>
382
383    <span class="k">return</span> <span class="n">server</span></div>
384
385
386<div class="viewcode-block" id="check_dates_for_nonflux_fc_times"><a class="viewcode-back" href="../Documentation/Api/api_python.html#get_mars_data.check_dates_for_nonflux_fc_times">[docs]</a><span class="k">def</span> <span class="nf">check_dates_for_nonflux_fc_times</span><span class="p">(</span><span class="n">types</span><span class="p">,</span> <span class="n">times</span><span class="p">):</span>
387    <span class="sd">&#39;&#39;&#39;</span>
388<span class="sd">    &#39;&#39;&#39;</span>
389    <span class="k">for</span> <span class="n">ty</span><span class="p">,</span> <span class="n">ti</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">types</span><span class="p">,</span><span class="n">times</span><span class="p">):</span>
390        <span class="k">if</span> <span class="n">ty</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> <span class="o">==</span> <span class="s1">&#39;FC&#39;</span> <span class="ow">and</span> <span class="nb">int</span><span class="p">(</span><span class="n">ti</span><span class="p">)</span> <span class="o">==</span> <span class="mi">18</span><span class="p">:</span>
391            <span class="k">return</span> <span class="kc">True</span>
392    <span class="k">return</span> <span class="kc">False</span></div>
393
394
395<div class="viewcode-block" id="mk_dates"><a class="viewcode-back" href="../Documentation/Api/api_python.html#get_mars_data.mk_dates">[docs]</a><span class="k">def</span> <span class="nf">mk_dates</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="n">fluxes</span><span class="p">):</span>
396    <span class="sd">&#39;&#39;&#39;Prepares start and end date depending on flux or non flux data.</span>
397
398<span class="sd">    If forecast for maximum one day (upto 24h) are to be retrieved, then</span>
399<span class="sd">    collect accumulation data (flux data) with additional days in the</span>
400<span class="sd">    beginning and at the end (used for complete disaggregation of</span>
401<span class="sd">    original period)</span>
402
403<span class="sd">    If forecast data longer than 24h are to be retrieved, then</span>
404<span class="sd">    collect accumulation data (flux data) with the exact start and end date</span>
405<span class="sd">    (disaggregation will be done for the exact time period with</span>
406<span class="sd">    boundary conditions)</span>
407
408<span class="sd">    Since for basetime the extraction contains the 12 hours upfront,</span>
409<span class="sd">    if basetime is 0, the starting date has to be the day before and</span>
410
411<span class="sd">    Parameters</span>
412<span class="sd">    ----------</span>
413<span class="sd">    c : ControlFile</span>
414<span class="sd">        Contains all the parameters of CONTROL file and</span>
415<span class="sd">        command line.</span>
416
417<span class="sd">    fluxes : boolean, optional</span>
418<span class="sd">        Decides if the flux parameter settings are stored or</span>
419<span class="sd">        the rest of the parameter list.</span>
420<span class="sd">        Default value is False.</span>
421
422<span class="sd">    Return</span>
423<span class="sd">    ------</span>
424<span class="sd">    start : datetime</span>
425<span class="sd">        The start date of the retrieving data set.</span>
426
427<span class="sd">    end : datetime</span>
428<span class="sd">        The end date of the retrieving data set.</span>
429
430<span class="sd">    chunk : datetime</span>
431<span class="sd">        Time period in days for one single mars retrieval.</span>
432
433<span class="sd">    &#39;&#39;&#39;</span>
434    <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>
435    <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>
436    <span class="n">chunk</span> <span class="o">=</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="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>
437
438    <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="mi">0</span><span class="p">:</span>
439        <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>
440
441    <span class="k">if</span> <span class="n">c</span><span class="o">.</span><span class="n">purefc</span> <span class="ow">and</span> <span class="n">fluxes</span> <span class="ow">and</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>
442        <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>
443        <span class="n">end</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>
444
445    <span class="k">if</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">purefc</span> <span class="ow">and</span> <span class="n">fluxes</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">c</span><span class="o">.</span><span class="n">basetime</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
446        <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>
447        <span class="n">end</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>
448
449    <span class="c1"># if we have non-flux forecast data starting at 18 UTC</span>
450    <span class="c1"># we need to start retrieving data one day in advance</span>
451    <span class="k">if</span> <span class="ow">not</span> <span class="n">fluxes</span> <span class="ow">and</span> <span class="n">check_dates_for_nonflux_fc_times</span><span class="p">(</span><span class="n">c</span><span class="o">.</span><span class="n">type</span><span class="p">,</span> <span class="n">c</span><span class="o">.</span><span class="n">time</span><span class="p">):</span>
452        <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>
453
454    <span class="k">return</span> <span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">,</span> <span class="n">chunk</span></div>
455
456<div class="viewcode-block" id="remove_old"><a class="viewcode-back" href="../Documentation/Api/api_python.html#get_mars_data.remove_old">[docs]</a><span class="k">def</span> <span class="nf">remove_old</span><span class="p">(</span><span class="n">pattern</span><span class="p">,</span> <span class="n">inputdir</span><span class="p">):</span>
457    <span class="sd">&#39;&#39;&#39;Deletes old retrieval files from current input directory</span>
458<span class="sd">    matching the pattern.</span>
459
460<span class="sd">    Parameters</span>
461<span class="sd">    ----------</span>
462<span class="sd">    pattern : str</span>
463<span class="sd">        The sub string pattern which identifies the files to be deleted.</span>
464
465<span class="sd">    inputdir : str, optional</span>
466<span class="sd">        Path to the directory where the retrieved data is stored.</span>
467
468<span class="sd">    Return</span>
469<span class="sd">    ------</span>
470
471<span class="sd">    &#39;&#39;&#39;</span>
472    <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;... removing old content of &#39;</span> <span class="o">+</span> <span class="n">inputdir</span><span class="p">)</span>
473
474    <span class="n">tobecleaned</span> <span class="o">=</span> <span class="n">UioFiles</span><span class="p">(</span><span class="n">inputdir</span><span class="p">,</span> <span class="n">pattern</span><span class="p">)</span>
475    <span class="n">tobecleaned</span><span class="o">.</span><span class="n">delete_files</span><span class="p">()</span>
476
477    <span class="k">return</span></div>
478
479
480<div class="viewcode-block" id="do_retrievement"><a class="viewcode-back" href="../Documentation/Api/api_python.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>
481    <span class="sd">&#39;&#39;&#39;Divides the complete retrieval period in smaller chunks and</span>
482<span class="sd">    retrieves the data from MARS.</span>
483
484<span class="sd">    Parameters</span>
485<span class="sd">    ----------</span>
486<span class="sd">    c : ControlFile</span>
487<span class="sd">        Contains all the parameters of CONTROL file and</span>
488<span class="sd">        command line.</span>
489
490<span class="sd">    server : ECMWFService or ECMWFDataServer</span>
491<span class="sd">            The server connection to ECMWF.</span>
492
493<span class="sd">    start : datetime</span>
494<span class="sd">        The start date of the retrieval.</span>
495
496<span class="sd">    end : datetime</span>
497<span class="sd">        The end date of the retrieval.</span>
498
499<span class="sd">    delta_t : datetime</span>
500<span class="sd">        Delta_t + 1 is the maximal time period of a single</span>
501<span class="sd">        retrieval.</span>
502
503<span class="sd">    fluxes : boolean, optional</span>
504<span class="sd">        Decides if the flux parameters are to be retrieved or</span>
505<span class="sd">        the rest of the parameter list.</span>
506<span class="sd">        Default value is False.</span>
507
508<span class="sd">    Return</span>
509<span class="sd">    ------</span>
510
511<span class="sd">    &#39;&#39;&#39;</span>
512
513    <span class="c1"># since actual day also counts as one day,</span>
514    <span class="c1"># we only need to add datechunk - 1 days to retrieval</span>
515    <span class="c1"># for a period</span>
516    <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>
517
518    <span class="n">day</span> <span class="o">=</span> <span class="n">start</span>
519    <span class="k">while</span> <span class="n">day</span> <span class="o">&lt;=</span> <span class="n">end</span><span class="p">:</span>
520        <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>
521        <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>
522        <span class="k">if</span> <span class="n">tmpday</span> <span class="o">&lt;</span> <span class="n">end</span><span class="p">:</span>
523            <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> \
524                    <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>
525        <span class="k">else</span><span class="p">:</span>
526            <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> \
527                    <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>
528
529        <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>
530
531        <span class="k">try</span><span class="p">:</span>
532            <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>
533        <span class="k">except</span> <span class="ne">IOError</span><span class="p">:</span>
534            <span class="n">my_error</span><span class="p">(</span><span class="s1">&#39;MARS request failed&#39;</span><span class="p">)</span>
535
536        <span class="n">day</span> <span class="o">+=</span> <span class="n">delta_t</span>
537
538    <span class="k">return</span></div>
539
540<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>
541    <span class="n">main</span><span class="p">()</span>
542</pre></div>
543
544           </div>
545           
546          </div>
547          <footer>
548 
549
550  <hr/>
551
552  <div role="contentinfo">
553    <p>
554        &copy; Copyright 2019, Anne Philipp and Leopold Haimberger
555
556    </p>
557  </div>
558  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>.
559
560</footer>
561
562        </div>
563      </div>
564
565    </section>
566
567  </div>
568 
569
570
571  <script type="text/javascript">
572      jQuery(function () {
573          SphinxRtdTheme.Navigation.enable(true);
574      });
575  </script>
576
577 
578 
579   
580   
581
582</body>
583</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG