source: flex_extract.git/Documentation/html/installation.html @ d720895

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

updated online docu

  • Property mode set to 100644
File size: 22.8 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>Installation &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    <link rel="next" title="Remote mode installation" href="Installation/remote.html" />
42    <link rel="prev" title="Welcome to flex_extract’s user documentation!" href="index.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 current"><a class="current reference internal" href="#">Installation</a><ul>
93<li class="toctree-l2"><a class="reference internal" href="#registration-at-ecmwf">Registration at ECMWF</a></li>
94<li class="toctree-l2"><a class="reference internal" href="#licence-agreement-for-public-datasets">Licence agreement for public datasets</a></li>
95<li class="toctree-l2"><a class="reference internal" href="#download-flex-extract">Download <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code></a></li>
96<li class="toctree-l2"><a class="reference internal" href="#dependencies">Dependencies</a></li>
97<li class="toctree-l2"><a class="reference internal" href="#installation-of-flex-extract">Installation of <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code></a><ul>
98<li class="toctree-l3"><a class="reference internal" href="Installation/remote.html">Remote mode installation</a></li>
99<li class="toctree-l3"><a class="reference internal" href="Installation/gateway.html">Gateway mode installation</a></li>
100<li class="toctree-l3"><a class="reference internal" href="Installation/local.html">Local mode installation</a></li>
101</ul>
102</li>
103<li class="toctree-l2"><a class="reference internal" href="#flex-extract-in-combination-with-flexpart"><code class="docutils literal notranslate"><span class="pre">Flex_extract</span></code> in combination with <code class="docutils literal notranslate"><span class="pre">FLEXPART</span></code></a></li>
104<li class="toctree-l2"><a class="reference internal" href="#test-installation">Test installation</a><ul>
105<li class="toctree-l3"><a class="reference internal" href="#fortran-program-test">Fortran program test</a></li>
106<li class="toctree-l3"><a class="reference internal" href="#full-test">Full test</a></li>
107</ul>
108</li>
109</ul>
110</li>
111<li class="toctree-l1"><a class="reference internal" href="quick_start.html">Quick Start</a></li>
112<li class="toctree-l1"><a class="reference internal" href="ecmwf_data.html">ECMWF Data</a></li>
113<li class="toctree-l1"><a class="reference internal" href="documentation.html">Documentation</a></li>
114<li class="toctree-l1"><a class="reference internal" href="evaluation.html">Evaluation</a></li>
115<li class="toctree-l1"><a class="reference internal" href="dev_guide.html">Developer Guide</a></li>
116<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
117<li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li>
118<li class="toctree-l1"><a class="reference internal" href="Support/faq.html">FAQ - Frequently asked questions</a></li>
119<li class="toctree-l1"><a class="reference internal" href="authors.html">Developer Team</a></li>
120</ul>
121
122           
123         
124        </div>
125      </div>
126    </nav>
127
128    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
129
130     
131      <nav class="wy-nav-top" aria-label="top navigation">
132       
133          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
134          <a href="index.html">flex_extract</a>
135       
136      </nav>
137
138
139      <div class="wy-nav-content">
140       
141        <div class="rst-content">
142       
143         
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159<div role="navigation" aria-label="breadcrumbs navigation">
160
161  <ul class="wy-breadcrumbs">
162   
163      <li><a href="index.html">Docs</a> &raquo;</li>
164       
165      <li>Installation</li>
166   
167   
168      <li class="wy-breadcrumbs-aside">
169       
170           
171            <a href="_sources/installation.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="installation">
185<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
186<div class="toctree-wrapper compound">
187</div>
188<p>The <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> software package contains python and shell scripts as well as a Fortran program. These components rely on several libraries which need to be available before starting the installation process. Currently, the software is only tested for a GNU/Linux environment. Feel free to try it out on other platforms.</p>
189<p>At first, go to the <a class="reference external" href="Ecmwf/access.html">user group</a> section and decide which group you belong to and follow the instructions at <a class="reference internal" href="#ref-registration"><span class="std std-ref">Registration at ECMWF</span></a> to obtain an account at ECMWF (if you don’t have it already). Depending on the user group and the way to access the ECWMF MARS archive, there are four possible <a class="reference internal" href="Documentation/Overview/app_modes.html"><span class="doc">Application Modes</span></a>:</p>
190<ul class="simple">
191<li>Remote (member-state users only) <a class="reference internal" href="Installation/remote.html#ref-remote-mode"><span class="std std-ref">[installation]</span></a></li>
192<li>Gateway (member-state users only) <a class="reference internal" href="Installation/gateway.html#ref-gateway-mode"><span class="std std-ref">[installation]</span></a></li>
193<li>Local, member-state user <a class="reference internal" href="Installation/local.html#ref-local-mode"><span class="std std-ref">[installation]</span></a></li>
194<li>Local, public user <a class="reference internal" href="Installation/local.html#ref-local-mode"><span class="std std-ref">[installation]</span></a></li>
195</ul>
196<p>Please follow the link <a class="reference internal" href="Documentation/Overview/app_modes.html"><span class="doc">Application Modes</span></a> to get a description of the modes.</p>
197<div class="admonition note">
198<p class="first admonition-title">Note</p>
199<p class="last">If you encounter any problems in the installation process, you can ask for <a class="reference internal" href="support.html"><span class="doc">Support</span></a>.</p>
200</div>
201<div class="section" id="registration-at-ecmwf">
202<span id="ref-registration"></span><h2>Registration at ECMWF<a class="headerlink" href="#registration-at-ecmwf" title="Permalink to this headline"></a></h2>
203<p>The registration depends on the <a class="reference internal" href="Documentation/Overview/app_modes.html"><span class="doc">Application Modes</span></a> and in case of the local mode also on the data set you’d like to retrieve. The following table gives an overview where you need to register.</p>
204<table border="1" class="docutils">
205<colgroup>
206<col width="23%" />
207<col width="15%" />
208<col width="16%" />
209<col width="24%" />
210<col width="23%" />
211</colgroup>
212<tbody valign="top">
213<tr class="row-odd"><td rowspan="2">Data sets</td>
214<td colspan="3">Member-state user</td>
215<td>Public user</td>
216</tr>
217<tr class="row-even"><td>Remote</td>
218<td>Gateway</td>
219<td>Local</td>
220<td>Local</td>
221</tr>
222<tr class="row-odd"><td>Operational</td>
223<td>1</td>
224<td>1</td>
225<td>1,2</td>
226<td><ul class="first last simple">
227<li></li>
228</ul>
229</td>
230</tr>
231<tr class="row-even"><td>ERA-Interim</td>
232<td>1</td>
233<td>1</td>
234<td>1,2</td>
235<td>2</td>
236</tr>
237<tr class="row-odd"><td>CERA-20C</td>
238<td>1</td>
239<td>1</td>
240<td>1,2</td>
241<td>2</td>
242</tr>
243<tr class="row-even"><td>ERA5</td>
244<td>1</td>
245<td>1</td>
246<td>3</td>
247<td><ul class="first last simple">
248<li></li>
249</ul>
250</td>
251</tr>
252</tbody>
253</table>
254<p>Registration options:</p>
255<blockquote>
256<div><p>1.)  Access through a member-state user account granted by the <a class="reference external" href="https://www.ecmwf.int/en/about/contact-us/computing-representatives">Computing Representative</a>. The credentials have to be provided during installation.</p>
257<p>2.)  Access through the ECMWF Web API. Need to sign in at <a class="reference external" href="https://confluence.ecmwf.int/display/WEBAPI/ECMWF+Web+API+Home">ECMWF Web API</a> and configure the ECMWF key as described. Member-state users can sign in with their credentials from the <a class="reference external" href="https://www.ecmwf.int/en/about/contact-us/computing-representatives">Computing Representative</a> and public users have to fill out the <a class="reference external" href="https://apps.ecmwf.int/registration/">registration form</a> to get an account.</p>
258<p>3.) Access through the <a class="reference external" href="https://cds.climate.copernicus.eu/api-how-to">CDS API</a>. Extra registration for member-state users is required at <a class="reference external" href="https://cds.climate.copernicus.eu/user/register">Copernicus Climate Data Store</a> including the configurations of the CDS key as described. This mode is currently not available for public users. See the note at <a class="reference external" href="Ecmwf/access.html">user group</a> for information.</p>
259</div></blockquote>
260</div>
261<div class="section" id="licence-agreement-for-public-datasets">
262<span id="ref-licence"></span><h2>Licence agreement for public datasets<a class="headerlink" href="#licence-agreement-for-public-datasets" title="Permalink to this headline"></a></h2>
263<p>Each ECMWF public dataset has its own licence which has to be accepted, regardless of the user group.</p>
264<p>For the <em>ERA-Interim</em> and <em>CERA-20C</em> datasets this can be done at the ECMWF website <a class="reference external" href="https://confluence.ecmwf.int/display/WEBAPI/Available+ECMWF+Public+Datasets">Available ECMWF Public Datasets</a>. Log in and follow the licence links on the right side for each dataset and accept it.</p>
265<p>For the <em>ERA5</em> dataset this has to be done at the <a class="reference external" href="https://cds.climate.copernicus.eu/cdsapp#!/search?type=dataset">Climate Data Store (CDS) website</a>. Log in and select, on the left panel, product type “Reanalysis” for finding <em>ERA5</em> datasets. Then follow any link with <em>ERA5</em> to the full dataset record, click on tab “Download data” and scroll down. There is a section “Terms of use” where you have to click the <span class="underline">Accept terms</span> button.</p>
266</div>
267<div class="section" id="download-flex-extract">
268<span id="ref-download"></span><h2>Download <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code><a class="headerlink" href="#download-flex-extract" title="Permalink to this headline"></a></h2>
269<p>There are two options to download <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code>:</p>
270<dl class="docutils">
271<dt>tar ball</dt>
272<dd><p class="first">You can download a tar ball with the latest release from the <a class="reference external" href="https://www.flexpart.eu/wiki/FpInputMetEcmwf">flex_extract page</a> from our <code class="docutils literal notranslate"><span class="pre">FLEXPART</span></code> community website and then untar the file.</p>
273<div class="last highlight-bash notranslate"><div class="highlight"><pre><span></span>tar -xvf &lt;flex_extract_vX.X.tar&gt;
274</pre></div>
275</div>
276</dd>
277<dt>git repo</dt>
278<dd><p class="first">Alternatively, if you have <code class="docutils literal notranslate"><span class="pre">git</span></code> installed on your machine, and if you are interested to keep the code in a version control system, you may clone the latest version from our git repository master branch.</p>
279<div class="last highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git clone --single-branch --branch master https://www.flexpart.eu/gitmob/flexpart
280</pre></div>
281</div>
282</dd>
283</dl>
284</div>
285<div class="section" id="dependencies">
286<span id="ref-requirements"></span><h2>Dependencies<a class="headerlink" href="#dependencies" title="Permalink to this headline"></a></h2>
287<p>The software required for running <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> depends on the <a class="reference internal" href="Documentation/Overview/app_modes.html"><span class="doc">Application Modes</span></a> and therefore is described in the respective specific installation sections.</p>
288<p>Generally speaking, <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> requires <a class="reference external" href="https://docs.python.org/3/">Python 3</a> and Fortran together with certain modules / libraries.
289We tested <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> with the python3 package from the the GNU/Linux distribution and Anaconda Python. The required python3 modules should prefarably be installed as distribution packages, or alternatively using Python’s own package manager <code class="docutils literal notranslate"><span class="pre">pip</span></code> (this may mess up some aspects of your python installation, especially if you use <code class="docutils literal notranslate"><span class="pre">pip</span></code> as root. Think about using virtual environments.).</p>
290<p>Before installing the system packages check the availability with <code class="docutils literal notranslate"><span class="pre">dpkg</span> <span class="pre">-s</span> <span class="pre">&lt;package-name&gt;</span> <span class="pre">|</span>&#160; <span class="pre">grep</span> <span class="pre">Status</span></code> or <code class="docutils literal notranslate"><span class="pre">rpm</span> <span class="pre">-q</span> <span class="pre">&lt;package_name&gt;</span></code>, depending on your system. For example:</p>
291<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$ dpkg -s libeccodes-dev <span class="p">|</span>  grep Status
292<span class="c1"># or</span>
293$ rpm -q libeccodes-dev
294</pre></div>
295</div>
296</div>
297<div class="section" id="installation-of-flex-extract">
298<span id="ref-install-fe"></span><h2>Installation of <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code><a class="headerlink" href="#installation-of-flex-extract" title="Permalink to this headline"></a></h2>
299<p>The actual installation of <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> is done by executing a shell script called <code class="docutils literal notranslate"><span class="pre">setup.sh</span></code>.
300It defines some parameters and calls a Python script passing the parameters as command line arguments. For details, see <a class="reference internal" href="Documentation/Input/setup.html"><span class="doc">The Installation Script - setup.sh</span></a>.</p>
301<p>For each application mode installation section we describe the requirements for the explicit
302environment and how it is installed, test if it works and how the actual <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code>
303installation has to be done. At the users local side not all software has to be present for <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code>.</p>
304<p>Select one of the following modes to install:</p>
305<blockquote>
306<div><p><a class="reference internal" href="Installation/remote.html"><span class="doc">Remote mode installation</span></a></p>
307<p><a class="reference internal" href="Installation/gateway.html"><span class="doc">Gateway mode installation</span></a></p>
308<p><a class="reference internal" href="Installation/local.html"><span class="doc">Local mode installation</span></a></p>
309</div></blockquote>
310<div class="toctree-wrapper compound">
311</div>
312</div>
313<div class="section" id="flex-extract-in-combination-with-flexpart">
314<h2><code class="docutils literal notranslate"><span class="pre">Flex_extract</span></code> in combination with <code class="docutils literal notranslate"><span class="pre">FLEXPART</span></code><a class="headerlink" href="#flex-extract-in-combination-with-flexpart" title="Permalink to this headline"></a></h2>
315<p>Some users might wish to incorporate <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> directly into the <code class="docutils literal notranslate"><span class="pre">FLEXPART</span></code> distribution. Then the installation path has to be changed by setting the parameter <cite>installdir</cite> in the <code class="docutils literal notranslate"><span class="pre">setup.sh</span></code> file to the <code class="docutils literal notranslate"><span class="pre">script</span></code> directory in the <code class="docutils literal notranslate"><span class="pre">FLEXPART</span></code> root directoy.</p>
316</div>
317<div class="section" id="test-installation">
318<span id="ref-testinstallfe"></span><h2>Test installation<a class="headerlink" href="#test-installation" title="Permalink to this headline"></a></h2>
319<div class="section" id="fortran-program-test">
320<h3>Fortran program test<a class="headerlink" href="#fortran-program-test" title="Permalink to this headline"></a></h3>
321<p>To check whether the Fortran program <code class="docutils literal notranslate"><span class="pre">CONVERT2</span></code> has been compiled and runs properly, it can be applied to a prepared minimal dataset.</p>
322<p>For this, go from the <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> root directory to the <code class="docutils literal notranslate"><span class="pre">Testing/Installation/Convert/</span></code> directory and execute the Fortran program.</p>
323<div class="admonition note">
324<p class="first admonition-title">Note</p>
325<p class="last">Remember that you might have to log in at the ECMWF server if you used the installation for the <strong>remote</strong> or <strong>gateway</strong> mode. There you find the <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> root directory in your <code class="docutils literal notranslate"><span class="pre">$HOME</span></code> directory.</p>
326</div>
327<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> Testing/Installation/Convert
328<span class="c1"># execute the Fortran progam without arguments</span>
329../../../Source/Fortran/CONVERT2
330</pre></div>
331</div>
332<p>The installation was successfull if you obtain on standard output:</p>
333<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span> readspectral:            <span class="m">1</span>  records <span class="nb">read</span>
334 readlatlon:            <span class="m">8</span>  records <span class="nb">read</span>
335STATISTICS:  <span class="m">98842</span>.4598 <span class="m">98709</span>.7359  <span class="m">5120</span>.5385
336 readlatlon:            <span class="m">4</span>  records <span class="nb">read</span>
337 readlatlon:            <span class="m">4</span>  records <span class="nb">read</span>
338 readlatlon:            <span class="m">4</span>  records <span class="nb">read</span>
339SUCCESSFULLY FINISHED CONVERT_PRE: CONGRATULATIONS
340</pre></div>
341</div>
342<p>Now go back to the root directory:</p>
343<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> ../../../
344</pre></div>
345</div>
346</div>
347<div class="section" id="full-test">
348<h3>Full test<a class="headerlink" href="#full-test" title="Permalink to this headline"></a></h3>
349<blockquote>
350<div>see <a class="reference internal" href="quick_start.html"><span class="doc">Quick Start</span></a></div></blockquote>
351</div>
352</div>
353</div>
354
355
356           </div>
357           
358          </div>
359          <footer>
360 
361    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
362     
363        <a href="Installation/remote.html" class="btn btn-neutral float-right" title="Remote mode installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
364     
365     
366        <a href="index.html" class="btn btn-neutral float-left" title="Welcome to flex_extract’s user documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
367     
368    </div>
369 
370
371  <hr/>
372
373  <div role="contentinfo">
374    <p>
375        &copy; Copyright 2019, Anne Philipp and Leopold Haimberger
376
377    </p>
378  </div>
379  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>.
380
381</footer>
382
383        </div>
384      </div>
385
386    </section>
387
388  </div>
389 
390
391
392  <script type="text/javascript">
393      jQuery(function () {
394          SphinxRtdTheme.Navigation.enable(true);
395      });
396  </script>
397
398 
399 
400   
401   
402
403</body>
404</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG