# ParadisEO-PEOMovingObjects: README Source File

# README

    00001                 PARADISEO-PEO README FILE
    00002 =======================================================================
    00003          check latest news at http://paradiseo.gforge.inria.fr/
    00004 =======================================================================
    00005
    00006 Welcome to ParadisEO-PEO, the Parallel Evolving Objects library.
    00007 The latest news about ParadisEO-PEO can be found on the gforge repository at
    00008 http://paradiseo.gforge.inria.fr/
    00009 In case of any problem, please e-mail us at
    00010 paradiseo-help@lists.gforge.inria.fr
    00011
    00012
    00013 =======================================================================
    00014                         BUILDING PARADISEO-PEO
    00015 =======================================================================
    00016 The basic installation procedure goes the following.
    00017
    00018 To compile paradiseo-peo in the default directory,
    00019 go to paradiseo-peo/build/ and run:
    00020     > cmake ../ -Dconfig=<path to the install.cmake file>
    00021     > make
    00022     // for an easy-use of the provided lessons
    00023     > make install
    00024     // optional (if the documentation is not already available)
    00025     > make doc
    00026
    00027 To compile paradiseo-peo anywhere else, simply run:
    00028     > cmake $(PEO) -Dconfig=<path to the install.cmake file>
    00029     > make
    00030     // for an easy-use of the provided lessons
    00031     > make install
    00032     // optional (if the documentation is not already available)
    00033     > make doc
    00034
    00035 To clean everything, simply run
    00036     > make clean
    00037
    00038
    00039 ===================================================================
    00040                        DIRECTORY STRUCTURE
    00041 ===================================================================
    00042 After unpacking the archive file, you should end up with the following
    00043 structure:
    00044
    00045 .../                     The main PARADISEO-PEO directory, created when unpacking.
    00046    |
    00047    +-- build             BUILD directory that contains libraries and executable files.
    00048    |
    00049    +-- src               SOURCE directory Contains most PARADISEO-PEO .h files.
    00050    |
    00051    +-- doc               DOCUMENTATION directory (generated by Doxygen).
    00052    |   |
    00053    |   +- html           HTML files - start at index.html.
    00054    |   |
    00055    |   +- latex          latex files - use to generate Postcript doc.
    00056    |   |
    00057    |   +- man            Unix man format documentation.
    00058    |
    00059    |
    00060    +-- tutorial          APPLICATIONS - one directory per separate application.
    00061        |
    00062        +-- examples      Examples repository including source code shared by all or most of the included lessons.
    00063        |   |
    00064        |   +- tsp        A Traveling Salesman Problem (TSP) example with benchmarks, the main operators, definitions, etc.
    00065        |
    00066        +-- Lesson1       A simple ParadisEO-PEO evolutionary algorithm example using the peoEA class.
    00067        |
    00068        +-- Lesson2       Example of an EA featuring a parallel evaluation of the population/parallel fitness function evaluation.
    00069        |
    00070        +-- Lesson3       Example of an asynchronous insular model including two evolutionary algorithms.
    00071        |
    00072        +-- Walkthrough   Walkthrough ParadisEO-PEO features - EA+LS hybridization, parallelization, insular model.
    00073
    00074 ===================================================================
    00075               NOTES
    00076 ===================================================================
    00077
    00078 Mailing list : paradiseo-help@lists.gforge.inria.fr