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

ctbtodev
Last change on this file since b1674ed was b1674ed, checked in by Anne Philipp <anne.philipp@…>, 4 years ago

updated online documentation FIX for tickets #265 and #262

  • Property mode set to 100644
File size: 2.0 KB
RevLine 
[41c9dbc]1========
2Overview
3========
[0b00607]4
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 wants to use meteorological data from ECMWF to drive the ``FLEXPART`` model.
7The software retrieves the minimal number of parameters ``FLEXPART`` needs to work and provides the data in the explicity format ``FLEXPART`` understands.
8
9``Flex_extract`` consists of 2 main parts:
10    1. a Python part, where the reading of parameter settings, retrieving data from MARS and preparing the data for ``FLEXPART`` is done and
11    2. a Fortran part, where the calculation of the vertical velocity is done and if necessary the conversion from spectral to regular latitude/longitude grids.
12
13Additionally, it has some Korn shell scripts which are used 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.   
14
15A number of Shell scripts are wrapped around the software package for easy installation and fast job submission.
16
17The software depends on a number of third-party libraries which can be found in :ref:`ref-requirements`.
18
19Some details on the tasks and program worksteps are described in :doc:`Overview/prog_flow`.
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