source: flex_extract.git/for_developers/Sphinx/source/documentation.rst @ 41c9dbc

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

Large update of Sphinx doc; moved Sphinx source to dev dir; Cleaned control files

  • Property mode set to 100644
File size: 2.1 KB
RevLine 
[41c9dbc]1=============
2Documentation
3=============
4       
5    Overview
6      - What is ``flex_extract``?
7     
8        - general overview
9        - motivation, aim
10        - directory structure
11       
12      - Software components
13        complete component structure (table or diagram)
14       
15        - Python package
16       
17          - Package diagram
18          - Files and modules as table with information about unit tests
19          - Api
20         
21        - Fortran program - CONVERT2
22       
23          - Package diagram
24          - Api
25         
26        - Wrapping shell-scripts
27       
28      - Dependencies
29      - General context (for who?, Usecases, work tree)
30      - Access to ECMWF
31      - Application modes
32      - Call tree
33      - Sequence diagram
34   
35    Control & Input Data
36      - Controlling files
37     
38        - setup.sh (explain input parameters)           
39        - job scripts
40        - compile job
41        - run[_local].sh
42       
43      - Input Data
44     
45        - CONTROL files
46       
47          - The CONTROL file
48          - CONTROL parameters
49          - Examples
50          - Changes and its downward compatibilities (eg M _ /grid)
51         
52        - ECMWF_ENV file
53        - Templates
54       
55    Output Data
56      - mars request file
57      - Mars grib files
58      - flux files
59      - index.idx
60      - CONTROL (neu)
61      - fort files
62      - EN* files
63     
64        - Usual  output
65        - Output for pure forecast
66        - Output for ensemble members
67        - Output for new precipitation disaggregation
68   
69    Disaggregation
70      - What is disaggregation?
71      - Why do we need it/ which fields?
72      - Method for precipitation
73     
74        - Old method
75        - New method
76        - Differences in resulting Gribfiles
77       
78      - Method for rest fields
79   
80    Vertical Coordinate
81      - Methods (GAUSS, ETA, OMEGA)
82      - CONVERT (Petra)
83   
84    Auto Generated Documentation
85      - Python
86      - Fortran
87
88   
89.. toctree::
90    :hidden:
91    :maxdepth: 2
92   
93    Documentation/overview
94    Documentation/input
95    Documentation/output
96    Documentation/disagg
97    Documentation/vertco
98    Documentation/api
99 
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG