[0b00607] | 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 | |
---|
[6931f61] | 11 | <title>MarsRetrieval — flex_extract 7.1.2 documentation</title> |
---|
[0b00607] | 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> |
---|
[b1674ed] | 24 | <script src="../_static/jquery.js"></script> |
---|
| 25 | <script src="../_static/underscore.js"></script> |
---|
| 26 | <script src="../_static/doctools.js"></script> |
---|
| 27 | <script src="../_static/language_data.js"></script> |
---|
| 28 | <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
---|
[0b00607] | 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"> |
---|
[6931f61] | 64 | 7.1.2 |
---|
[0b00607] | 65 | </div> |
---|
| 66 | |
---|
| 67 | |
---|
| 68 | |
---|
| 69 | |
---|
| 70 | <div role="search"> |
---|
| 71 | <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
---|
| 72 | <input type="text" name="q" placeholder="Search docs" /> |
---|
| 73 | <input type="hidden" name="check_keywords" value="yes" /> |
---|
| 74 | <input type="hidden" name="area" value="default" /> |
---|
| 75 | </form> |
---|
| 76 | </div> |
---|
| 77 | |
---|
| 78 | |
---|
| 79 | </div> |
---|
| 80 | |
---|
| 81 | <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
---|
| 82 | |
---|
| 83 | |
---|
| 84 | |
---|
| 85 | |
---|
| 86 | |
---|
| 87 | |
---|
| 88 | <p class="caption"><span class="caption-text">Table of Contents:</span></p> |
---|
| 89 | <ul> |
---|
| 90 | <li class="toctree-l1"><a class="reference internal" href="../ecmwf_data.html">ECMWF Data</a></li> |
---|
[5bee29a] | 91 | <li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li> |
---|
| 92 | <li class="toctree-l1"><a class="reference internal" href="../quick_start.html">Usage</a></li> |
---|
| 93 | <li class="toctree-l1"><a class="reference internal" href="../documentation.html">Code-Level Documentation</a></li> |
---|
[0b00607] | 94 | <li class="toctree-l1"><a class="reference internal" href="../evaluation.html">Evaluation</a></li> |
---|
| 95 | <li class="toctree-l1"><a class="reference internal" href="../dev_guide.html">Developer Guide</a></li> |
---|
| 96 | <li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li> |
---|
| 97 | <li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li> |
---|
| 98 | <li class="toctree-l1"><a class="reference internal" href="../Support/faq.html">FAQ - Frequently asked questions</a></li> |
---|
| 99 | <li class="toctree-l1"><a class="reference internal" href="../authors.html">Developer Team</a></li> |
---|
| 100 | </ul> |
---|
| 101 | |
---|
| 102 | |
---|
| 103 | |
---|
| 104 | </div> |
---|
| 105 | </div> |
---|
| 106 | </nav> |
---|
| 107 | |
---|
| 108 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
---|
| 109 | |
---|
| 110 | |
---|
| 111 | <nav class="wy-nav-top" aria-label="top navigation"> |
---|
| 112 | |
---|
| 113 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
---|
| 114 | <a href="../index.html">flex_extract</a> |
---|
| 115 | |
---|
| 116 | </nav> |
---|
| 117 | |
---|
| 118 | |
---|
| 119 | <div class="wy-nav-content"> |
---|
| 120 | |
---|
| 121 | <div class="rst-content"> |
---|
| 122 | |
---|
| 123 | |
---|
| 124 | |
---|
| 125 | |
---|
| 126 | |
---|
| 127 | |
---|
| 128 | |
---|
| 129 | |
---|
| 130 | |
---|
| 131 | |
---|
| 132 | |
---|
| 133 | |
---|
| 134 | |
---|
| 135 | |
---|
| 136 | |
---|
| 137 | |
---|
| 138 | |
---|
| 139 | <div role="navigation" aria-label="breadcrumbs navigation"> |
---|
| 140 | |
---|
| 141 | <ul class="wy-breadcrumbs"> |
---|
| 142 | |
---|
| 143 | <li><a href="../index.html">Docs</a> »</li> |
---|
| 144 | |
---|
| 145 | <li><a href="index.html">Module code</a> »</li> |
---|
| 146 | |
---|
| 147 | <li>MarsRetrieval</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 MarsRetrieval</h1><div class="highlight"><pre> |
---|
[30f7911] | 163 | <span></span><span class="ch">#!/usr/bin/env python3</span> |
---|
[0b00607] | 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"># - optimized display_info</span> |
---|
| 174 | <span class="c1"># - optimized data_retrieve and seperate between python and shell</span> |
---|
| 175 | <span class="c1"># script call</span> |
---|
| 176 | <span class="c1">#</span> |
---|
| 177 | <span class="c1"># February 2018 - Anne Philipp (University of Vienna):</span> |
---|
| 178 | <span class="c1"># - applied PEP8 style guide</span> |
---|
| 179 | <span class="c1"># - added documentation</span> |
---|
| 180 | <span class="c1"># - applied some minor modifications in programming style/structure</span> |
---|
| 181 | <span class="c1"># - added writing of mars request attributes to a csv file</span> |
---|
| 182 | <span class="c1">#</span> |
---|
| 183 | <span class="c1"># @License:</span> |
---|
| 184 | <span class="c1"># (C) Copyright 2014-2019.</span> |
---|
| 185 | <span class="c1"># Anne Philipp, Leopold Haimberger</span> |
---|
| 186 | <span class="c1">#</span> |
---|
[30f7911] | 187 | <span class="c1"># SPDX-License-Identifier: CC-BY-4.0</span> |
---|
| 188 | <span class="c1">#</span> |
---|
[0b00607] | 189 | <span class="c1"># This work is licensed under the Creative Commons Attribution 4.0</span> |
---|
| 190 | <span class="c1"># International License. To view a copy of this license, visit</span> |
---|
| 191 | <span class="c1"># http://creativecommons.org/licenses/by/4.0/ or send a letter to</span> |
---|
| 192 | <span class="c1"># Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.</span> |
---|
| 193 | <span class="c1">#*******************************************************************************</span> |
---|
| 194 | |
---|
| 195 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
| 196 | <span class="c1"># MODULES</span> |
---|
| 197 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
[b1674ed] | 198 | <span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">print_function</span> |
---|
[0b00607] | 199 | |
---|
| 200 | <span class="kn">import</span> <span class="nn">os</span> |
---|
| 201 | <span class="kn">import</span> <span class="nn">sys</span> |
---|
| 202 | <span class="kn">import</span> <span class="nn">subprocess</span> |
---|
| 203 | <span class="kn">import</span> <span class="nn">traceback</span> |
---|
| 204 | |
---|
| 205 | <span class="c1"># software specific classes and modules from flex_extract</span> |
---|
[eca358d] | 206 | <span class="c1">#pylint: disable=wrong-import-position</span> |
---|
[0b00607] | 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="s1">'../'</span><span class="p">)</span> |
---|
| 208 | <span class="kn">import</span> <span class="nn">_config</span> |
---|
[eca358d] | 209 | <span class="c1">#pylint: disable=invalid-name</span> |
---|
[0b00607] | 210 | <span class="k">try</span><span class="p">:</span> |
---|
| 211 | <span class="n">ec_api</span> <span class="o">=</span> <span class="kc">True</span> |
---|
| 212 | <span class="kn">import</span> <span class="nn">ecmwfapi</span> |
---|
| 213 | <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> |
---|
| 214 | <span class="n">ec_api</span> <span class="o">=</span> <span class="kc">False</span> |
---|
| 215 | |
---|
| 216 | <span class="k">try</span><span class="p">:</span> |
---|
| 217 | <span class="n">cds_api</span> <span class="o">=</span> <span class="kc">True</span> |
---|
| 218 | <span class="kn">import</span> <span class="nn">cdsapi</span> |
---|
| 219 | <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> |
---|
| 220 | <span class="n">cds_api</span> <span class="o">=</span> <span class="kc">False</span> |
---|
[eca358d] | 221 | <span class="c1">#pylint: enable=invalid-name</span> |
---|
| 222 | <span class="c1">#pylint: enable=wrong-import-position</span> |
---|
[0b00607] | 223 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
| 224 | <span class="c1"># CLASS</span> |
---|
| 225 | <span class="c1"># ------------------------------------------------------------------------------</span> |
---|
| 226 | <div class="viewcode-block" id="MarsRetrieval"><a class="viewcode-back" href="../Documentation/Api/api_python.html#MarsRetrieval.MarsRetrieval">[docs]</a><span class="k">class</span> <span class="nc">MarsRetrieval</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span> |
---|
| 227 | <span class="sd">'''Specific syntax and content for submission of MARS retrievals.</span> |
---|
| 228 | |
---|
| 229 | <span class="sd"> A MARS revtrieval has a specific syntax with a selection of keywords and</span> |
---|
| 230 | <span class="sd"> their corresponding values. This class provides the necessary functions</span> |
---|
| 231 | <span class="sd"> by displaying the selected parameters and their values and the actual</span> |
---|
| 232 | <span class="sd"> retrievement of the data through a mars request or a Python web api</span> |
---|
| 233 | <span class="sd"> interface. The initialization already expects all the keyword values.</span> |
---|
| 234 | |
---|
| 235 | <span class="sd"> A description of MARS keywords/arguments and examples of their</span> |
---|
| 236 | <span class="sd"> values can be found here:</span> |
---|
| 237 | <span class="sd"> https://software.ecmwf.int/wiki/display/UDOC/\</span> |
---|
| 238 | <span class="sd"> Identification+keywords#Identificationkeywords-class</span> |
---|
| 239 | |
---|
| 240 | <span class="sd"> Attributes</span> |
---|
| 241 | <span class="sd"> ----------</span> |
---|
| 242 | <span class="sd"> server : ECMWFService or ECMWFDataServer</span> |
---|
| 243 | <span class="sd"> This is the connection to the ECMWF data servers.</span> |
---|
| 244 | |
---|
| 245 | <span class="sd"> public : int</span> |
---|
| 246 | <span class="sd"> Decides which Web API Server version is used.</span> |
---|
| 247 | |
---|
| 248 | <span class="sd"> marsclass : str, optional</span> |
---|
| 249 | <span class="sd"> Characterisation of dataset.</span> |
---|
| 250 | |
---|
| 251 | <span class="sd"> dataset : str, optional</span> |
---|
| 252 | <span class="sd"> For public datasets there is the specific naming and parameter</span> |
---|
| 253 | <span class="sd"> dataset which has to be used to characterize the type of</span> |
---|
| 254 | <span class="sd"> data.</span> |
---|
| 255 | |
---|
| 256 | <span class="sd"> type : str, optional</span> |
---|
| 257 | <span class="sd"> Determines the type of fields to be retrieved.</span> |
---|
| 258 | |
---|
| 259 | <span class="sd"> levtype : str, optional</span> |
---|
| 260 | <span class="sd"> Denotes type of level.</span> |
---|
| 261 | |
---|
| 262 | <span class="sd"> levelist : str, optional</span> |
---|
| 263 | <span class="sd"> Specifies the required levels.</span> |
---|
| 264 | |
---|
| 265 | <span class="sd"> repres : str, optional</span> |
---|
| 266 | <span class="sd"> Selects the representation of the archived data.</span> |
---|
| 267 | |
---|
| 268 | <span class="sd"> date : str, optional</span> |
---|
| 269 | <span class="sd"> Specifies the Analysis date, the Forecast base date or</span> |
---|
| 270 | <span class="sd"> Observations date.</span> |
---|
| 271 | |
---|
| 272 | <span class="sd"> resol : str, optional</span> |
---|
| 273 | <span class="sd"> Specifies the desired triangular truncation of retrieved data,</span> |
---|
| 274 | <span class="sd"> before carrying out any other selected post-processing.</span> |
---|
| 275 | |
---|
| 276 | <span class="sd"> stream : str, optional</span> |
---|
| 277 | <span class="sd"> Identifies the forecasting system used to generate the data.</span> |
---|
| 278 | |
---|
| 279 | <span class="sd"> area : str, optional</span> |
---|
| 280 | <span class="sd"> Specifies the desired sub-area of data to be extracted.</span> |
---|
| 281 | |
---|
| 282 | <span class="sd"> time : str, optional</span> |
---|
| 283 | <span class="sd"> Specifies the time of the data in hours and minutes.</span> |
---|
| 284 | |
---|
| 285 | <span class="sd"> step : str, optional</span> |
---|
| 286 | <span class="sd"> Specifies the forecast time step from forecast base time.</span> |
---|
| 287 | |
---|
| 288 | <span class="sd"> expver : str, optional</span> |
---|
| 289 | <span class="sd"> The version of the dataset.</span> |
---|
| 290 | |
---|
| 291 | <span class="sd"> number : str, optional</span> |
---|
| 292 | <span class="sd"> Selects the member in ensemble forecast run.</span> |
---|
| 293 | |
---|
| 294 | <span class="sd"> accuracy : str, optional</span> |
---|
| 295 | <span class="sd"> Specifies the number of bits per value to be used in the</span> |
---|
| 296 | <span class="sd"> generated GRIB coded fields.</span> |
---|
| 297 | |
---|
| 298 | <span class="sd"> grid : str, optional</span> |
---|
| 299 | <span class="sd"> Specifies the output grid which can be either a Gaussian grid</span> |
---|
| 300 | <span class="sd"> or a Latitude/Longitude grid.</span> |
---|
| 301 | |
---|
| 302 | <span class="sd"> gaussian : str, optional</span> |
---|
| 303 | <span class="sd"> This parameter is deprecated and should no longer be used.</span> |
---|
| 304 | <span class="sd"> Specifies the desired type of Gaussian grid for the output.</span> |
---|
| 305 | |
---|
| 306 | <span class="sd"> target : str, optional</span> |
---|
| 307 | <span class="sd"> Specifies a file into which data is to be written after</span> |
---|
| 308 | <span class="sd"> retrieval or manipulation.</span> |
---|
| 309 | |
---|
| 310 | <span class="sd"> param : str, optional</span> |
---|
| 311 | <span class="sd"> Specifies the meteorological parameter.</span> |
---|
| 312 | <span class="sd"> '''</span> |
---|
| 313 | |
---|
[b1674ed] | 314 | <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">server</span><span class="p">,</span> <span class="n">public</span><span class="p">,</span> <span class="n">marsclass</span><span class="o">=</span><span class="s2">"EA"</span><span class="p">,</span> <span class="n">dataset</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> |
---|
[0b00607] | 315 | <span class="n">levtype</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">levelist</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">repres</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">date</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">resol</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> |
---|
| 316 | <span class="n">stream</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">area</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">time</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">step</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">expver</span><span class="o">=</span><span class="s2">"1"</span><span class="p">,</span> |
---|
| 317 | <span class="n">number</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">accuracy</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">grid</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">gaussian</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> <span class="n">target</span><span class="o">=</span><span class="s2">""</span><span class="p">,</span> |
---|
| 318 | <span class="n">param</span><span class="o">=</span><span class="s2">""</span><span class="p">):</span> |
---|
| 319 | <span class="sd">'''Initialises the instance of the MarsRetrieval class and</span> |
---|
| 320 | <span class="sd"> defines and assigns a set of the necessary retrieval parameters</span> |
---|
| 321 | <span class="sd"> for the FLEXPART input data.</span> |
---|
| 322 | <span class="sd"> A description of MARS keywords/arguments, their dependencies</span> |
---|
| 323 | <span class="sd"> on each other and examples of their values can be found here:</span> |
---|
| 324 | |
---|
| 325 | <span class="sd"> https://software.ecmwf.int/wiki/display/UDOC/MARS+keywords</span> |
---|
| 326 | |
---|
| 327 | <span class="sd"> Parameters</span> |
---|
| 328 | <span class="sd"> ----------</span> |
---|
| 329 | <span class="sd"> server : ECMWFService or ECMWFDataServer</span> |
---|
| 330 | <span class="sd"> This is the connection to the ECMWF data servers.</span> |
---|
| 331 | <span class="sd"> It is needed for the pythonic access of ECMWF data.</span> |
---|
| 332 | |
---|
| 333 | <span class="sd"> public : int</span> |
---|
| 334 | <span class="sd"> Decides which Web API version is used:</span> |
---|
| 335 | <span class="sd"> 0: member-state users and full archive access</span> |
---|
| 336 | <span class="sd"> 1: public access and limited access to the public server and</span> |
---|
| 337 | <span class="sd"> datasets. Needs the parameter dataset.</span> |
---|
| 338 | <span class="sd"> Default is "0" and for member-state users.</span> |
---|
| 339 | |
---|
| 340 | <span class="sd"> marsclass : str, optional</span> |
---|
| 341 | <span class="sd"> Characterisation of dataset. E.g. EI (ERA-Interim),</span> |
---|
| 342 | <span class="sd"> E4 (ERA40), OD (Operational archive), EA (ERA5).</span> |
---|
| 343 | <span class="sd"> Default is the ERA5 dataset "EA".</span> |
---|
| 344 | |
---|
| 345 | <span class="sd"> dataset : str, optional</span> |
---|
| 346 | <span class="sd"> For public datasets there is the specific naming and parameter</span> |
---|
| 347 | <span class="sd"> dataset which has to be used to characterize the type of</span> |
---|
| 348 | <span class="sd"> data. Usually there is less data available, either in times,</span> |
---|
| 349 | <span class="sd"> domain or parameter.</span> |
---|
| 350 | <span class="sd"> Default is an empty string.</span> |
---|
| 351 | |
---|
| 352 | <span class="sd"> type : str, optional</span> |
---|
| 353 | <span class="sd"> Determines the type of fields to be retrieved.</span> |
---|
| 354 | <span class="sd"> Selects between observations, images or fields.</span> |
---|
| 355 | <span class="sd"> Examples for fields: Analysis (an), Forecast (fc),</span> |
---|
| 356 | <span class="sd"> Perturbed Forecast (pf), Control Forecast (cf) and so on.</span> |
---|
| 357 | <span class="sd"> Default is an empty string.</span> |
---|
| 358 | |
---|
| 359 | <span class="sd"> levtype : str, optional</span> |
---|
| 360 | <span class="sd"> Denotes type of level. Has a direct implication on valid</span> |
---|
| 361 | <span class="sd"> levelist values!</span> |
---|
| 362 | <span class="sd"> E.g. model level (ml), pressure level (pl), surface (sfc),</span> |
---|
| 363 | <span class="sd"> potential vorticity (pv), potential temperature (pt)</span> |
---|
| 364 | <span class="sd"> and depth (dp).</span> |
---|
| 365 | <span class="sd"> Default is an empty string.</span> |
---|
| 366 | |
---|
| 367 | <span class="sd"> levelist : str, optional</span> |
---|
| 368 | <span class="sd"> Specifies the required levels. It has to have a valid</span> |
---|
| 369 | <span class="sd"> correspondence to the selected levtype.</span> |
---|
| 370 | <span class="sd"> Examples: model level: 1/to/137, pressure levels: 500/to/1000</span> |
---|
| 371 | <span class="sd"> Default is an empty string.</span> |
---|
| 372 | |
---|
| 373 | <span class="sd"> repres : str, optional</span> |
---|
| 374 | <span class="sd"> Selects the representation of the archived data.</span> |
---|
| 375 | <span class="sd"> E.g. sh - spherical harmonics, gg - Gaussian grid,</span> |
---|
| 376 | <span class="sd"> ll - latitude/longitude, ...</span> |
---|
| 377 | <span class="sd"> Default is an empty string.</span> |
---|
| 378 | |
---|
| 379 | <span class="sd"> date : str, optional</span> |
---|
| 380 | <span class="sd"> Specifies the Analysis date, the Forecast base date or</span> |
---|
| 381 | <span class="sd"> Observations date. Valid formats are:</span> |
---|
| 382 | <span class="sd"> Absolute as YYYY-MM-DD or YYYYMMDD.</span> |
---|
| 383 | <span class="sd"> Default is an empty string.</span> |
---|
| 384 | |
---|
| 385 | <span class="sd"> resol : str, optional</span> |
---|
| 386 | <span class="sd"> Specifies the desired triangular truncation of retrieved data,</span> |
---|
| 387 | <span class="sd"> before carrying out any other selected post-processing.</span> |
---|
| 388 | <span class="sd"> The default is automatic truncation (auto), by which the lowest</span> |
---|
| 389 | <span class="sd"> resolution compatible with the value specified in grid is</span> |
---|
| 390 | <span class="sd"> automatically selected for the retrieval.</span> |
---|
| 391 | <span class="sd"> Users wanting to perform post-processing from full spectral</span> |
---|
| 392 | <span class="sd"> resolution should specify Archived Value (av).</span> |
---|
| 393 | <span class="sd"> The following are examples of existing resolutions found in</span> |
---|
| 394 | <span class="sd"> the archive: 63, 106, 159, 213, 255, 319, 399, 511, 799 or 1279.</span> |
---|
| 395 | <span class="sd"> This keyword has no meaning/effect if the archived data is</span> |
---|
| 396 | <span class="sd"> not in spherical harmonics representation.</span> |
---|
| 397 | <span class="sd"> The best selection can be found here:</span> |
---|
| 398 | <span class="sd"> https://software.ecmwf.int/wiki/display/UDOC/\</span> |
---|
| 399 | <span class="sd"> Retrieve#Retrieve-Truncationbeforeinterpolation</span> |
---|
| 400 | <span class="sd"> Default is an empty string.</span> |
---|
| 401 | |
---|
| 402 | <span class="sd"> stream : str, optional</span> |
---|
| 403 | <span class="sd"> Identifies the forecasting system used to generate the data.</span> |
---|
| 404 | <span class="sd"> E.g. oper (Atmospheric model), enfo (Ensemble forecats), ...</span> |
---|
| 405 | <span class="sd"> Default is an empty string.</span> |
---|
| 406 | |
---|
| 407 | <span class="sd"> area : str, optional</span> |
---|
| 408 | <span class="sd"> Specifies the desired sub-area of data to be extracted.</span> |
---|
| 409 | <span class="sd"> Areas can be defined to wrap around the globe.</span> |
---|
| 410 | |
---|
| 411 | <span class="sd"> Latitude values must be given as signed numbers, with:</span> |
---|
| 412 | <span class="sd"> north latitudes (i.e. north of the equator)</span> |
---|
| 413 | <span class="sd"> being positive (e.g: 40.5)</span> |
---|
| 414 | <span class="sd"> south latitutes (i.e. south of the equator)</span> |
---|
| 415 | <span class="sd"> being negative (e.g: -50.5)</span> |
---|
| 416 | <span class="sd"> Longtitude values must be given as signed numbers, with:</span> |
---|
| 417 | <span class="sd"> east longitudes (i.e. east of the 0 degree meridian)</span> |
---|
| 418 | <span class="sd"> being positive (e.g: 35.0)</span> |
---|
| 419 | <span class="sd"> west longitudes (i.e. west of the 0 degree meridian)</span> |
---|
| 420 | <span class="sd"> being negative (e.g: -20.5)</span> |
---|
| 421 | |
---|
| 422 | <span class="sd"> E.g.: North/West/South/East</span> |
---|
| 423 | <span class="sd"> Default is an empty string.</span> |
---|
| 424 | |
---|
| 425 | <span class="sd"> time : str, optional</span> |
---|
| 426 | <span class="sd"> Specifies the time of the data in hours and minutes.</span> |
---|
| 427 | <span class="sd"> Valid values depend on the type of data: Analysis time,</span> |
---|
| 428 | <span class="sd"> Forecast base time or First guess verification time</span> |
---|
| 429 | <span class="sd"> (all usually at synoptic hours: 00, 06, 12 and 18 ).</span> |
---|
| 430 | <span class="sd"> Observation time (any combination in hours and minutes is valid,</span> |
---|
| 431 | <span class="sd"> subject to data availability in the archive).</span> |
---|
| 432 | <span class="sd"> The syntax is HHMM or HH:MM. If MM is omitted it defaults to 00.</span> |
---|
| 433 | <span class="sd"> Default is an empty string.</span> |
---|
| 434 | |
---|
| 435 | <span class="sd"> step : str, optional</span> |
---|
| 436 | <span class="sd"> Specifies the forecast time step from forecast base time.</span> |
---|
| 437 | <span class="sd"> Valid values are hours (HH) from forecast base time. It also</span> |
---|
| 438 | <span class="sd"> specifies the length of the forecast which verifies at</span> |
---|
| 439 | <span class="sd"> First Guess time.</span> |
---|
| 440 | <span class="sd"> E.g. 1/3/6-hourly</span> |
---|
| 441 | <span class="sd"> Default is an empty string.</span> |
---|
| 442 | |
---|
| 443 | <span class="sd"> expver : str, optional</span> |
---|
| 444 | <span class="sd"> The version of the dataset. Each experiment is assigned a</span> |
---|
| 445 | <span class="sd"> unique code (version). Production data is assigned 1 or 2,</span> |
---|
| 446 | <span class="sd"> and experimental data in Operations 11, 12 ,...</span> |
---|
| 447 | <span class="sd"> Research or Member State's experiments have a four letter</span> |
---|
| 448 | <span class="sd"> experiment identifier.</span> |
---|
| 449 | <span class="sd"> Default is "1".</span> |
---|
| 450 | |
---|
| 451 | <span class="sd"> number : str, optional</span> |
---|
| 452 | <span class="sd"> Selects the member in ensemble forecast run. (Only then it</span> |
---|
| 453 | <span class="sd"> is necessary.) It has a different meaning depending on</span> |
---|
| 454 | <span class="sd"> the type of data.</span> |
---|
| 455 | <span class="sd"> E.g. Perturbed Forecasts: specifies the Ensemble forecast member</span> |
---|
| 456 | <span class="sd"> Default is an empty string.</span> |
---|
| 457 | |
---|
| 458 | <span class="sd"> accuracy : str, optional</span> |
---|
| 459 | <span class="sd"> Specifies the number of bits per value to be used in the</span> |
---|
| 460 | <span class="sd"> generated GRIB coded fields.</span> |
---|
| 461 | <span class="sd"> A positive integer may be given to specify the preferred number</span> |
---|
| 462 | <span class="sd"> of bits per packed value. This must not be greater than the</span> |
---|
| 463 | <span class="sd"> number of bits normally used for a Fortran integer on the</span> |
---|
| 464 | <span class="sd"> processor handling the request (typically 32 or 64 bit).</span> |
---|
| 465 | <span class="sd"> Within a compute request the accuracy of the original fields</span> |
---|
| 466 | <span class="sd"> can be passed to the result field by specifying accuracy=av.</span> |
---|
| 467 | <span class="sd"> Default is an empty string.</span> |
---|
| 468 | |
---|
| 469 | <span class="sd"> grid : str, optional</span> |
---|
| 470 | <span class="sd"> Specifies the output grid which can be either a Gaussian grid</span> |
---|
| 471 | <span class="sd"> or a Latitude/Longitude grid. MARS requests specifying</span> |
---|
| 472 | <span class="sd"> grid=av will return the archived model grid.</span> |
---|
| 473 | |
---|
| 474 | <span class="sd"> Lat/Lon grid: The grid spacing needs to be an integer</span> |
---|
| 475 | <span class="sd"> fraction of 90 degrees e.g. grid = 0.5/0.5</span> |
---|
| 476 | |
---|
| 477 | <span class="sd"> Gaussian grid: specified by a letter denoting the type of</span> |
---|
| 478 | <span class="sd"> Gaussian grid followed by an integer (the grid number)</span> |
---|
| 479 | <span class="sd"> representing the number of lines between the Pole and Equator,</span> |
---|
| 480 | <span class="sd"> e.g.</span> |
---|
| 481 | <span class="sd"> grid = F160 - full (or regular) Gaussian grid with</span> |
---|
| 482 | <span class="sd"> 160 latitude lines between the pole and equator</span> |
---|
| 483 | <span class="sd"> grid = N320 - ECMWF original reduced Gaussian grid with</span> |
---|
| 484 | <span class="sd"> 320 latitude lines between the pole and equator,</span> |
---|
| 485 | <span class="sd"> see Reduced Gaussian Grids for grid numbers used at ECMWF</span> |
---|
| 486 | <span class="sd"> grid = O640 - ECMWF octahedral (reduced) Gaussian grid with</span> |
---|
| 487 | <span class="sd"> 640 latitude lines between the pole and equator</span> |
---|
| 488 | <span class="sd"> Default is an empty string.</span> |
---|
| 489 | |
---|
| 490 | <span class="sd"> gaussian : str, optional</span> |
---|
| 491 | <span class="sd"> This parameter is deprecated and should no longer be used.</span> |
---|
| 492 | <span class="sd"> Specifies the desired type of Gaussian grid for the output.</span> |
---|
| 493 | <span class="sd"> Valid Gaussian grids are quasi-regular (reduced) or regular.</span> |
---|
| 494 | <span class="sd"> Keyword gaussian can only be specified together with</span> |
---|
| 495 | <span class="sd"> keyword grid. Gaussian without grid has no effect.</span> |
---|
| 496 | <span class="sd"> Default is an empty string.</span> |
---|
| 497 | |
---|
| 498 | <span class="sd"> target : str, optional</span> |
---|
| 499 | <span class="sd"> Specifies a file into which data is to be written after</span> |
---|
| 500 | <span class="sd"> retrieval or manipulation. Path names should always be</span> |
---|
| 501 | <span class="sd"> enclosed in double quotes. The MARS client supports automatic</span> |
---|
| 502 | <span class="sd"> generation of multiple target files using MARS keywords</span> |
---|
| 503 | <span class="sd"> enclosed in square brackets [ ]. If the environment variable</span> |
---|
| 504 | <span class="sd"> MARS_MULTITARGET_STRICT_FORMAT is set to 1 before calling mars,</span> |
---|
| 505 | <span class="sd"> the keyword values will be used in the filename as shown by</span> |
---|
| 506 | <span class="sd"> the ecCodes GRIB tool grib_ls -m, e.g. with</span> |
---|
| 507 | <span class="sd"> MARS_MULTITARGET_STRICT_FORMAT set to 1 the keywords time,</span> |
---|
| 508 | <span class="sd"> expver and param will be formatted as 0600, 0001 and 129.128</span> |
---|
| 509 | <span class="sd"> rather than 600, 1 and 129.</span> |
---|
| 510 | <span class="sd"> Default is an empty string.</span> |
---|
| 511 | |
---|
| 512 | <span class="sd"> param : str, optional</span> |
---|
| 513 | <span class="sd"> Specifies the meteorological parameter.</span> |
---|
| 514 | <span class="sd"> The list of meteorological parameters in MARS is extensive.</span> |
---|
| 515 | <span class="sd"> Their availability is directly related to their meteorological</span> |
---|
| 516 | <span class="sd"> meaning and, therefore, the rest of directives specified</span> |
---|
| 517 | <span class="sd"> in the MARS request.</span> |
---|
| 518 | <span class="sd"> Meteorological parameters can be specified by their</span> |
---|
| 519 | <span class="sd"> GRIB code (param=130), their mnemonic (param=t) or</span> |
---|
| 520 | <span class="sd"> full name (param=temperature).</span> |
---|
| 521 | <span class="sd"> The list of parameter should be seperated by a "/"-sign.</span> |
---|
| 522 | <span class="sd"> E.g. 130/131/133</span> |
---|
| 523 | <span class="sd"> Default is an empty string.</span> |
---|
| 524 | |
---|
| 525 | <span class="sd"> Return</span> |
---|
| 526 | <span class="sd"> ------</span> |
---|
| 527 | |
---|
| 528 | <span class="sd"> '''</span> |
---|
| 529 | |
---|
| 530 | <span class="bp">self</span><span class="o">.</span><span class="n">server</span> <span class="o">=</span> <span class="n">server</span> |
---|
| 531 | <span class="bp">self</span><span class="o">.</span><span class="n">public</span> <span class="o">=</span> <span class="n">public</span> |
---|
| 532 | <span class="bp">self</span><span class="o">.</span><span class="n">marsclass</span> <span class="o">=</span> <span class="n">marsclass</span> |
---|
| 533 | <span class="bp">self</span><span class="o">.</span><span class="n">dataset</span> <span class="o">=</span> <span class="n">dataset</span> |
---|
| 534 | <span class="bp">self</span><span class="o">.</span><span class="n">type</span> <span class="o">=</span> <span class="nb">type</span> |
---|
| 535 | <span class="bp">self</span><span class="o">.</span><span class="n">levtype</span> <span class="o">=</span> <span class="n">levtype</span> |
---|
| 536 | <span class="bp">self</span><span class="o">.</span><span class="n">levelist</span> <span class="o">=</span> <span class="n">levelist</span> |
---|
| 537 | <span class="bp">self</span><span class="o">.</span><span class="n">repres</span> <span class="o">=</span> <span class="n">repres</span> |
---|
| 538 | <span class="bp">self</span><span class="o">.</span><span class="n">date</span> <span class="o">=</span> <span class="n">date</span> |
---|
| 539 | <span class="bp">self</span><span class="o">.</span><span class="n">resol</span> <span class="o">=</span> <span class="n">resol</span> |
---|
| 540 | <span class="bp">self</span><span class="o">.</span><span class="n">stream</span> <span class="o">=</span> <span class="n">stream</span> |
---|
| 541 | <span class="bp">self</span><span class="o">.</span><span class="n">area</span> <span class="o">=</span> <span class="n">area</span> |
---|
| 542 | <span class="bp">self</span><span class="o">.</span><span class="n">time</span> <span class="o">=</span> <span class="n">time</span> |
---|
| 543 | <span class="bp">self</span><span class="o">.</span><span class="n">step</span> <span class="o">=</span> <span class="n">step</span> |
---|
| 544 | <span class="bp">self</span><span class="o">.</span><span class="n">expver</span> <span class="o">=</span> <span class="n">expver</span> |
---|
| 545 | <span class="bp">self</span><span class="o">.</span><span class="n">number</span> <span class="o">=</span> <span class="n">number</span> |
---|
| 546 | <span class="bp">self</span><span class="o">.</span><span class="n">accuracy</span> <span class="o">=</span> <span class="n">accuracy</span> |
---|
| 547 | <span class="bp">self</span><span class="o">.</span><span class="n">grid</span> <span class="o">=</span> <span class="n">grid</span> |
---|
| 548 | <span class="bp">self</span><span class="o">.</span><span class="n">gaussian</span> <span class="o">=</span> <span class="n">gaussian</span> |
---|
| 549 | <span class="bp">self</span><span class="o">.</span><span class="n">target</span> <span class="o">=</span> <span class="n">target</span> |
---|
| 550 | <span class="bp">self</span><span class="o">.</span><span class="n">param</span> <span class="o">=</span> <span class="n">param</span> |
---|
| 551 | |
---|
| 552 | <span class="k">return</span> |
---|
| 553 | |
---|
| 554 | |
---|
| 555 | <div class="viewcode-block" id="MarsRetrieval.display_info"><a class="viewcode-back" href="../Documentation/Api/api_python.html#MarsRetrieval.MarsRetrieval.display_info">[docs]</a> <span class="k">def</span> <span class="nf">display_info</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
---|
| 556 | <span class="sd">'''Prints all class attributes and their values to the</span> |
---|
| 557 | <span class="sd"> standard output.</span> |
---|
| 558 | |
---|
| 559 | <span class="sd"> Parameters</span> |
---|
| 560 | <span class="sd"> ----------</span> |
---|
| 561 | |
---|
| 562 | <span class="sd"> Return</span> |
---|
| 563 | <span class="sd"> ------</span> |
---|
| 564 | |
---|
| 565 | <span class="sd"> '''</span> |
---|
| 566 | <span class="c1"># Get all class attributes and their values as a dictionary</span> |
---|
| 567 | <span class="n">attrs</span> <span class="o">=</span> <span class="nb">vars</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> |
---|
| 568 | |
---|
| 569 | <span class="c1"># iterate through all attributes and print them</span> |
---|
| 570 | <span class="c1"># with their corresponding values</span> |
---|
| 571 | <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">attrs</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
---|
| 572 | <span class="k">if</span> <span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="ow">in</span> <span class="p">[</span><span class="s1">'server'</span><span class="p">,</span> <span class="s1">'public'</span><span class="p">]:</span> |
---|
| 573 | <span class="k">pass</span> |
---|
| 574 | <span class="k">else</span><span class="p">:</span> |
---|
| 575 | <span class="nb">print</span><span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="s1">': '</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">item</span><span class="p">[</span><span class="mi">1</span><span class="p">]))</span> |
---|
| 576 | |
---|
| 577 | <span class="k">return</span></div> |
---|
| 578 | |
---|
| 579 | |
---|
| 580 | <div class="viewcode-block" id="MarsRetrieval.print_infodata_csv"><a class="viewcode-back" href="../Documentation/Api/api_python.html#MarsRetrieval.MarsRetrieval.print_infodata_csv">[docs]</a> <span class="k">def</span> <span class="nf">print_infodata_csv</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inputdir</span><span class="p">,</span> <span class="n">request_number</span><span class="p">):</span> |
---|
| 581 | <span class="sd">'''Write all request parameter in alpabetical order into a "csv" file.</span> |
---|
| 582 | |
---|
| 583 | <span class="sd"> Parameters</span> |
---|
| 584 | <span class="sd"> ----------</span> |
---|
| 585 | <span class="sd"> inputdir : str</span> |
---|
| 586 | <span class="sd"> The path where all data from the retrievals are stored.</span> |
---|
| 587 | |
---|
| 588 | <span class="sd"> request_number : int</span> |
---|
| 589 | <span class="sd"> Number of mars requests for flux and non-flux data.</span> |
---|
| 590 | |
---|
| 591 | <span class="sd"> Return</span> |
---|
| 592 | <span class="sd"> ------</span> |
---|
| 593 | |
---|
| 594 | <span class="sd"> '''</span> |
---|
| 595 | |
---|
| 596 | <span class="c1"># Get all class attributes and their values as a dictionary</span> |
---|
| 597 | <span class="n">attrs</span> <span class="o">=</span> <span class="nb">vars</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> |
---|
| 598 | <span class="k">del</span> <span class="n">attrs</span><span class="p">[</span><span class="s1">'server'</span><span class="p">]</span> |
---|
| 599 | <span class="k">del</span> <span class="n">attrs</span><span class="p">[</span><span class="s1">'public'</span><span class="p">]</span> |
---|
| 600 | |
---|
| 601 | <span class="c1"># open a file to store all requests to</span> |
---|
| 602 | <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">inputdir</span><span class="p">,</span> |
---|
| 603 | <span class="n">_config</span><span class="o">.</span><span class="n">FILE_MARS_REQUESTS</span><span class="p">),</span> <span class="s1">'a'</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span> |
---|
| 604 | <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">request_number</span><span class="p">)</span> <span class="o">+</span> <span class="s1">', '</span><span class="p">)</span> |
---|
| 605 | <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">', '</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">attrs</span><span class="p">[</span><span class="n">key</span><span class="p">])</span> |
---|
| 606 | <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> |
---|
| 607 | <span class="n">f</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'</span><span class="se">\n</span><span class="s1">'</span><span class="p">)</span> |
---|
| 608 | |
---|
| 609 | <span class="k">return</span></div> |
---|
| 610 | |
---|
| 611 | <div class="viewcode-block" id="MarsRetrieval.data_retrieve"><a class="viewcode-back" href="../Documentation/Api/api_python.html#MarsRetrieval.MarsRetrieval.data_retrieve">[docs]</a> <span class="k">def</span> <span class="nf">data_retrieve</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
---|
| 612 | <span class="sd">'''Submits a MARS retrieval. Depending on the existence of</span> |
---|
| 613 | <span class="sd"> ECMWF Web-API or CDS API it is submitted via Python or a</span> |
---|
| 614 | <span class="sd"> subprocess in the Shell. The parameter for the mars retrieval</span> |
---|
| 615 | <span class="sd"> are taken from the defined class attributes.</span> |
---|
| 616 | |
---|
| 617 | <span class="sd"> Parameters</span> |
---|
| 618 | <span class="sd"> ----------</span> |
---|
| 619 | |
---|
| 620 | <span class="sd"> Return</span> |
---|
| 621 | <span class="sd"> ------</span> |
---|
| 622 | |
---|
| 623 | <span class="sd"> '''</span> |
---|
| 624 | <span class="c1"># Get all class attributes and their values as a dictionary</span> |
---|
| 625 | <span class="n">attrs</span> <span class="o">=</span> <span class="nb">vars</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> |
---|
| 626 | |
---|
| 627 | <span class="c1"># eliminate unnecessary attributes from the dictionary attrs</span> |
---|
| 628 | <span class="k">del</span> <span class="n">attrs</span><span class="p">[</span><span class="s1">'server'</span><span class="p">]</span> |
---|
| 629 | <span class="k">del</span> <span class="n">attrs</span><span class="p">[</span><span class="s1">'public'</span><span class="p">]</span> |
---|
| 630 | |
---|
| 631 | <span class="c1"># exchange parameter name for marsclass</span> |
---|
| 632 | <span class="n">mclass</span> <span class="o">=</span> <span class="n">attrs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'marsclass'</span><span class="p">)</span> |
---|
| 633 | <span class="k">del</span> <span class="n">attrs</span><span class="p">[</span><span class="s1">'marsclass'</span><span class="p">]</span> |
---|
| 634 | <span class="n">attrs</span><span class="p">[</span><span class="s1">'class'</span><span class="p">]</span> <span class="o">=</span> <span class="n">mclass</span> |
---|
| 635 | |
---|
| 636 | <span class="c1"># prepare target variable as needed for the Web API or CDS API mode</span> |
---|
| 637 | <span class="c1"># within the dictionary for full access</span> |
---|
| 638 | <span class="c1"># as a single variable for public access</span> |
---|
| 639 | <span class="n">target</span> <span class="o">=</span> <span class="n">attrs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'target'</span><span class="p">)</span> |
---|
| 640 | <span class="k">if</span> <span class="ow">not</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">public</span><span class="p">):</span> |
---|
| 641 | <span class="k">del</span> <span class="n">attrs</span><span class="p">[</span><span class="s1">'target'</span><span class="p">]</span> |
---|
| 642 | <span class="nb">print</span><span class="p">(</span><span class="s1">'target: '</span> <span class="o">+</span> <span class="n">target</span><span class="p">)</span> |
---|
| 643 | |
---|
| 644 | <span class="c1"># find all keys without a value and convert all other values to strings</span> |
---|
| 645 | <span class="n">empty_keys</span> <span class="o">=</span> <span class="p">[]</span> |
---|
| 646 | <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">attrs</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
---|
| 647 | <span class="k">if</span> <span class="n">value</span> <span class="o">==</span> <span class="s1">''</span><span class="p">:</span> |
---|
| 648 | <span class="n">empty_keys</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">key</span><span class="p">))</span> |
---|
| 649 | <span class="k">else</span><span class="p">:</span> |
---|
| 650 | <span class="n">attrs</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
---|
| 651 | |
---|
| 652 | <span class="c1"># delete all empty parameter from the dictionary</span> |
---|
| 653 | <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">empty_keys</span><span class="p">:</span> |
---|
| 654 | <span class="k">del</span> <span class="n">attrs</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> |
---|
| 655 | |
---|
[30f7911] | 656 | <span class="c1"># attrs['ppengine'] = 'emos'</span> |
---|
[0b00607] | 657 | |
---|
| 658 | <span class="c1"># MARS request via Python script</span> |
---|
| 659 | <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="p">:</span> |
---|
| 660 | <span class="k">try</span><span class="p">:</span> |
---|
| 661 | <span class="k">if</span> <span class="n">cds_api</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="p">,</span> <span class="n">cdsapi</span><span class="o">.</span><span class="n">Client</span><span class="p">):</span> |
---|
| 662 | <span class="nb">print</span><span class="p">(</span><span class="s1">'RETRIEVE ERA5 WITH CDS API!'</span><span class="p">)</span> |
---|
| 663 | <span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">retrieve</span><span class="p">(</span><span class="n">_config</span><span class="o">.</span><span class="n">CDS_DATASET</span><span class="p">,</span> |
---|
| 664 | <span class="n">attrs</span><span class="p">,</span> <span class="n">target</span><span class="p">)</span> |
---|
| 665 | <span class="k">elif</span> <span class="n">ec_api</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="p">,</span> <span class="n">ecmwfapi</span><span class="o">.</span><span class="n">ECMWFDataServer</span><span class="p">):</span> |
---|
| 666 | <span class="nb">print</span><span class="p">(</span><span class="s1">'RETRIEVE PUBLIC DATA (NOT ERA5)!'</span><span class="p">)</span> |
---|
| 667 | <span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">retrieve</span><span class="p">(</span><span class="n">attrs</span><span class="p">)</span> |
---|
| 668 | <span class="k">elif</span> <span class="n">ec_api</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="p">,</span> <span class="n">ecmwfapi</span><span class="o">.</span><span class="n">ECMWFService</span><span class="p">):</span> |
---|
| 669 | <span class="nb">print</span><span class="p">(</span><span class="s1">'EXECUTE NON-PUBLIC RETRIEVAL (NOT ERA5)!'</span><span class="p">)</span> |
---|
| 670 | <span class="bp">self</span><span class="o">.</span><span class="n">server</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">attrs</span><span class="p">,</span> <span class="n">target</span><span class="p">)</span> |
---|
| 671 | <span class="k">else</span><span class="p">:</span> |
---|
| 672 | <span class="nb">print</span><span class="p">(</span><span class="s1">'ERROR:'</span><span class="p">)</span> |
---|
| 673 | <span class="nb">print</span><span class="p">(</span><span class="s1">'No match for Web API instance!'</span><span class="p">)</span> |
---|
| 674 | <span class="k">raise</span> <span class="ne">IOError</span> |
---|
| 675 | <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span> |
---|
| 676 | <span class="nb">print</span><span class="p">(</span><span class="s1">'</span><span class="se">\n\n</span><span class="s1">MARS Request failed!'</span><span class="p">)</span> |
---|
| 677 | <span class="nb">print</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> |
---|
| 678 | <span class="nb">print</span><span class="p">(</span><span class="n">traceback</span><span class="o">.</span><span class="n">format_exc</span><span class="p">())</span> |
---|
| 679 | <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">()</span> |
---|
| 680 | |
---|
| 681 | <span class="c1"># MARS request via call in shell</span> |
---|
| 682 | <span class="k">else</span><span class="p">:</span> |
---|
| 683 | <span class="n">request_str</span> <span class="o">=</span> <span class="s1">'ret'</span> |
---|
| 684 | <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">attrs</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
---|
| 685 | <span class="n">request_str</span> <span class="o">=</span> <span class="n">request_str</span> <span class="o">+</span> <span class="s1">','</span> <span class="o">+</span> <span class="n">key</span> <span class="o">+</span> <span class="s1">'='</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
---|
| 686 | <span class="n">request_str</span> <span class="o">+=</span> <span class="s1">',target="'</span> <span class="o">+</span> <span class="n">target</span> <span class="o">+</span> <span class="s1">'"'</span> |
---|
[30f7911] | 687 | <span class="n">p</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">Popen</span><span class="p">([</span><span class="s1">'mars'</span><span class="p">],</span> <span class="c1">#'-e'],</span> |
---|
[0b00607] | 688 | <span class="n">stdin</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span> |
---|
| 689 | <span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span> |
---|
| 690 | <span class="n">stderr</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span> |
---|
| 691 | <span class="n">bufsize</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span> |
---|
| 692 | <span class="n">pout</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">communicate</span><span class="p">(</span><span class="nb">input</span><span class="o">=</span><span class="n">request_str</span><span class="o">.</span><span class="n">encode</span><span class="p">())[</span><span class="mi">0</span><span class="p">]</span> |
---|
| 693 | <span class="nb">print</span><span class="p">(</span><span class="n">pout</span><span class="o">.</span><span class="n">decode</span><span class="p">())</span> |
---|
| 694 | |
---|
| 695 | <span class="k">if</span> <span class="s1">'Some errors reported'</span> <span class="ow">in</span> <span class="n">pout</span><span class="o">.</span><span class="n">decode</span><span class="p">():</span> |
---|
| 696 | <span class="nb">print</span><span class="p">(</span><span class="s1">'MARS Request failed - please check request'</span><span class="p">)</span> |
---|
| 697 | <span class="k">raise</span> <span class="ne">IOError</span> |
---|
| 698 | <span class="k">elif</span> <span class="n">os</span><span class="o">.</span><span class="n">stat</span><span class="p">(</span><span class="n">target</span><span class="p">)</span><span class="o">.</span><span class="n">st_size</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
---|
| 699 | <span class="nb">print</span><span class="p">(</span><span class="s1">'MARS Request returned no data - please check request'</span><span class="p">)</span> |
---|
| 700 | <span class="k">raise</span> <span class="ne">IOError</span> |
---|
| 701 | |
---|
| 702 | <span class="k">return</span></div></div> |
---|
| 703 | </pre></div> |
---|
| 704 | |
---|
| 705 | </div> |
---|
| 706 | |
---|
| 707 | </div> |
---|
| 708 | <footer> |
---|
| 709 | |
---|
| 710 | |
---|
| 711 | <hr/> |
---|
| 712 | |
---|
| 713 | <div role="contentinfo"> |
---|
| 714 | <p> |
---|
[5bee29a] | 715 | © Copyright 2020, Anne Philipp, Leopold Haimberger and Petra Seibert |
---|
[0b00607] | 716 | |
---|
| 717 | </p> |
---|
| 718 | </div> |
---|
| 719 | 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>. |
---|
| 720 | |
---|
| 721 | </footer> |
---|
| 722 | |
---|
| 723 | </div> |
---|
| 724 | </div> |
---|
| 725 | |
---|
| 726 | </section> |
---|
| 727 | |
---|
| 728 | </div> |
---|
| 729 | |
---|
| 730 | |
---|
| 731 | |
---|
| 732 | <script type="text/javascript"> |
---|
| 733 | jQuery(function () { |
---|
| 734 | SphinxRtdTheme.Navigation.enable(true); |
---|
| 735 | }); |
---|
| 736 | </script> |
---|
| 737 | |
---|
| 738 | |
---|
| 739 | |
---|
| 740 | |
---|
| 741 | |
---|
| 742 | |
---|
| 743 | </body> |
---|
| 744 | </html> |
---|