source: flex_extract.git/documentation/Sphinx/build/html/_sources/index.rst.txt @ db27c09

ctbtodev
Last change on this file since db27c09 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: 3.8 KB
Line 
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
6Welcome to flex_extract's user documentation!
7=============================================
8
9flex_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
16All required second party software and libraries used within flex_extract is open source and free of charge.
17
18
19.. raw:: html
20
21    <table style="width:100%;">
22      <tr>
23        <td style="width:200px;height:150px;">
24          <div style="width:200px;height:100px;">
25          <img style="width:100px;vertical-align: bottom;" src="_static/download_icon.png">
26          </div>
27          <h2>Downloads</h2>
28          <ul>
29            <li><a href="">Download Tar-ball</a></li>
30            <li><a href="">Git repository</a></li>
31            <li><a href="">History of Changes</a></li>
32          </ul>
33        </td>       
34        <td style="width:200px;height:150px;">
35          <div style="width:200px;height:100px;">
36          <img style="width:125px;vertical-align: bottom;" src="_static/prog_icon.png">
37          </div>
38          <h2>Program Structure</h2>
39          <ul>
40          <li><a href="">Overview</a></li>
41          <li><a href="">Program components</a></li>
42          <li><a href="">Program flow</a></li>
43          </ul>
44        </td>
45      </tr>
46      <tr>   
47        <td style="width:200px;height:150px;">
48          <div style="width:200px;height:100px;">
49          <img style="width:100px;vertical-align: bottom;" src="_static/install_icon.png">
50          </div>
51          <h2>Installation</h2>
52          <ul>
53          <li><a href="requirements.html">Requirements</a></li>
54          <li><a href="">Different operation modes</a></li>
55          <li><a href="">Test the installation</a></li>
56          </ul>
57        </td>       
58        <td style="width:200px;height:150px;">
59          <div style="width:200px;height:100px;">
60          <img style="width:100px;vertical-align: bottom;" src="_static/guide_icon.png">
61          </div>
62          <h2>User Guide</h2>
63          <ul>
64          <li><a href="">How to use</a></li>
65          <li><a href="">Control templates</a></li>
66          </ul>
67        </td>
68      </tr>
69      <tr>
70        <td style="width:200px;height:150px;">
71          <div style="width:200px;height:100px;">
72          <img style="width:125px;vertical-align: bottom;" src="_static/api_icon.png">
73          </div>
74          <h2>API Index</h2>
75          <ul>
76          <li><a href="">Construction</a></li>
77          </ul>
78        </td>
79        <td style="width:200px;height:150px;">
80          <div style="width:200px;height:100px;">
81          <img style="width:100px;vertical-align: bottom;" src="_static/help_icon.png">
82          </div>
83          <h2>Support</h2>
84          <ul>
85            <li><a href="">Ticket system</a></li>
86            <li><a href="">Mailing list</a></li>
87            <li><a href="">Known bugs or issues</a></li>
88            <li><a href="">FAQ</a></li>
89          </ul>
90        </td>
91      </tr>
92    </table>
93    <p></p>
94   
95.. note::
96 
97   License text put in here! Which one?
98
99.. toctree::
100   :maxdepth: 3
101   :caption: Table of Contents:
102
103   downloads
104   installation
105   program_structure
106   user_guide
107   api
108   support
109   
110
111Indices and tables
112==================
113
114* :ref:`genindex`
115* :ref:`modindex`
116* :ref:`search`
117
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG