source: flex_extract.git/For_developers/Sphinx/source/Documentation/overview.rst @ f20342a

ctbtodev
Last change on this file since f20342a was f20342a, checked in by Petra Seibert <petra.seibert [at) univie.ac.at>, 4 years ago

Language corrections for the Sections Developers, Support, Changelog, and the home directory (index.html)

further improvment of documentation, close to final

  • Property mode set to 100644
File size: 1.9 KB
RevLine 
[41c9dbc]1========
2Overview
3========
[0b00607]4
[f20342a]5``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.
6``Flex_extract`` was created explicitly for ``FLEXPART`` users who want to use meteorological data from ECMWF to drive the ``FLEXPART`` model.
7The software retrieves the minimum set of parameters needed by ``FLEXPART`` to work, and provides the data in the specific format required by ``FLEXPART``.
[0b00607]8
[f20342a]9``Flex_extract`` consists of two main parts:
10    1. a Python part which reads the parameter settings, retrieves the data from MARS, and prepares them for ``FLEXPART``, and
11    2. a Fortran part which calculates the vertical velocity and, if necessary, converts variables from the spectral representation to regular latitude/longitude grids.
[0b00607]12
[f20342a]13In addition, there are some Korn shell scripts to set the environment and batch job features on ECMWF servers for the *gateway* and *remote* mode. See :doc:`Overview/app_modes` for information of application modes.   
[0b00607]14
15A number of Shell scripts are wrapped around the software package for easy installation and fast job submission.
16
[f20342a]17The software depends on some third-party libraries as listed in :ref:`ref-requirements`.
[0b00607]18
[f20342a]19Details of the tasks and program work steps are described in :doc:`Overview/prog_flow`.
[0b00607]20
21
22..  - directory structure (new diagramm!)
23           
24    - Software components - complete component structure (table or diagram)
25           
26       - Python package
27           
28           - Package diagram
29           - Files and modules as table with information about unit tests
30           - Api
31             
[b1674ed]32       - Fortran program - calc_etadot
[0b00607]33           
34           - Package diagram
35           - Api
36             
37
38
39
[41c9dbc]40
41   
42.. toctree::
43    :hidden:
44    :maxdepth: 2
45   
46    Overview/app_modes
47    Overview/prog_flow
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG