| 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>Application Modes — flex_extract 7.1 alpha documentation</title> |
|---|
| 12 | |
|---|
| 13 | |
|---|
| 14 | |
|---|
| 15 | |
|---|
| 16 | |
|---|
| 17 | |
|---|
| 18 | |
|---|
| 19 | |
|---|
| 20 | <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script> |
|---|
| 21 | |
|---|
| 22 | |
|---|
| 23 | <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> |
|---|
| 24 | <script type="text/javascript" src="../../_static/jquery.js"></script> |
|---|
| 25 | <script type="text/javascript" src="../../_static/underscore.js"></script> |
|---|
| 26 | <script type="text/javascript" src="../../_static/doctools.js"></script> |
|---|
| 27 | <script type="text/javascript" src="../../_static/language_data.js"></script> |
|---|
| 28 | <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
|---|
| 29 | |
|---|
| 30 | <script type="text/javascript" src="../../_static/js/theme.js"></script> |
|---|
| 31 | |
|---|
| 32 | |
|---|
| 33 | |
|---|
| 34 | |
|---|
| 35 | <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
|---|
| 36 | <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
|---|
| 37 | <link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" /> |
|---|
| 38 | <link rel="stylesheet" href="../../_static/css/theme_overrides.css" type="text/css" /> |
|---|
| 39 | <link rel="index" title="Index" href="../../genindex.html" /> |
|---|
| 40 | <link rel="search" title="Search" href="../../search.html" /> |
|---|
| 41 | <link rel="next" title="Program Flow" href="prog_flow.html" /> |
|---|
| 42 | <link rel="prev" title="Overview" href="../overview.html" /> |
|---|
| 43 | </head> |
|---|
| 44 | |
|---|
| 45 | <body class="wy-body-for-nav"> |
|---|
| 46 | |
|---|
| 47 | |
|---|
| 48 | <div class="wy-grid-for-nav"> |
|---|
| 49 | |
|---|
| 50 | <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
|---|
| 51 | <div class="wy-side-scroll"> |
|---|
| 52 | <div class="wy-side-nav-search" > |
|---|
| 53 | |
|---|
| 54 | |
|---|
| 55 | |
|---|
| 56 | <a href="../../index.html" class="icon icon-home"> flex_extract |
|---|
| 57 | |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | </a> |
|---|
| 61 | |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | |
|---|
| 65 | <div class="version"> |
|---|
| 66 | 7.1 |
|---|
| 67 | </div> |
|---|
| 68 | |
|---|
| 69 | |
|---|
| 70 | |
|---|
| 71 | |
|---|
| 72 | <div role="search"> |
|---|
| 73 | <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> |
|---|
| 74 | <input type="text" name="q" placeholder="Search docs" /> |
|---|
| 75 | <input type="hidden" name="check_keywords" value="yes" /> |
|---|
| 76 | <input type="hidden" name="area" value="default" /> |
|---|
| 77 | </form> |
|---|
| 78 | </div> |
|---|
| 79 | |
|---|
| 80 | |
|---|
| 81 | </div> |
|---|
| 82 | |
|---|
| 83 | <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
|---|
| 84 | |
|---|
| 85 | |
|---|
| 86 | |
|---|
| 87 | |
|---|
| 88 | |
|---|
| 89 | |
|---|
| 90 | <p class="caption"><span class="caption-text">Table of Contents:</span></p> |
|---|
| 91 | <ul class="current"> |
|---|
| 92 | <li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li> |
|---|
| 93 | <li class="toctree-l1"><a class="reference internal" href="../../quick_start.html">Quick Start</a></li> |
|---|
| 94 | <li class="toctree-l1"><a class="reference internal" href="../../ecmwf_data.html">ECMWF Data</a></li> |
|---|
| 95 | <li class="toctree-l1 current"><a class="reference internal" href="../../documentation.html">Documentation</a><ul class="current"> |
|---|
| 96 | <li class="toctree-l2 current"><a class="reference internal" href="../overview.html">Overview</a><ul class="current"> |
|---|
| 97 | <li class="toctree-l3 current"><a class="current reference internal" href="#">Application Modes</a><ul class="simple"> |
|---|
| 98 | </ul> |
|---|
| 99 | </li> |
|---|
| 100 | <li class="toctree-l3"><a class="reference internal" href="prog_flow.html">Program Flow</a></li> |
|---|
| 101 | </ul> |
|---|
| 102 | </li> |
|---|
| 103 | <li class="toctree-l2"><a class="reference internal" href="../input.html">Control & Input Data</a></li> |
|---|
| 104 | <li class="toctree-l2"><a class="reference internal" href="../output.html">Output Data</a></li> |
|---|
| 105 | <li class="toctree-l2"><a class="reference internal" href="../disagg.html">Disaggregation of Flux Data</a></li> |
|---|
| 106 | <li class="toctree-l2"><a class="reference internal" href="../vertco.html">Vertical Coordinate</a></li> |
|---|
| 107 | <li class="toctree-l2"><a class="reference internal" href="../api.html">Auto Generated Documentation</a></li> |
|---|
| 108 | </ul> |
|---|
| 109 | </li> |
|---|
| 110 | <li class="toctree-l1"><a class="reference internal" href="../../evaluation.html">Evaluation</a></li> |
|---|
| 111 | <li class="toctree-l1"><a class="reference internal" href="../../dev_guide.html">Developer Guide</a></li> |
|---|
| 112 | <li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changelog</a></li> |
|---|
| 113 | <li class="toctree-l1"><a class="reference internal" href="../../support.html">Support</a></li> |
|---|
| 114 | <li class="toctree-l1"><a class="reference internal" href="../../Support/faq.html">FAQ - Frequently asked questions</a></li> |
|---|
| 115 | <li class="toctree-l1"><a class="reference internal" href="../../authors.html">Developer Team</a></li> |
|---|
| 116 | </ul> |
|---|
| 117 | |
|---|
| 118 | |
|---|
| 119 | |
|---|
| 120 | </div> |
|---|
| 121 | </div> |
|---|
| 122 | </nav> |
|---|
| 123 | |
|---|
| 124 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
|---|
| 125 | |
|---|
| 126 | |
|---|
| 127 | <nav class="wy-nav-top" aria-label="top navigation"> |
|---|
| 128 | |
|---|
| 129 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
|---|
| 130 | <a href="../../index.html">flex_extract</a> |
|---|
| 131 | |
|---|
| 132 | </nav> |
|---|
| 133 | |
|---|
| 134 | |
|---|
| 135 | <div class="wy-nav-content"> |
|---|
| 136 | |
|---|
| 137 | <div class="rst-content"> |
|---|
| 138 | |
|---|
| 139 | |
|---|
| 140 | |
|---|
| 141 | |
|---|
| 142 | |
|---|
| 143 | |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | <div role="navigation" aria-label="breadcrumbs navigation"> |
|---|
| 156 | |
|---|
| 157 | <ul class="wy-breadcrumbs"> |
|---|
| 158 | |
|---|
| 159 | <li><a href="../../index.html">Docs</a> »</li> |
|---|
| 160 | |
|---|
| 161 | <li><a href="../../documentation.html">Documentation</a> »</li> |
|---|
| 162 | |
|---|
| 163 | <li><a href="../overview.html">Overview</a> »</li> |
|---|
| 164 | |
|---|
| 165 | <li>Application Modes</li> |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | <li class="wy-breadcrumbs-aside"> |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | <a href="../../_sources/Documentation/Overview/app_modes.rst.txt" rel="nofollow"> View page source</a> |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | </li> |
|---|
| 175 | |
|---|
| 176 | </ul> |
|---|
| 177 | |
|---|
| 178 | |
|---|
| 179 | <hr/> |
|---|
| 180 | </div> |
|---|
| 181 | <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
|---|
| 182 | <div itemprop="articleBody"> |
|---|
| 183 | |
|---|
| 184 | <div class="section" id="application-modes"> |
|---|
| 185 | <h1>Application Modes<a class="headerlink" href="#application-modes" title="Permalink to this headline">¶</a></h1> |
|---|
| 186 | <p id="ref-app-modes">Arising from the two user groups described in <a class="reference internal" href="../../Ecmwf/access.html"><span class="doc">Access Modes</span></a>, <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> has 4 different <span class="underline">user application modes</span>:</p> |
|---|
| 187 | <blockquote id="ref-remote-desc"> |
|---|
| 188 | <div><ol class="arabic simple"> |
|---|
| 189 | <li><dl class="first docutils"> |
|---|
| 190 | <dt>Remote (member)</dt> |
|---|
| 191 | <dd>In the <strong>Remote mode</strong> the user works directly on ECMWF Linux member state server, such as <code class="docutils literal notranslate"><span class="pre">ecgate</span></code> or <code class="docutils literal notranslate"><span class="pre">cca</span></code>. The software will be installed in the <code class="docutils literal notranslate"><span class="pre">$HOME</span></code> directory. The user does not need to install any of the additional third-party libraries mentioned in <a class="reference internal" href="../../installation.html#ref-requirements"><span class="std std-ref">Environment requirements</span></a> as ECMWF provides everything with environment modules. The module selection will be done automatically in <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code>.</dd> |
|---|
| 192 | </dl> |
|---|
| 193 | </li> |
|---|
| 194 | </ol> |
|---|
| 195 | </div></blockquote> |
|---|
| 196 | <blockquote id="ref-gateway-desc"> |
|---|
| 197 | <div><ol class="arabic simple" start="2"> |
|---|
| 198 | <li><dl class="first docutils"> |
|---|
| 199 | <dt>Gateway (member)</dt> |
|---|
| 200 | <dd>The <strong>Gateway mode</strong> can be used if a local member state gateway server is in place. Then the job scripts can be submitted to the ECMWF Linux member state server via the ECMWF web access tool <code class="docutils literal notranslate"><span class="pre">ecaccess</span></code>. The installation script of <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> must be executed at the local gateway server such that the software will be installed in the <code class="docutils literal notranslate"><span class="pre">$HOME</span></code> directory at the ECMWF server and some extra setup is done in the local <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> directory at the local gateway server. For more information about establishing a gateway server please see section ???. For the <strong>Gateway mode</strong> the necessary environment has to be established which is described in <a class="reference internal" href="../../Installation/gateway.html#ref-prep-gateway"><span class="std std-ref">Prepare gateway environment</span></a>.</dd> |
|---|
| 201 | </dl> |
|---|
| 202 | </li> |
|---|
| 203 | </ol> |
|---|
| 204 | </div></blockquote> |
|---|
| 205 | <blockquote id="ref-local-desc"> |
|---|
| 206 | <div><ol class="arabic simple" start="3"> |
|---|
| 207 | <li><dl class="first docutils"> |
|---|
| 208 | <dt>Local member</dt> |
|---|
| 209 | <dd>Scripts are installed and executed on a local machine, either in the current <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> directory or in a path given to the installation script. Under this scenario a software environment similar to that at ECMWF is required. Additionally, Web API’s have to be installed to access ECMWF server. The complete installation process is described in <a class="reference internal" href="../../Installation/local.html#ref-local-mode"><span class="std std-ref">Local mode</span></a>.</dd> |
|---|
| 210 | </dl> |
|---|
| 211 | </li> |
|---|
| 212 | <li><dl class="first docutils"> |
|---|
| 213 | <dt>Local public</dt> |
|---|
| 214 | <dd>Scripts are installed and executed on a local machine, either in the current <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> directory or in a path given to the installation script. Under this scenario a software environment similar to that at ECMWF is required. Additionally, Web API’s have to be installed to access ECMWF server. The complete installation process is described in <a class="reference internal" href="../../Installation/local.html#ref-local-mode"><span class="std std-ref">Local mode</span></a>. In this case a direct registration at ECMWF is necessary and the user has to accept a specific license agreement for each dataset he/she intends to retrieve.</dd> |
|---|
| 215 | </dl> |
|---|
| 216 | </li> |
|---|
| 217 | </ol> |
|---|
| 218 | </div></blockquote> |
|---|
| 219 | <p>An overview is sketched in figure <a class="reference internal" href="#ref-fig-marsaccess"><span class="std std-ref">Application modes</span></a>.</p> |
|---|
| 220 | <div class="figure" id="id1"> |
|---|
| 221 | <span id="ref-fig-marsaccess"></span><img alt="../../_images/Diagramm_MarsAccess2.png" src="../../_images/Diagramm_MarsAccess2.png" /> |
|---|
| 222 | <p class="caption"><span class="caption-text">Application modes</span></p> |
|---|
| 223 | </div> |
|---|
| 224 | <div class="toctree-wrapper compound"> |
|---|
| 225 | </div> |
|---|
| 226 | </div> |
|---|
| 227 | |
|---|
| 228 | |
|---|
| 229 | </div> |
|---|
| 230 | |
|---|
| 231 | </div> |
|---|
| 232 | <footer> |
|---|
| 233 | |
|---|
| 234 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
|---|
| 235 | |
|---|
| 236 | <a href="prog_flow.html" class="btn btn-neutral float-right" title="Program Flow" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
|---|
| 237 | |
|---|
| 238 | |
|---|
| 239 | <a href="../overview.html" class="btn btn-neutral float-left" title="Overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
|---|
| 240 | |
|---|
| 241 | </div> |
|---|
| 242 | |
|---|
| 243 | |
|---|
| 244 | <hr/> |
|---|
| 245 | |
|---|
| 246 | <div role="contentinfo"> |
|---|
| 247 | <p> |
|---|
| 248 | © Copyright 2019, Anne Philipp and Leopold Haimberger |
|---|
| 249 | |
|---|
| 250 | </p> |
|---|
| 251 | </div> |
|---|
| 252 | 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>. |
|---|
| 253 | |
|---|
| 254 | </footer> |
|---|
| 255 | |
|---|
| 256 | </div> |
|---|
| 257 | </div> |
|---|
| 258 | |
|---|
| 259 | </section> |
|---|
| 260 | |
|---|
| 261 | </div> |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | <script type="text/javascript"> |
|---|
| 266 | jQuery(function () { |
|---|
| 267 | SphinxRtdTheme.Navigation.enable(true); |
|---|
| 268 | }); |
|---|
| 269 | </script> |
|---|
| 270 | |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | |
|---|
| 274 | |
|---|
| 275 | |
|---|
| 276 | </body> |
|---|
| 277 | </html> |
|---|
