1 | Radme for YAO |
---|
2 | ============== |
---|
3 | |
---|
4 | This directory contains source code for YAO, a framework for variational |
---|
5 | assimilation in numerical models. |
---|
6 | Copyright (c) 2001-onwards LOCEAN. All rights reserved. |
---|
7 | |
---|
8 | This program may be redistributed and/or modified under the terms of the GNU |
---|
9 | General Public License as published by the Free Software Foundation, either |
---|
10 | version 2 of the license, or (at your option) any later version. |
---|
11 | |
---|
12 | This program is provided AS IS and WITHOUT ANY WARRANTY, including any |
---|
13 | implied warranty of DESIGN, MERCHANTABILITY or FITNESS FOR A PARTICULAR |
---|
14 | PURPOSE. |
---|
15 | |
---|
16 | LICENCE includes the standard GNU GPL version 2 license. See INSTALL for |
---|
17 | installation procedure. |
---|
18 | |
---|
19 | The source tree is organized as follow: |
---|
20 | |
---|
21 | yao |
---|
22 | Top-level directory of the YAO code. |
---|
23 | yao/src |
---|
24 | Source code for the YAO generator. |
---|
25 | yao/share/ |
---|
26 | Source code for the external libraries used into YAO: ANTLR for the grammar definition (with no restrictions on the use of the software) |
---|
27 | and M1QN3 Inria for the cost function minimization method (under the GPLv3 licence). |
---|
28 | yao/bin |
---|
29 | The executable Yao9Generator for the generation of the code from the description file. |
---|
30 | yao/include |
---|
31 | Source code for useful YAO headers. |
---|
32 | |
---|
33 | etc |
---|
34 | Some YAO tools. |
---|
35 | YaoI |
---|
36 | the script for execution of the generator and the compilation of the generated code linked with the libraries. |
---|
37 | Yaorc.txt |
---|
38 | the script that allows the initialization of some environment variables at installation time. |
---|
39 | YdfA |
---|
40 | the automatique differentiator. |
---|
41 | Others script useful for the users. |
---|
42 | |
---|
43 | examples |
---|
44 | Some easy and more complex examples of yao. |
---|
45 | examples/examplesTestYao9 |
---|
46 | All the tests performed with Yao9. Look to the README in the directory examplesTestYao9 for more details. |
---|
47 | |
---|
48 | doc |
---|
49 | All the YAO documentation. |
---|
50 | |
---|
51 | INSTALL |
---|
52 | The installation guide procedure. |
---|
53 | |
---|
54 | LICENCE |
---|
55 | The GPL: GNU General Public Licence version 2. |
---|
56 | |
---|
57 | README |
---|
58 | This file. |
---|
59 | |
---|
60 | |
---|