[41c9dbc] | 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 | |
---|
[0b00607] | 6 | ================================================= |
---|
| 7 | Welcome to ``flex_extract``'s user documentation! |
---|
| 8 | ================================================= |
---|
[41c9dbc] | 9 | |
---|
[0b00607] | 10 | ``Flex_extract`` is an open-source software to retrieve meteorological fields from the European Centre for Medium-Range Weather Forecasts (ECMWF) Mars archive to serve as input files for the FLEXTRA/FLEXPART Atmospheric Transport Modelling system. |
---|
[41c9dbc] | 11 | |
---|
| 12 | .. raw:: html |
---|
| 13 | |
---|
| 14 | <table style="width:100%;"> |
---|
| 15 | <tr> |
---|
| 16 | <td style="width:30%;height:150px;"> |
---|
| 17 | <div style="width:100%;height:60px;margin-left:20%;position:relative;"> |
---|
| 18 | <img style="position:absolute;height:90%;vertical-align:bottom;" src="_static/install_icon.png"> |
---|
| 19 | </div> |
---|
| 20 | <h2><a href="installation.html">Installation</a></h2> |
---|
| 21 | <ul> |
---|
| 22 | <li><a href="installation.html#ref-requirements">Environment requirements</a></li> |
---|
| 23 | <li><a href="installation.html#ref-download">Download flex_extract</a></li> |
---|
| 24 | <li><a href="installation.html#ref-install-fe">Install flex_extract</a></li> |
---|
| 25 | </ul> |
---|
| 26 | </td> |
---|
| 27 | <td style="width:30%;height:150px;"> |
---|
| 28 | <div style="width:100%;height:60px;margin-left:20%;position:relative;"> |
---|
[b1674ed] | 29 | <img style="position:absolute;height:90%;vertical-align:bottom;" src="_static/ecmwf_icon.png"> |
---|
[41c9dbc] | 30 | </div> |
---|
| 31 | <h2><a href="ecmwf_data.html">ECMWF data</a></h2> |
---|
| 32 | <ul> |
---|
| 33 | <li><a href="ecmwf_data.html">Overview</a></li> |
---|
| 34 | <li><a href="Ecmwf/access.html">Access Modes</a></li> |
---|
| 35 | <li><a href="Ecmwf/ec-links.html">Link Collection</a></li> |
---|
| 36 | </ul> |
---|
| 37 | </td> |
---|
| 38 | <td style="width:30%;height:150px;"> |
---|
| 39 | <div style="width:100%;height:60px;margin-left:20%;position:relative;"> |
---|
| 40 | <img style="position:absolute;height:90%;vertical-align:bottom;" src="_static/prog_icon.png"> |
---|
| 41 | </div> |
---|
| 42 | <h2><a href="documentation.html">Documentation</a></h2> |
---|
| 43 | <ul> |
---|
[eca358d] | 44 | <li><a href="Documentation/overview.html">Overview</a></li> |
---|
| 45 | <li><a href="Documentation/input.html">Control & Input Data</a></li> |
---|
| 46 | <li><a href="Documentation/output.html">Output Data</a></li> |
---|
[41c9dbc] | 47 | </ul> |
---|
| 48 | </td> |
---|
| 49 | </tr> |
---|
| 50 | <tr> |
---|
| 51 | <td style="width:30%;height:150px;"> |
---|
| 52 | <div style="width:100%;height:60px;margin-left:20%;position:relative;"> |
---|
| 53 | <img style="position:absolute;height:90%;vertical-align:bottom;" src="_static/guide_icon.png"> |
---|
| 54 | </div> |
---|
[0b00607] | 55 | <h2><a href="quick_start.html">Quick Start</a></h2> |
---|
[41c9dbc] | 56 | <ul> |
---|
[eca358d] | 57 | <li><a href="quick_start.html#job-preparation">Job preparation</a></li> |
---|
| 58 | <li><a href="quick_start.html#selection-and-adjustment-of-control-files">Handling CONTROL files</a></li> |
---|
| 59 | <li><a href="quick_start.html#hints-for-definition-of-some-parameter-combinations">Hints on parameter combinations</a></li> |
---|
[41c9dbc] | 60 | </ul> |
---|
| 61 | </td> |
---|
| 62 | <td style="width:30%;height:150px;"> |
---|
| 63 | <div style="width:100%;height:60px;margin-left:20%;position:relative;"> |
---|
[b1674ed] | 64 | <img style="position:absolute;height:90%;vertical-align:bottom;" src="_static/check_icon.png"> |
---|
[41c9dbc] | 65 | </div> |
---|
| 66 | <h2><a href="evaluation.html">Evaluation</a></h2> |
---|
| 67 | <ul> |
---|
[eca358d] | 68 | <li><a href="Evaluation/staticcode.html">Code</a></li> |
---|
| 69 | <li><a href="Evaluation/testcases.html">Functionality</a></li> |
---|
| 70 | <li><a href="Evaluation/metrics.html">Regression</a></li> |
---|
[41c9dbc] | 71 | </ul> |
---|
| 72 | </td> |
---|
| 73 | <td style="width:30%;height:150px;"> |
---|
| 74 | <div style="width:100%;height:60px;margin-left:20%;position:relative;"> |
---|
[b1674ed] | 75 | <img style="position:absolute;height:90%;vertical-align:bottom;" src="_static/dev_icon.png"> |
---|
[41c9dbc] | 76 | </div> |
---|
| 77 | <h2><a href="dev_guide.html">Developer</a></h2> |
---|
| 78 | <ul> |
---|
[eca358d] | 79 | <li><a href="Developers/gen_docu.html">Update Documentation</a></li> |
---|
| 80 | <li><a href=""></a><Placeholder></li> |
---|
| 81 | <li><a href=""></a><Placeholder></li> |
---|
[41c9dbc] | 82 | </ul> |
---|
| 83 | </td> |
---|
| 84 | </tr> |
---|
| 85 | </table> |
---|
| 86 | <table style="width:100%;"> |
---|
| 87 | <tr> |
---|
| 88 | <td style="width:15%"> |
---|
| 89 | </td> |
---|
| 90 | <td style="width:30%;height:150px;"> |
---|
| 91 | <div style="width:100%;height:60px;margin-left:10%;position:relative;"> |
---|
| 92 | <img style="position:absolute;height:90%;vertical-align:bottom;" src="_static/change_icon.png"> |
---|
| 93 | </div> |
---|
| 94 | <h2><a href="changelog.html">Changelog</a></h2> |
---|
| 95 | <ul> |
---|
[b1674ed] | 96 | <li><a href="changelog.html#ref-v711">v7.1.1</a></li> |
---|
[41c9dbc] | 97 | <li><a href="changelog.html#ref-v71">v7.1</a></li> |
---|
| 98 | <li><a href="changelog.html#ref-v704">v7.0.4</a></li> |
---|
| 99 | <li><a href="changelog.html#ref-v703">v7.0.3</a></li> |
---|
| 100 | </ul> |
---|
| 101 | </td> |
---|
| 102 | <td style="width:30%;height:150px;"> |
---|
| 103 | <div style="width:100%;height:60px;margin-left:10%;position:relative;"> |
---|
| 104 | <img style="position:absolute;height:100%;vertical-align:bottom;" src="_static/help_icon.png"> |
---|
| 105 | </div> |
---|
| 106 | <h2><a href="support.html">Support</a></h2> |
---|
| 107 | <ul> |
---|
| 108 | <li><a href="support.html#ref-ticket-system">Ticket system</a></li> |
---|
| 109 | <li><a href="support.html#ref-mailing-list">Mailing list</a></li> |
---|
| 110 | <li><a href="Support/known_bugs_issues.html">Known bugs or issues</a></li> |
---|
| 111 | <li><a href="Support/faq.html">FAQ</a></li> |
---|
| 112 | </ul> |
---|
| 113 | </td> |
---|
| 114 | <td style="width:10%"> |
---|
| 115 | </td> |
---|
| 116 | </tr> |
---|
| 117 | </table> |
---|
| 118 | <p></p> |
---|
| 119 | |
---|
| 120 | .. note:: |
---|
| 121 | |
---|
| 122 | .. figure:: _static/cc-by-40.png |
---|
| 123 | :width: 100px |
---|
| 124 | |
---|
| 125 | This work is licensed under the Creative Commons Attribution 4.0 |
---|
| 126 | International License. To view a copy of this license, visit |
---|
| 127 | http://creativecommons.org/licenses/by/4.0/ or send a letter to |
---|
| 128 | Creative Commons, PO Box 1866, Mountain View, CA 94042, USA. |
---|
| 129 | |
---|
| 130 | .. toctree:: |
---|
[30f7911] | 131 | :maxdepth: 4 |
---|
[41c9dbc] | 132 | :caption: Table of Contents: |
---|
| 133 | |
---|
| 134 | installation |
---|
[0b00607] | 135 | quick_start |
---|
[41c9dbc] | 136 | ecmwf_data |
---|
| 137 | documentation |
---|
| 138 | evaluation |
---|
| 139 | dev_guide |
---|
| 140 | changelog |
---|
| 141 | support |
---|
| 142 | Support/faq |
---|
| 143 | authors |
---|
| 144 | |
---|
| 145 | |
---|
| 146 | .. Indices and tables |
---|
| 147 | .. ================== |
---|
| 148 | |
---|
| 149 | .. * :ref:`genindex` |
---|
| 150 | .. * :ref:`modindex` |
---|
| 151 | .. * :ref:`search` |
---|
| 152 | |
---|