paradiseo/trunk/paradiseo-peo
legrand 8e66443dc4 cleaned cmake config
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@986 331e1502-861f-0410-8da2-ba01fb791d7f
2008-02-21 12:48:46 +00:00
..
doc deleted cl compiler flags and updated cmake config - also deleted lessons 6,7,8 2008-02-14 12:54:36 +00:00
src cleaned cmake config 2008-02-21 12:48:46 +00:00
test peo modified 2008-02-11 12:27:19 +00:00
tutorial peo : tutorials modified 2008-02-20 15:54:08 +00:00
AUTHORS Lesson pso 2007-10-16 08:17:39 +00:00
CMakeLists.txt simplified CMake config: a common "install.cmake" for the three modules. + ctest calls in the installation script 2008-02-18 14:01:49 +00:00
DartConfig.cmake changed nightly start time : EDT -> WEST 2008-02-20 10:07:17 +00:00
peo-conf.cmake paradiseo-->peo 2007-09-18 16:01:04 +00:00
README peo : tutorials modified 2008-02-20 15:54:08 +00:00

                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 ../ -Dconfig=<path to the install.cmake file>
    > 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) -Dconfig=<path to the install.cmake file>
    > make
    // for an easy-use of the provided lessons
    > make install
    // optional (if the documentation is not already available)
    > make doc

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
       |
       +-- examples      TSP
       |
       +-- Lesson1       Parallel evaluation for EA and PSO
       |
       +-- Lesson2       Parallel transformation (crossover + mutation) for EA
       |
       +-- Lesson3       Insular model for PSO and EA
       |
       +-- Lesson4       Hybridization

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

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