SABER
mainpage.h
Go to the documentation of this file.
1
#ifndef DOCS_MAINPAGE_H_
2
#define DOCS_MAINPAGE_H_
3
4
// This file defines what appears on the Main Page of the documentation
5
// generated by doxygen. The file contains no code, and does not appear
6
// in any cpp include statement.
7
//
8
/*!
9
* \mainpage System Agnostic Background Error Representation
10
*
11
* \section IntroSection Introduction
12
* Welcome to the documentation for the System Agnostic Background Error
13
* Representation (SABER)
14
*
15
* \section DirStructure Directory structure
16
* The SABER repository is organized as follows:
17
* - **CI**: continuous integration setup files and scripts
18
* - **cmake**: SABER-specific compiler flags
19
* - **docs**: documentation
20
* - **src**: source code
21
* - **saber**: SABER source code
22
* - **bump**: BUMP core and interfaces
23
* - **external**: external tools
24
* - **gaugrid**: Gaussian grid tools
25
* - **interpolation**: interpolation interface
26
* - **oops**: OOPS interface
27
* - **util**: shared tools
28
* - **test**: testing tools and source code
29
* - **mains**: executables sources
30
* - **model**: model-specific interfaces for the BUMP executable
31
* - **testinput**: input YAML files
32
* - **testlist**: lists of tests, data and reference files
33
* - **tools**: useful bash and python scripts
34
* - **saber_plot**:
35
*
36
* \section CLOC Code size and characteristics
37
* Code report obtained with [CLOC](https://github.com/AlDanial/cloc).
38
39
* \subsection dir_0 src/saber/bump
40
* | language | files | blank | comment | code | comment/code ratio |
41
* |:--------:|:--------:|:--------:|:--------:|:--------:|:--------:|
42
* | Fortran 90 | 35 | 5182 | 8118 | 20634 | 39 % |
43
* | C/C++ Header | 1 | 6 | 7 | 39 | 17 % |
44
* | C | 1 | 2 | 6 | 21 | 28 % |
45
* | SUM | 37 | 5190 | 8131 | 20694 | 39 % |
46
*
47
* \subsection dir_1 src/saber/external
48
* | language | files | blank | comment | code | comment/code ratio |
49
* |:--------:|:--------:|:--------:|:--------:|:--------:|:--------:|
50
* | Fortran 90 | 4 | 366 | 1672 | 1766 | 94 % |
51
* | SUM | 4 | 366 | 1672 | 1766 | 94 % |
52
*
53
* \subsection dir_2 src/saber/gaugrid
54
* | language | files | blank | comment | code | comment/code ratio |
55
* |:--------:|:--------:|:--------:|:--------:|:--------:|:--------:|
56
* | Fortran 90 | 1 | 59 | 87 | 102 | 85 % |
57
* | SUM | 1 | 59 | 87 | 102 | 85 % |
58
*
59
* \subsection dir_3 src/saber/interpolation
60
* | language | files | blank | comment | code | comment/code ratio |
61
* |:--------:|:--------:|:--------:|:--------:|:--------:|:--------:|
62
* | Fortran 90 | 2 | 165 | 231 | 407 | 56 % |
63
* | C/C++ Header | 2 | 23 | 19 | 56 | 33 % |
64
* | C++ | 1 | 12 | 17 | 41 | 41 % |
65
* | SUM | 5 | 200 | 267 | 504 | 52 % |
66
*
67
* \subsection dir_4 src/saber/oops
68
* | language | files | blank | comment | code | comment/code ratio |
69
* |:--------:|:--------:|:--------:|:--------:|:--------:|:--------:|
70
* | C/C++ Header | 13 | 342 | 233 | 1192 | 19 % |
71
* | SUM | 13 | 342 | 233 | 1192 | 19 % |
72
*
73
* \subsection dir_5 src/saber/util
74
* | language | files | blank | comment | code | comment/code ratio |
75
* |:--------:|:--------:|:--------:|:--------:|:--------:|:--------:|
76
* | Fortran 90 | 9 | 1170 | 1646 | 2695 | 61 % |
77
* | Fortran 77 | 2 | 28 | 37 | 102 | 36 % |
78
* | SUM | 11 | 1198 | 1683 | 2797 | 60 % |
79
*
80
* \subsection dir_6 test/mains
81
* | language | files | blank | comment | code | comment/code ratio |
82
* |:--------:|:--------:|:--------:|:--------:|:--------:|:--------:|
83
* | Fortran 90 | 2 | 168 | 279 | 731 | 38 % |
84
* | C++ | 5 | 12 | 41 | 67 | 61 % |
85
* | SUM | 7 | 180 | 320 | 798 | 40 % |
86
*
87
*/
88
89
#endif // DOCS_MAINPAGE_H_
fv3-bundle
saber
docs
mainpage.h
Generated on Sun Oct 25 2020 09:22:31 for SABER by
1.8.18