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>Control & Input Data — 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="The Installation Script - setup.sh" href="Input/setup.html" /> |
---|
42 | <link rel="prev" title="Program Flow" href="Overview/prog_flow.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"><a class="reference internal" href="overview.html">Overview</a></li> |
---|
97 | <li class="toctree-l2 current"><a class="current reference internal" href="#">Control & Input Data</a><ul> |
---|
98 | <li class="toctree-l3"><a class="reference internal" href="Input/setup.html">The Installation Script - <code class="docutils literal notranslate"><span class="pre">setup.sh</span></code></a></li> |
---|
99 | <li class="toctree-l3"><a class="reference internal" href="Input/compilejob.html">The Compilation Jobscript <code class="docutils literal notranslate"><span class="pre">compilejob.ksh</span></code></a></li> |
---|
100 | <li class="toctree-l3"><a class="reference internal" href="Input/fortran_makefile.html">The Fortran Makefile - <code class="docutils literal notranslate"><span class="pre">CONVERT2</span></code></a></li> |
---|
101 | <li class="toctree-l3"><a class="reference internal" href="Input/run.html">The executable Script - <code class="docutils literal notranslate"><span class="pre">run.sh</span></code></a></li> |
---|
102 | <li class="toctree-l3"><a class="reference internal" href="Input/jobscript.html">The Jobscript <code class="docutils literal notranslate"><span class="pre">job.ksh</span></code></a></li> |
---|
103 | <li class="toctree-l3"><a class="reference internal" href="Input/control.html">The CONTROL file</a></li> |
---|
104 | <li class="toctree-l3"><a class="reference internal" href="Input/control_params.html">The CONTROL parameters</a></li> |
---|
105 | <li class="toctree-l3"><a class="reference internal" href="Input/examples.html">CONTROL file examples</a></li> |
---|
106 | <li class="toctree-l3"><a class="reference internal" href="Input/changes.html">CONTROL file changes</a></li> |
---|
107 | <li class="toctree-l3"><a class="reference internal" href="Input/ecmwf_env.html">ECMWF User Credential file <code class="docutils literal notranslate"><span class="pre">ECMWF_ENV</span></code></a></li> |
---|
108 | <li class="toctree-l3"><a class="reference internal" href="Input/templates.html">Templates</a></li> |
---|
109 | </ul> |
---|
110 | </li> |
---|
111 | <li class="toctree-l2"><a class="reference internal" href="output.html">Output Data</a></li> |
---|
112 | <li class="toctree-l2"><a class="reference internal" href="disagg.html">Disaggregation of Flux Data</a></li> |
---|
113 | <li class="toctree-l2"><a class="reference internal" href="vertco.html">Vertical Coordinate</a></li> |
---|
114 | <li class="toctree-l2"><a class="reference internal" href="api.html">Auto Generated Documentation</a></li> |
---|
115 | </ul> |
---|
116 | </li> |
---|
117 | <li class="toctree-l1"><a class="reference internal" href="../evaluation.html">Evaluation</a></li> |
---|
118 | <li class="toctree-l1"><a class="reference internal" href="../dev_guide.html">Developer Guide</a></li> |
---|
119 | <li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li> |
---|
120 | <li class="toctree-l1"><a class="reference internal" href="../support.html">Support</a></li> |
---|
121 | <li class="toctree-l1"><a class="reference internal" href="../Support/faq.html">FAQ - Frequently asked questions</a></li> |
---|
122 | <li class="toctree-l1"><a class="reference internal" href="../authors.html">Developer Team</a></li> |
---|
123 | </ul> |
---|
124 | |
---|
125 | |
---|
126 | |
---|
127 | </div> |
---|
128 | </div> |
---|
129 | </nav> |
---|
130 | |
---|
131 | <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
---|
132 | |
---|
133 | |
---|
134 | <nav class="wy-nav-top" aria-label="top navigation"> |
---|
135 | |
---|
136 | <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
---|
137 | <a href="../index.html">flex_extract</a> |
---|
138 | |
---|
139 | </nav> |
---|
140 | |
---|
141 | |
---|
142 | <div class="wy-nav-content"> |
---|
143 | |
---|
144 | <div class="rst-content"> |
---|
145 | |
---|
146 | |
---|
147 | |
---|
148 | |
---|
149 | |
---|
150 | |
---|
151 | |
---|
152 | |
---|
153 | |
---|
154 | |
---|
155 | |
---|
156 | |
---|
157 | |
---|
158 | |
---|
159 | |
---|
160 | |
---|
161 | |
---|
162 | <div role="navigation" aria-label="breadcrumbs navigation"> |
---|
163 | |
---|
164 | <ul class="wy-breadcrumbs"> |
---|
165 | |
---|
166 | <li><a href="../index.html">Docs</a> »</li> |
---|
167 | |
---|
168 | <li><a href="../documentation.html">Documentation</a> »</li> |
---|
169 | |
---|
170 | <li>Control & Input Data</li> |
---|
171 | |
---|
172 | |
---|
173 | <li class="wy-breadcrumbs-aside"> |
---|
174 | |
---|
175 | |
---|
176 | <a href="../_sources/Documentation/input.rst.txt" rel="nofollow"> View page source</a> |
---|
177 | |
---|
178 | |
---|
179 | </li> |
---|
180 | |
---|
181 | </ul> |
---|
182 | |
---|
183 | |
---|
184 | <hr/> |
---|
185 | </div> |
---|
186 | <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
---|
187 | <div itemprop="articleBody"> |
---|
188 | |
---|
189 | <div class="section" id="control-input-data"> |
---|
190 | <h1>Control & Input Data<a class="headerlink" href="#control-input-data" title="Permalink to this headline">¶</a></h1> |
---|
191 | <dl class="docutils"> |
---|
192 | <dt>Input Data</dt> |
---|
193 | <dd><ul class="first last"> |
---|
194 | <li><dl class="first docutils"> |
---|
195 | <dt><a class="reference internal" href="Input/control.html"><span class="doc">The CONTROL file</span></a></dt> |
---|
196 | <dd><p class="first"><code class="docutils literal notranslate"><span class="pre">Flex_extract</span></code> needs a number of controlling parameters to decide on the behaviour and the actual dataset to be retrieved. They are initialized by <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> with their default values and can be overwritten with definitions set in the so called <a class="reference internal" href="Input/control.html"><span class="doc">The CONTROL file</span></a>.</p> |
---|
197 | <p>To be able to successfully retrieve data from the ECMWF Mars archive it is necessary to understand these parameters and set them to proper and consistent values. They are described in <a class="reference internal" href="Input/control_params.html"><span class="doc">The CONTROL parameters</span></a> section.</p> |
---|
198 | <p class="last">We also have some <a class="reference internal" href="Input/examples.html"><span class="doc">CONTROL file examples</span></a> and description of <a class="reference internal" href="Input/changes.html"><span class="doc">CONTROL file changes</span></a> changes to previous versions and downward compatibilities.</p> |
---|
199 | </dd> |
---|
200 | </dl> |
---|
201 | </li> |
---|
202 | <li><dl class="first docutils"> |
---|
203 | <dt><a class="reference internal" href="Input/ecmwf_env.html"><span class="doc">ECMWF User Credential file ECMWF_ENV</span></a></dt> |
---|
204 | <dd><p class="first last">For <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> it is necessary to be able to reach ECMWF servers in the <strong>remote mode</strong> and the <strong>gateway mode</strong>. Therefore a <a class="reference internal" href="Input/ecmwf_env.html"><span class="doc">ECMWF User Credential file ECMWF_ENV</span></a> is created during the installation process.</p> |
---|
205 | </dd> |
---|
206 | </dl> |
---|
207 | </li> |
---|
208 | <li><dl class="first docutils"> |
---|
209 | <dt><a class="reference internal" href="Input/templates.html"><span class="doc">Templates</span></a></dt> |
---|
210 | <dd><p class="first last">A number of files which are created by <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> are taken from templates. This makes it easy to adapt for example the jobscripts regarding its settings for the batch jobs.</p> |
---|
211 | </dd> |
---|
212 | </dl> |
---|
213 | </li> |
---|
214 | </ul> |
---|
215 | </dd> |
---|
216 | </dl> |
---|
217 | <dl class="docutils" id="ref-controlling"> |
---|
218 | <dt>Controlling</dt> |
---|
219 | <dd><p class="first">The main tasks and behaviour of <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> are controlled by its Python scripts. There are two top-level scripts, one for installation called <a class="reference external" href="Input/setup.html#ref-install-script">install</a> and one for execution called <a class="reference external" href="Input/submit.html#ref-submit-script">submit</a>. |
---|
220 | They can interpret a number of command line arguments which can be seen by typing <code class="docutils literal notranslate"><span class="pre">--help</span></code> after the script call. Go to the root directory of <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> to type:</p> |
---|
221 | <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> flex_extract_vX.X |
---|
222 | python3 source/python/install.py --help |
---|
223 | python3 source/python/submit.py --help |
---|
224 | </pre></div> |
---|
225 | </div> |
---|
226 | <p>In this new version we provide also the wrapping Shell scripts <a class="reference external" href="Input/setup.html">setup</a> and <a class="reference external" href="Input/run.html">run</a>, which sets the command line parameters, do some checks and execute the corresponing Python scripts <code class="docutils literal notranslate"><span class="pre">install.py</span></code> and <code class="docutils literal notranslate"><span class="pre">submit.py</span></code> respectivley.</p> |
---|
227 | <p>It might be faster and easier for beginners. See <a class="reference internal" href="../quick_start.html"><span class="doc">Quick Start</span></a> for information on how to use them.</p> |
---|
228 | <p>Additionally, <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> creates the Korn Shell scripts <a class="reference internal" href="Input/compilejob.html"><span class="doc">The Compilation Jobscript compilejob.ksh</span></a> and <a class="reference internal" href="Input/jobscript.html"><span class="doc">The Jobscript job.ksh</span></a> which will be send to the ECMWF serves in the <strong>remote mode</strong> and the <strong>gateway mode</strong> for starting batch jobs.</p> |
---|
229 | <p>The Fortran program will be compiled during the installation process by the <a class="reference internal" href="Input/fortran_makefile.html"><span class="doc">The Fortran Makefile - CONVERT2</span></a>.</p> |
---|
230 | <p>To sum up, the following scripts controls <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code>:</p> |
---|
231 | <dl class="last docutils"> |
---|
232 | <dt>Installation</dt> |
---|
233 | <dd><ul class="first last simple"> |
---|
234 | <li><a class="reference internal" href="Input/setup.html"><span class="doc">The Installation Script - setup.sh</span></a></li> |
---|
235 | <li><a class="reference internal" href="Input/compilejob.html"><span class="doc">The Compilation Jobscript compilejob.ksh</span></a></li> |
---|
236 | <li><a class="reference internal" href="Input/fortran_makefile.html"><span class="doc">The Fortran Makefile - CONVERT2</span></a></li> |
---|
237 | </ul> |
---|
238 | </dd> |
---|
239 | <dt>Execution</dt> |
---|
240 | <dd><ul class="first last simple"> |
---|
241 | <li><a class="reference internal" href="Input/run.html"><span class="doc">The executable Script - run.sh</span></a></li> |
---|
242 | <li><a class="reference internal" href="Input/jobscript.html"><span class="doc">The Jobscript job.ksh</span></a></li> |
---|
243 | </ul> |
---|
244 | </dd> |
---|
245 | </dl> |
---|
246 | </dd> |
---|
247 | </dl> |
---|
248 | <div class="toctree-wrapper compound"> |
---|
249 | </div> |
---|
250 | </div> |
---|
251 | |
---|
252 | |
---|
253 | </div> |
---|
254 | |
---|
255 | </div> |
---|
256 | <footer> |
---|
257 | |
---|
258 | <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
---|
259 | |
---|
260 | <a href="Input/setup.html" class="btn btn-neutral float-right" title="The Installation Script - setup.sh" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
---|
261 | |
---|
262 | |
---|
263 | <a href="Overview/prog_flow.html" class="btn btn-neutral float-left" title="Program Flow" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
---|
264 | |
---|
265 | </div> |
---|
266 | |
---|
267 | |
---|
268 | <hr/> |
---|
269 | |
---|
270 | <div role="contentinfo"> |
---|
271 | <p> |
---|
272 | © Copyright 2019, Anne Philipp and Leopold Haimberger |
---|
273 | |
---|
274 | </p> |
---|
275 | </div> |
---|
276 | 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>. |
---|
277 | |
---|
278 | </footer> |
---|
279 | |
---|
280 | </div> |
---|
281 | </div> |
---|
282 | |
---|
283 | </section> |
---|
284 | |
---|
285 | </div> |
---|
286 | |
---|
287 | |
---|
288 | |
---|
289 | <script type="text/javascript"> |
---|
290 | jQuery(function () { |
---|
291 | SphinxRtdTheme.Navigation.enable(true); |
---|
292 | }); |
---|
293 | </script> |
---|
294 | |
---|
295 | |
---|
296 | |
---|
297 | |
---|
298 | |
---|
299 | |
---|
300 | </body> |
---|
301 | </html> |
---|