source: trunk/README @ 405

Radme for YAO
==============

This directory contains source code for YAO, a framework for variational
assimilation in numerical models.
Copyright (c) 2001-onwards LOCEAN. All rights reserved.

This program may be redistributed and/or modified under the terms of the GNU
General Public License as published by the Free Software Foundation, either
version 2 of the license, or (at your option) any later version.

This program is provided AS IS and WITHOUT ANY WARRANTY, including any
implied warranty of DESIGN, MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.

LICENCE includes the standard GNU GPL version 2 license. See INSTALL for
installation procedure.

The source tree is organized as follow:

yao
  Top-level directory of the YAO code.
  yao/src
    Source code for the YAO generator.
  yao/share/
    Source code for the external libraries used into YAO: ANTLR for the grammar definition (with no restrictions on the use of the software) 
    and M1QN3 Inria for the cost function minimization method (under the GPLv3 licence).
  yao/bin
    The executable Yao9Generator for the generation of the code from the description file.
  yao/include
    Source code for useful YAO headers.

etc
  Some YAO tools.
  YaoI  
    the script for execution of the generator and the compilation of the generated code linked with the libraries.
  Yaorc.txt 
    the script that allows the initialization of some environment variables at installation time.
  YdfA
    the automatique differentiator.
  Others script useful for the users.

examples
  Some easy and more complex examples of yao. 
  examples/examplesTestYao9
    All the tests performed with Yao9. Look to the README in the directory examplesTestYao9 for more details.

doc
  All the YAO documentation.

INSTALL 
  The installation guide procedure.

LICENCE
  The GPL: GNU General Public Licence version 2.

README
  This file.