                PARADISEO-PEO README FILE
=======================================================================
         check latest news at http://paradiseo.gforge.inria.fr/
=======================================================================

Welcome to ParadisEO-PEO, the Parallel Evolving Objects library.
The latest news about ParadisEO-PEO can be found on the gforge repository at
http://paradiseo.gforge.inria.fr/
In case of any problem, please e-mail us at
paradiseo-help@lists.gforge.inria.fr


=======================================================================
                        BUILDING PARADISEO-PEO
=======================================================================
The basic installation procedure goes the following.

To compile paradiseo-peo in the default directory,
go to paradiseo-peo/build/ and run:
    > cmake ../ -DEOdir=$(EO_SRC) -DMOdir=$(MO_SRC)
    > make
    // for an easy-use of the provided lessons
    > make install
    // optional (if the documentation is not already available)
    > make doc

To compile paradiseo-peo anywhere else, simply run:
    > cmake $(PEO) -DEOdir=$(EO_SRC) -DMOdir=$(MO_SRC)
    > make
    // for an easy-use of the provided lessons
    > make install
    // optional (if the documentation is not already available)
    > make doc

where $(EO_SRC) is the top-level source directory of PARADISEO-EO,
and $(MO) is the top-level directory of PARADISEO-MO.

To clean everything, simply run
    > make clean


===================================================================
                       DIRECTORY STRUCTURE
===================================================================
After unpacking the archive file, you should end up with the following
structure:

.../                     The main PARADISEO-PEO directory, created when unpacking.
   |
   +-- build             BUILD directory that contains libraries and executable files.
   |
   +-- src               SOURCE directory Contains most PARADISEO-PEO .h files. 
   |   
   +-- doc               DOCUMENTATION directory (generated by Doxygen).
   |   |
   |   +- html           HTML files - start at index.html. 
   |   |
   |   +- latex          latex files - use to generate Postcript doc.
   |   |
   |   +- man            Unix man format documentation.
   |
   |
   +-- tutorial          APPLICATIONS - one directory per separate application.
       |
       +-- examples      Examples repository including source code shared by all or most of the included lessons.
       |   |
       |   +- tsp        A Traveling Salesman Problem (TSP) example with benchmarks, the main operators, definitions, etc.
       |
       +-- Lesson1       A simple ParadisEO-PEO evolutionary algorithm example using the peoEA class.
       |
       +-- Lesson2       Example of an EA featuring a parallel evaluation of the population/parallel fitness function evaluation.
       |
       +-- Lesson3       Example of an asynchronous insular model including two evolutionary algorithms.
       |
       +-- Walkthrough   Walkthrough ParadisEO-PEO features - EA+LS hybridization, parallelization, insular model.

===================================================================
              NOTES
===================================================================

Mailing list : paradiseo-help@lists.gforge.inria.fr
