source: flex_extract.git/documentation/Sphinx/source/index.rst @ 274f9ef

.. flex_extract documentation master file, created by
   sphinx-quickstart on Wed Oct 17 18:39:05 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to flex_extract's user documentation!
=============================================

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. 


.. The scripts can be 1) executed locally using the ECMWF WebMARS interface, or 2) on the ECMWF member
.. state gateway server or HPC facility using the ecaccess software package. As another option the scripts can 3)
.. also be triggered using ecflow scheduling software used by ECMWF for data dissemination.

All required second party software and libraries used within flex_extract is open source and free of charge. 

.. raw:: html

    <table style="width:100%;">
      <tr>
        <td style="width:200px;height:150px;">
          <div style="width:200px;height:100px;">
          <img style="width:100px;vertical-align: bottom;" src="_static/download_icon.png">
          </div>
          <h2>Downloads</h2>
          <ul>
            <li><a href="">Download Tar-ball</a></li>
            <li><a href="">Git repository</a></li>
            <li><a href="">History of Changes</a></li>
          </ul>
        </td>        
        <td style="width:200px;height:150px;">
          <div style="width:200px;height:100px;">
          <img style="width:125px;vertical-align: bottom;" src="_static/prog_icon.png">
          </div>
          <h2>Program Structure</h2>
          <ul>
          <li><a href="">Overview</a></li>
          <li><a href="">Program components</a></li>
          <li><a href="">Program flow</a></li>
          </ul>
        </td>
      </tr>
      <tr>    
        <td style="width:200px;height:150px;">
          <div style="width:200px;height:100px;">
          <img style="width:100px;vertical-align: bottom;" src="_static/install_icon.png">
          </div>
          <h2>Installation</h2>
          <ul>
          <li><a href="requirements.html">Requirements</a></li>
          <li><a href="">Different operation modes</a></li>
          <li><a href="">Test the installation</a></li>
          </ul>
        </td>       
        <td style="width:200px;height:150px;">
          <div style="width:200px;height:100px;">
          <img style="width:100px;vertical-align: bottom;" src="_static/guide_icon.png">
          </div>
          <h2>User Guide</h2>
          <ul>
          <li><a href="">How to use</a></li>
          <li><a href="">Control templates</a></li>
          </ul>
        </td> 
      </tr>
      <tr>
        <td style="width:200px;height:150px;">
          <div style="width:200px;height:100px;">
          <img style="width:125px;vertical-align: bottom;" src="_static/api_icon.png">
          </div>
          <h2>API Index</h2>
          <ul>
          <li><a href="">Construction</a></li>
          </ul>
        </td>
        <td style="width:200px;height:150px;">
          <div style="width:200px;height:100px;">
          <img style="width:100px;vertical-align: bottom;" src="_static/help_icon.png">
          </div>
          <h2>Support</h2>
          <ul>
            <li><a href="">Ticket system</a></li>
            <li><a href="">Mailing list</a></li>
            <li><a href="">Known bugs or issues</a></li>
            <li><a href="">FAQ</a></li>
          </ul>
        </td>
      </tr>
    </table>
    <p></p>
    
.. note::
 
   License text put in here! Which one?

.. toctree::
   :maxdepth: 3
   :caption: Table of Contents:

   downloads
   installation
   program_structure
   user_guide
   api
   support
   

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`