1 | .. flex_extract documentation master file, created by |
---|
2 | sphinx-quickstart on Wed Oct 17 18:39:05 2018. |
---|
3 | You can adapt this file completely to your liking, but it should at least |
---|
4 | contain the root `toctree` directive. |
---|
5 | |
---|
6 | Welcome to flex_extract's user documentation! |
---|
7 | ============================================= |
---|
8 | |
---|
9 | flex_extract is a software to retrieve meteorological fields from the European Centre for Medium-Range Weather Forecasts (ECMWF) Mars archive to server as input files for the FLEXTRA/FLEXPART Atmospheric Transport Modelling system. |
---|
10 | |
---|
11 | |
---|
12 | .. The scripts can be 1) executed locally using the ECMWF WebMARS interface, or 2) on the ECMWF member |
---|
13 | .. state gateway server or HPC facility using the ecaccess software package. As another option the scripts can 3) |
---|
14 | .. also be triggered using ecflow scheduling software used by ECMWF for data dissemination. |
---|
15 | |
---|
16 | All third-party software and libraries required by flex_extract are open source and free of charge. |
---|
17 | |
---|
18 | .. raw:: html |
---|
19 | |
---|
20 | <table style="width:100%;"> |
---|
21 | <tr> |
---|
22 | <td style="width:200px;height:150px;"> |
---|
23 | <div style="width:200px;height:100px;"> |
---|
24 | <img style="width:100px;vertical-align: bottom;" src="_static/download_icon.png"> |
---|
25 | </div> |
---|
26 | <h2>Downloads</h2> |
---|
27 | <ul> |
---|
28 | <li><a href="">Download Tar-ball</a></li> |
---|
29 | <li><a href="">Git repository</a></li> |
---|
30 | <li><a href="">History of Changes</a></li> |
---|
31 | </ul> |
---|
32 | </td> |
---|
33 | <td style="width:200px;height:150px;"> |
---|
34 | <div style="width:200px;height:100px;"> |
---|
35 | <img style="width:125px;vertical-align: bottom;" src="_static/prog_icon.png"> |
---|
36 | </div> |
---|
37 | <h2>Program Structure</h2> |
---|
38 | <ul> |
---|
39 | <li><a href="">Overview</a></li> |
---|
40 | <li><a href="">Program components</a></li> |
---|
41 | <li><a href="">Program flow</a></li> |
---|
42 | </ul> |
---|
43 | </td> |
---|
44 | </tr> |
---|
45 | <tr> |
---|
46 | <td style="width:200px;height:150px;"> |
---|
47 | <div style="width:200px;height:100px;"> |
---|
48 | <img style="width:100px;vertical-align: bottom;" src="_static/install_icon.png"> |
---|
49 | </div> |
---|
50 | <h2>Installation</h2> |
---|
51 | <ul> |
---|
52 | <li><a href="requirements.html">Requirements</a></li> |
---|
53 | <li><a href="">Different operation modes</a></li> |
---|
54 | <li><a href="">Test the installation</a></li> |
---|
55 | </ul> |
---|
56 | </td> |
---|
57 | <td style="width:200px;height:150px;"> |
---|
58 | <div style="width:200px;height:100px;"> |
---|
59 | <img style="width:100px;vertical-align: bottom;" src="_static/guide_icon.png"> |
---|
60 | </div> |
---|
61 | <h2>User Guide</h2> |
---|
62 | <ul> |
---|
63 | <li><a href="">How to use</a></li> |
---|
64 | <li><a href="">Control templates</a></li> |
---|
65 | </ul> |
---|
66 | </td> |
---|
67 | </tr> |
---|
68 | <tr> |
---|
69 | <td style="width:200px;height:150px;"> |
---|
70 | <div style="width:200px;height:100px;"> |
---|
71 | <img style="width:125px;vertical-align: bottom;" src="_static/api_icon.png"> |
---|
72 | </div> |
---|
73 | <h2>API Index</h2> |
---|
74 | <ul> |
---|
75 | <li><a href="">Construction</a></li> |
---|
76 | </ul> |
---|
77 | </td> |
---|
78 | <td style="width:200px;height:150px;"> |
---|
79 | <div style="width:200px;height:100px;"> |
---|
80 | <img style="width:100px;vertical-align: bottom;" src="_static/help_icon.png"> |
---|
81 | </div> |
---|
82 | <h2>Support</h2> |
---|
83 | <ul> |
---|
84 | <li><a href="">Ticket system</a></li> |
---|
85 | <li><a href="">Mailing list</a></li> |
---|
86 | <li><a href="">Known bugs or issues</a></li> |
---|
87 | <li><a href="">FAQ</a></li> |
---|
88 | </ul> |
---|
89 | </td> |
---|
90 | </tr> |
---|
91 | </table> |
---|
92 | <p></p> |
---|
93 | |
---|
94 | .. note:: |
---|
95 | |
---|
96 | ![][/documentation/Sphinx/source/_static/cc-by-40.png] |
---|
97 | This work is licensed under the Creative Commons Attribution 4.0 |
---|
98 | International License. To view a copy of this license, visit |
---|
99 | http://creativecommons.org/licenses/by/4.0/ or send a letter to |
---|
100 | Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. |
---|
101 | |
---|
102 | .. toctree:: |
---|
103 | :maxdepth: 3 |
---|
104 | :caption: Table of Contents: |
---|
105 | |
---|
106 | downloads |
---|
107 | installation |
---|
108 | program_structure |
---|
109 | user_guide |
---|
110 | api |
---|
111 | support |
---|
112 | |
---|
113 | |
---|
114 | Indices and tables |
---|
115 | ================== |
---|
116 | |
---|
117 | * :ref:`genindex` |
---|
118 | * :ref:`modindex` |
---|
119 | * :ref:`search` |
---|
120 | |
---|