FV3 Bundle
mainpage.h
Go to the documentation of this file.
1 /*
2  * (C) Copyright 2009-2016 ECMWF.
3  *
4  * This software is licensed under the terms of the Apache Licence Version 2.0
5  * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
6  * In applying this licence, ECMWF does not waive the privileges and immunities
7  * granted to it by virtue of its status as an intergovernmental organisation nor
8  * does it submit to any jurisdiction.
9  */
10 
11 #ifndef DOCUMENTS_MAINPAGE_H_
12 #define DOCUMENTS_MAINPAGE_H_
13 
14 // This file defines what appears on the Main Page of the documentation
15 // generated by doxygen. The file contains no code, and does not appear
16 // in any cpp include statement.
17 //
18 /*!
19  * \mainpage Object-Oriented Prediction System
20  *
21  * \section IntroSection Introduction
22  * Welcome to the documentation for the Object-Oriented Prediction
23  * System (OOPS).
24  *
25  * OOPS consists of three layers. The top layer is written in C++, and
26  * defines a set of abstract (polymorphic) objects that are used to
27  * define the data assimilation algorithm.
28  * Below the abstract layer, we have concrete definitions for different
29  * models, also written in C++. Below this layer, is a set of Fortran
30  * routines that perform the computational, array-based tasks.
31  *
32  * \subsection TheModelsSubSection The Models
33  * Currently, the following models are available:
34  * - The Lorenz 1995 (40-variable) model.
35  * - A two-layer quasi-geostrophic model.
36  *
37  * \subsection WhereToStartSubSection Where to Start
38  * The general design of OOPS is described in the
39  * \link Overview Overview\endlink documents.
40  *
41  * The following function implements incremental weak-constraint 4d-Var,
42  * and may be a suitable starting point for exploring the code:
43  * - runVariational.h
44  *
45  * Instructions for running the models can be found in the
46  * \link README README\endlink file.
47  *
48  */
49 #endif // DOCUMENTS_MAINPAGE_H_