source: flex_extract.git/documentation/Sphinx/build/html/genindex.html @ 274f9ef

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

Converted docstrings to numpy style and build first structure for sphinxdocumentation (incl API)
  • Property mode set to 100644
File size: 15.2 KB
Line 
1
2
3
4<!DOCTYPE html>
5<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
6<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
7<head>
8  <meta charset="utf-8">
9 
10  <meta name="viewport" content="width=device-width, initial-scale=1.0">
11 
12  <title>Index &mdash; flex_extract 7.1 alpha documentation</title>
13 
14
15 
16 
17 
18 
19
20 
21
22 
23 
24   
25
26 
27
28  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
29  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
30    <link rel="index" title="Index" href="#" />
31    <link rel="search" title="Search" href="search.html" /> 
32
33 
34  <script src="_static/js/modernizr.min.js"></script>
35
36</head>
37
38<body class="wy-body-for-nav">
39
40   
41  <div class="wy-grid-for-nav">
42
43   
44    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
45      <div class="wy-side-scroll">
46        <div class="wy-side-nav-search">
47         
48
49         
50            <a href="index.html" class="icon icon-home"> flex_extract
51         
52
53         
54          </a>
55
56         
57           
58           
59              <div class="version">
60                7.1
61              </div>
62           
63         
64
65         
66<div role="search">
67  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
68    <input type="text" name="q" placeholder="Search docs" />
69    <input type="hidden" name="check_keywords" value="yes" />
70    <input type="hidden" name="area" value="default" />
71  </form>
72</div>
73
74         
75        </div>
76
77        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
78         
79           
80           
81             
82           
83           
84              <p class="caption"><span class="caption-text">Table of Contents:</span></p>
85<ul>
86<li class="toctree-l1"><a class="reference internal" href="downloads.html">Downloads</a></li>
87<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
88<li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li>
89<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
90<li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a></li>
91<li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li>
92</ul>
93
94           
95         
96        </div>
97      </div>
98    </nav>
99
100    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
101
102     
103      <nav class="wy-nav-top" aria-label="top navigation">
104       
105          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
106          <a href="index.html">flex_extract</a>
107       
108      </nav>
109
110
111      <div class="wy-nav-content">
112       
113        <div class="rst-content">
114       
115         
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131<div role="navigation" aria-label="breadcrumbs navigation">
132
133  <ul class="wy-breadcrumbs">
134   
135      <li><a href="index.html">Docs</a> &raquo;</li>
136       
137      <li>Index</li>
138   
139   
140      <li class="wy-breadcrumbs-aside">
141       
142           
143       
144      </li>
145   
146  </ul>
147
148 
149  <hr/>
150</div>
151          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
152           <div itemprop="articleBody">
153           
154
155<h1 id="index">Index</h1>
156
157<div class="genindex-jumpbox">
158 <a href="#A"><strong>A</strong></a>
159 | <a href="#C"><strong>C</strong></a>
160 | <a href="#D"><strong>D</strong></a>
161 | <a href="#E"><strong>E</strong></a>
162 | <a href="#G"><strong>G</strong></a>
163 | <a href="#I"><strong>I</strong></a>
164 | <a href="#M"><strong>M</strong></a>
165 | <a href="#N"><strong>N</strong></a>
166 | <a href="#P"><strong>P</strong></a>
167 | <a href="#R"><strong>R</strong></a>
168 | <a href="#S"><strong>S</strong></a>
169 | <a href="#T"><strong>T</strong></a>
170 | <a href="#U"><strong>U</strong></a>
171 | <a href="#W"><strong>W</strong></a>
172 
173</div>
174<h2 id="A">A</h2>
175<table style="width: 100%" class="indextable genindextable"><tr>
176  <td style="width: 33%; vertical-align: top;"><ul>
177      <li><a href="api.html#ControlFile.ControlFile.assign_args_to_control">assign_args_to_control() (ControlFile.ControlFile method)</a>
178</li>
179  </ul></td>
180  <td style="width: 33%; vertical-align: top;"><ul>
181      <li><a href="api.html#ControlFile.ControlFile.assign_envs_to_control">assign_envs_to_control() (ControlFile.ControlFile method)</a>
182</li>
183  </ul></td>
184</tr></table>
185
186<h2 id="C">C</h2>
187<table style="width: 100%" class="indextable genindextable"><tr>
188  <td style="width: 33%; vertical-align: top;"><ul>
189      <li><a href="api.html#ControlFile.ControlFile.check_conditions">check_conditions() (ControlFile.ControlFile method)</a>
190</li>
191      <li><a href="api.html#ControlFile.ControlFile.check_install_conditions">check_install_conditions() (ControlFile.ControlFile method)</a>
192</li>
193      <li><a href="api.html#tools.clean_up">clean_up() (in module tools)</a>
194</li>
195  </ul></td>
196  <td style="width: 33%; vertical-align: top;"><ul>
197      <li><a href="api.html#ControlFile.ControlFile">ControlFile (class in ControlFile)</a>
198
199      <ul>
200        <li><a href="api.html#module-ControlFile">(module)</a>
201</li>
202      </ul></li>
203      <li><a href="api.html#GribTools.GribTools.copy">copy() (GribTools.GribTools method)</a>
204</li>
205      <li><a href="api.html#EcFlexpart.EcFlexpart.create">create() (EcFlexpart.EcFlexpart method)</a>
206</li>
207  </ul></td>
208</tr></table>
209
210<h2 id="D">D</h2>
211<table style="width: 100%" class="indextable genindextable"><tr>
212  <td style="width: 33%; vertical-align: top;"><ul>
213      <li><a href="api.html#disaggregation.dapoly">dapoly() (in module disaggregation)</a>
214</li>
215      <li><a href="api.html#disaggregation.darain">darain() (in module disaggregation)</a>
216</li>
217      <li><a href="api.html#MarsRetrieval.MarsRetrieval.data_retrieve">data_retrieve() (MarsRetrieval.MarsRetrieval method)</a>
218</li>
219      <li><a href="api.html#EcFlexpart.EcFlexpart.deacc_fluxes">deacc_fluxes() (EcFlexpart.EcFlexpart method)</a>
220</li>
221  </ul></td>
222  <td style="width: 33%; vertical-align: top;"><ul>
223      <li><a href="api.html#install.delete_convert_build">delete_convert_build() (in module install)</a>
224</li>
225      <li><a href="api.html#UioFiles.UioFiles.delete_files">delete_files() (UioFiles.UioFiles method)</a>
226</li>
227      <li><a href="api.html#module-disaggregation">disaggregation (module)</a>
228</li>
229      <li><a href="api.html#MarsRetrieval.MarsRetrieval.display_info">display_info() (MarsRetrieval.MarsRetrieval method)</a>
230</li>
231      <li><a href="api.html#get_mars_data.do_retrievement">do_retrievement() (in module get_mars_data)</a>
232</li>
233  </ul></td>
234</tr></table>
235
236<h2 id="E">E</h2>
237<table style="width: 100%" class="indextable genindextable"><tr>
238  <td style="width: 33%; vertical-align: top;"><ul>
239      <li><a href="api.html#EcFlexpart.EcFlexpart">EcFlexpart (class in EcFlexpart)</a>
240
241      <ul>
242        <li><a href="api.html#module-EcFlexpart">(module)</a>
243</li>
244      </ul></li>
245  </ul></td>
246</tr></table>
247
248<h2 id="G">G</h2>
249<table style="width: 100%" class="indextable genindextable"><tr>
250  <td style="width: 33%; vertical-align: top;"><ul>
251      <li><a href="api.html#tools.get_cmdline_arguments">get_cmdline_arguments() (in module tools)</a>
252</li>
253      <li><a href="api.html#install.get_install_cmdline_arguments">get_install_cmdline_arguments() (in module install)</a>
254</li>
255      <li><a href="api.html#GribTools.GribTools.get_keys">get_keys() (GribTools.GribTools method)</a>
256</li>
257      <li><a href="api.html#tools.get_list_as_string">get_list_as_string() (in module tools)</a>
258</li>
259  </ul></td>
260  <td style="width: 33%; vertical-align: top;"><ul>
261      <li><a href="api.html#module-get_mars_data">get_mars_data (module)</a>
262</li>
263      <li><a href="api.html#get_mars_data.get_mars_data">get_mars_data() (in module get_mars_data)</a>
264</li>
265      <li><a href="api.html#GribTools.GribTools">GribTools (class in GribTools)</a>
266
267      <ul>
268        <li><a href="api.html#module-GribTools">(module)</a>
269</li>
270      </ul></li>
271  </ul></td>
272</tr></table>
273
274<h2 id="I">I</h2>
275<table style="width: 100%" class="indextable genindextable"><tr>
276  <td style="width: 33%; vertical-align: top;"><ul>
277      <li><a href="api.html#disaggregation.IA3">IA3() (in module disaggregation)</a>
278</li>
279      <li><a href="api.html#GribTools.GribTools.index">index() (GribTools.GribTools method)</a>
280</li>
281  </ul></td>
282  <td style="width: 33%; vertical-align: top;"><ul>
283      <li><a href="api.html#tools.init128">init128() (in module tools)</a>
284</li>
285      <li><a href="api.html#module-install">install (module)</a>
286</li>
287      <li><a href="api.html#install.install_via_gateway">install_via_gateway() (in module install)</a>
288</li>
289  </ul></td>
290</tr></table>
291
292<h2 id="M">M</h2>
293<table style="width: 100%" class="indextable genindextable"><tr>
294  <td style="width: 33%; vertical-align: top;"><ul>
295      <li><a href="api.html#get_mars_data.main">main() (in module get_mars_data)</a>
296
297      <ul>
298        <li><a href="api.html#install.main">(in module install)</a>
299</li>
300        <li><a href="api.html#prepare_flexpart.main">(in module prepare_flexpart)</a>
301</li>
302        <li><a href="api.html#submit.main">(in module submit)</a>
303</li>
304      </ul></li>
305      <li><a href="api.html#install.make_convert_build">make_convert_build() (in module install)</a>
306</li>
307      <li><a href="api.html#tools.make_dir">make_dir() (in module tools)</a>
308</li>
309  </ul></td>
310  <td style="width: 33%; vertical-align: top;"><ul>
311      <li><a href="api.html#MarsRetrieval.MarsRetrieval">MarsRetrieval (class in MarsRetrieval)</a>
312
313      <ul>
314        <li><a href="api.html#module-MarsRetrieval">(module)</a>
315</li>
316      </ul></li>
317      <li><a href="api.html#install.mk_compilejob">mk_compilejob() (in module install)</a>
318</li>
319      <li><a href="api.html#install.mk_env_vars">mk_env_vars() (in module install)</a>
320</li>
321      <li><a href="api.html#install.mk_job_template">mk_job_template() (in module install)</a>
322</li>
323      <li><a href="api.html#install.mk_tarball">mk_tarball() (in module install)</a>
324</li>
325      <li><a href="api.html#tools.my_error">my_error() (in module tools)</a>
326</li>
327  </ul></td>
328</tr></table>
329
330<h2 id="N">N</h2>
331<table style="width: 100%" class="indextable genindextable"><tr>
332  <td style="width: 33%; vertical-align: top;"><ul>
333      <li><a href="api.html#tools.none_or_int">none_or_int() (in module tools)</a>
334</li>
335  </ul></td>
336  <td style="width: 33%; vertical-align: top;"><ul>
337      <li><a href="api.html#tools.none_or_str">none_or_str() (in module tools)</a>
338</li>
339      <li><a href="api.html#tools.normal_exit">normal_exit() (in module tools)</a>
340</li>
341  </ul></td>
342</tr></table>
343
344<h2 id="P">P</h2>
345<table style="width: 100%" class="indextable genindextable"><tr>
346  <td style="width: 33%; vertical-align: top;"><ul>
347      <li><a href="api.html#module-prepare_flexpart">prepare_flexpart (module)</a>
348</li>
349      <li><a href="api.html#prepare_flexpart.prepare_flexpart">prepare_flexpart() (in module prepare_flexpart)</a>
350</li>
351      <li><a href="api.html#EcFlexpart.EcFlexpart.prepare_fp_files">prepare_fp_files() (EcFlexpart.EcFlexpart method)</a>
352</li>
353      <li><a href="api.html#MarsRetrieval.MarsRetrieval.print_info">print_info() (MarsRetrieval.MarsRetrieval method)</a>
354</li>
355  </ul></td>
356  <td style="width: 33%; vertical-align: top;"><ul>
357      <li><a href="api.html#MarsRetrieval.MarsRetrieval.print_infodata_csv">print_infodata_csv() (MarsRetrieval.MarsRetrieval method)</a>
358</li>
359      <li><a href="api.html#EcFlexpart.EcFlexpart.process_output">process_output() (EcFlexpart.EcFlexpart method)</a>
360</li>
361      <li><a href="api.html#tools.product">product() (in module tools)</a>
362</li>
363      <li><a href="api.html#tools.put_file_to_ecserver">put_file_to_ecserver() (in module tools)</a>
364</li>
365  </ul></td>
366</tr></table>
367
368<h2 id="R">R</h2>
369<table style="width: 100%" class="indextable genindextable"><tr>
370  <td style="width: 33%; vertical-align: top;"><ul>
371      <li><a href="api.html#tools.read_ecenv">read_ecenv() (in module tools)</a>
372</li>
373  </ul></td>
374  <td style="width: 33%; vertical-align: top;"><ul>
375      <li><a href="api.html#EcFlexpart.EcFlexpart.retrieve">retrieve() (EcFlexpart.EcFlexpart method)</a>
376</li>
377  </ul></td>
378</tr></table>
379
380<h2 id="S">S</h2>
381<table style="width: 100%" class="indextable genindextable"><tr>
382  <td style="width: 33%; vertical-align: top;"><ul>
383      <li><a href="api.html#GribTools.GribTools.set_keys">set_keys() (GribTools.GribTools method)</a>
384</li>
385      <li><a href="api.html#tools.silent_remove">silent_remove() (in module tools)</a>
386</li>
387  </ul></td>
388  <td style="width: 33%; vertical-align: top;"><ul>
389      <li><a href="api.html#module-submit">submit (module)</a>
390</li>
391      <li><a href="api.html#submit.submit">submit() (in module submit)</a>
392</li>
393      <li><a href="api.html#tools.submit_job_to_ecserver">submit_job_to_ecserver() (in module tools)</a>
394</li>
395  </ul></td>
396</tr></table>
397
398<h2 id="T">T</h2>
399<table style="width: 100%" class="indextable genindextable"><tr>
400  <td style="width: 33%; vertical-align: top;"><ul>
401      <li><a href="api.html#ControlFile.ControlFile.to_list">to_list() (ControlFile.ControlFile method)</a>
402</li>
403  </ul></td>
404  <td style="width: 33%; vertical-align: top;"><ul>
405      <li><a href="api.html#tools.to_param_id">to_param_id() (in module tools)</a>
406</li>
407      <li><a href="api.html#module-tools">tools (module)</a>
408</li>
409  </ul></td>
410</tr></table>
411
412<h2 id="U">U</h2>
413<table style="width: 100%" class="indextable genindextable"><tr>
414  <td style="width: 33%; vertical-align: top;"><ul>
415      <li><a href="api.html#UioFiles.UioFiles">UioFiles (class in UioFiles)</a>
416
417      <ul>
418        <li><a href="api.html#module-UioFiles">(module)</a>
419</li>
420      </ul></li>
421  </ul></td>
422  <td style="width: 33%; vertical-align: top;"><ul>
423      <li><a href="api.html#install.un_tarball">un_tarball() (in module install)</a>
424</li>
425  </ul></td>
426</tr></table>
427
428<h2 id="W">W</h2>
429<table style="width: 100%" class="indextable genindextable"><tr>
430  <td style="width: 33%; vertical-align: top;"><ul>
431      <li><a href="api.html#EcFlexpart.EcFlexpart.write_namelist">write_namelist() (EcFlexpart.EcFlexpart method)</a>
432</li>
433  </ul></td>
434</tr></table>
435
436
437
438           </div>
439           
440          </div>
441          <footer>
442 
443
444  <hr/>
445
446  <div role="contentinfo">
447    <p>
448        &copy; Copyright 2018, Anne Philipp and Leopold Haimberger.
449
450    </p>
451  </div>
452  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>.
453
454</footer>
455
456        </div>
457      </div>
458
459    </section>
460
461  </div>
462 
463
464
465 
466
467    <script type="text/javascript">
468        var DOCUMENTATION_OPTIONS = {
469            URL_ROOT:'./',
470            VERSION:'7.1 alpha',
471            LANGUAGE:'None',
472            COLLAPSE_INDEX:false,
473            FILE_SUFFIX:'.html',
474            HAS_SOURCE:  true,
475            SOURCELINK_SUFFIX: '.txt'
476        };
477    </script>
478      <script type="text/javascript" src="_static/jquery.js"></script>
479      <script type="text/javascript" src="_static/underscore.js"></script>
480      <script type="text/javascript" src="_static/doctools.js"></script>
481      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
482
483 
484
485  <script type="text/javascript" src="_static/js/theme.js"></script>
486
487  <script type="text/javascript">
488      jQuery(function () {
489          SphinxRtdTheme.Navigation.enable(true);
490      });
491  </script> 
492
493</body>
494</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG