A central inventory of documentation for the ECMWF/Meteo-France IFS/Arpege forecast systems.
Five levels of documentation have been defined, which should be referred (as a best guess) for each piece or set of documentation that is added:
- Documentation close to the codes and the code commits, documentation at the time of Pull Requests (e.g. Git logs, bug-tracker tickets, etc.)
- Technical documentation automatically generated from the code (comments, additional Latex-style equations) using tools like “doxygen” or “ford”
- Scientific documentation: comprehensive documentation on equations however with no specific information on data flow, call trees, names of variables or namelist options
- Practical guides: namelists, how-to’s
- Documentation about ancillary tools (like SAPP, LOKI, etc.)
| Item | Value |
|---|---|
| Description | The high-level scientific documentation of the Integrated Forecasting System. |
| Format | |
| Type (1-5) | 3 |
| Owner | ECMWF |
| Visibility | Public |
| Comments |
| Item | Value |
|---|---|
| Description | A set of technical and scientific documents for some aspects of the common code and of ARPEGE and AROME models. Several various aspects are described, some are not. Some documents are user guides, others are more descriptive. |
| Format | HTML, PDF, PPT |
| Type (1-5) | 3, 4, 5 |
| Owner | Météo-France |
| Visibility | Public |
| Comments |
| Item | Value |
|---|---|
| Description | The reference scientific documentation for the Meso-NH and SURFEX models. |
| Format | |
| Type (1-5) | 3 |
| Owner | Météo-France & CNRS |
| Visibility | Public |
| Comments |
| Item | Value |
|---|---|
| Description | Documentation of the OpenIFS |
| Format | Web page |
| Type (1-5) | 3, 4 |
| Owner | ECMWF |
| Visibility | Public |
| Comments |