source: trunk/README @ 503

Radme for YAO
==============
Copyright or © or Copr. Luigi NARDI (2011/01/13)

e-mail of the author: luiginardi@gmail.com

This software is a framework for variational data assimilation in
numerical models.

This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software.  You can  use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".

As a counterpart to the access to the source code and  rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty  and the software's author,  the holder of the
economic rights,  and the successive licensors  have only  limited
liability.

In this respect, the user's attention is drawn to the risks associated
with loading,  using,  modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean  that it is complicated to manipulate,  and  that  also
therefore means  that it is reserved for developers  and  experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and,  more generally, to use and operate it in the
same conditions as regards security.

The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.

The CeCILL license is limited to the YAO software.
In directories:
yao/share/antlr-2.7.7
yao/share/inria
yao/share/boost_1_39_0/
the three bibliotheques are not under the CeCILL license.


###############################################################################
This directory contains source code for YAO 9.2 version.
This version contains the new class oriented archihtecture of YAO (version 9.0)
and the finalized work on automatic parallelization.
###############################################################################


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.