Changeset 0b00607 in flex_extract.git for for_developers/Sphinx/source/documentation.rst


Ignore:
Timestamp:
Jul 29, 2019, 8:23:57 AM (5 years ago)
Author:
Anne Philipp <anne.philipp@…>
Branches:
master, ctbto, dev
Children:
bc27d19
Parents:
41c9dbc
Message:

Documentation status version 0

File:
1 edited

Legend:

Unmodified
Added
Removed

  • for_developers/Sphinx/source/documentation.rst

    r41c9dbc r0b00607  
    1 =============
     1*************
    22Documentation
    3 =============
     3*************
    44       
    5     Overview
    6       - What is ``flex_extract``?
     5    Overview (Under construction)
    76     
    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
     7    Control & Input Data
    348   
    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
     9    Output Data (Under construction)
    6810   
    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
     11    Disaggregation of Flux Data (Under construction)
    7912   
    80     Vertical Coordinate
     13    Vertical Coordinate (Under construction)
    8114      - Methods (GAUSS, ETA, OMEGA)
    82       - CONVERT (Petra)
     15      - CONVERT
    8316   
    8417    Auto Generated Documentation
    8518      - Python
    86       - Fortran
     19      - Fortran (Under construction)
    8720
    8821   
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG