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

Welcome to ParadisEO-GPU, the reusable design and implementation of parallel meta-
heuristics on Graphics Processing Units (GPU).
The latest news about ParadisEO-GPU can be found on the gforge repository at
http://paradiseo.gforge.inria.fr/index.php?n=Doc.API
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-gpu in the default directory,
go to paradiseo-gpu/build/ and run:
    > cmake ..
    > 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 $(GPU) -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-GPU directory, created when unpacking.
   |
   +-- build             BUILD directory that contains libraries and executable files.
   |
   +-- src               SOURCE directory Contains most PARADISEO-GPU .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
       |
       +-- INSTANCES       The instances problem directory (QAP instances ...)
       |
       +-- OneMax          How make One max problem with parallel evalution of neighborhood(bit flipping) with hamming distances =1
       |
       +-- KswapOneMax     How make One max problem with parallel evalution of neighborhood(bit flipping) with hamming distances >=1
       |
       +-- PPP_GPU         How make Permuted Perceptron Problem with parallel evalution of neighborhood on GPU
       |
       +-- QAP_GPU         How make Quadratic Assignement Problem  with parallel evaluation of neighborhood on GPU
       |
       +-- QAP_CPU         How make Quadratic Assignement Problem  with sequentiel evaluation of neighborhood on CPU
       

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

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