e3a610506b
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@2710 331e1502-861f-0410-8da2-ba01fb791d7f
140 lines
6.7 KiB
Text
140 lines
6.7 KiB
Text
|
|
==========================================================================================
|
|
INSTALLING PARADISEO
|
|
==========================================================================================
|
|
|
|
There is several ways to install ParadisEO, according to your needs.
|
|
|
|
==========================================================================================
|
|
WINDOWS
|
|
==========================================================================================
|
|
|
|
On Windows, and for compatibility reason, ParadisEO supply support only for MinGW.
|
|
Feel free to test with another compiler and to send us you report.
|
|
|
|
------------------------------------------------------------------------------------------
|
|
1) WITH EXE
|
|
------------------------------------------------------------------------------------------
|
|
|
|
The simpliest way ton install ParadisEO on Windows is to use the NSIS installer.
|
|
We would like to draw your attention on the fact that the PATH variable will not
|
|
be affected by the installation in order to allow anybody to install ParadisEO
|
|
without administration right. To have further information about how to use ParadisEO
|
|
in your project, see the tutorial on ParadisEO website (http://paradiseo.gforge.inria.fr/).
|
|
|
|
------------------------------------------------------------------------------------------
|
|
2) WITH CMAKE
|
|
------------------------------------------------------------------------------------------
|
|
|
|
You can also install ParadisEO using CMake. For that you must have a compiler installed,
|
|
and obviously cmake.
|
|
Then, follow UNIX instructions.
|
|
|
|
==========================================================================================
|
|
UNIX
|
|
==========================================================================================
|
|
------------------------------------------------------------------------------------------
|
|
1. WITH CMAKE
|
|
------------------------------------------------------------------------------------------
|
|
1.0 DEPENDENCIES
|
|
------------------------------------------------------------------------------------------
|
|
Required
|
|
- Compiler with OpenMP implementation (thus, Clang isn't supported atm).
|
|
|
|
Optionnal
|
|
- Doxygen for documentation
|
|
- lcov for coverage
|
|
|
|
------------------------------------------------------------------------------------------
|
|
1.1 FAST INSTALLATION
|
|
------------------------------------------------------------------------------------------
|
|
|
|
After getting ParadisEO sources from repository, you have to create a build directory in order to keep your file tree clean.
|
|
|
|
mkdir build
|
|
cd build
|
|
|
|
To make the installation easier, ParadisEO propose you two installation types which are "Full" and "Min".
|
|
Full always corresponds to a DEBUG build with examples / lessons, tests and obviously libraries.
|
|
Min corresponds to libraries and headers with Debug build if you don't specify the contrary with -DCMAKE_BUILD_TYPE=Release. In both cases, you are free to build the documentation (refer to the documentation section)
|
|
|
|
You can specified an installation type by adding the following declaration to cmake :
|
|
|
|
cmake .. -DINSTALL_TYPE=full
|
|
cmake .. -DINSTALL_TYPE=min
|
|
|
|
Actually, by default the generator will be "Unix Makefiles" and cmake will try to look for a C++ compiler.
|
|
Be sure you have make installed, or choose an alternative according to your configuration.
|
|
To know available generators on your computer, type cmake -help. If you are on Windows and you use MinGW, you have to specify it explicitly by adding -G "MinGW Makefiles".
|
|
|
|
To compile ParadisEO simply compile sources using your generator. For instance, if you are using Unix Makefiles, type make.
|
|
|
|
WARNING : The default build type is Debug. If you want to build in Release, see the next section which concerns Build types.
|
|
|
|
------------------------------------------------------------------------------------------
|
|
1.2 BUILD TYPE
|
|
------------------------------------------------------------------------------------------
|
|
|
|
There are 2 type of build : Release or Debug.
|
|
To explicitly change the type, add -DCMAKE_BUILD_TYPE=Release for instance.
|
|
|
|
------------------------------------------------------------------------------------------
|
|
1.3 INSTALLATION
|
|
------------------------------------------------------------------------------------------
|
|
|
|
WARNING : This require administration rights.
|
|
|
|
To install ParadisEO in standard paths (such as /usr/lib for lib and /usr/include for headers on UNIX-like) :
|
|
|
|
make install
|
|
|
|
------------------------------------------------------------------------------------------
|
|
2. DOCUMENTATION
|
|
------------------------------------------------------------------------------------------
|
|
|
|
There is 2 ways to build ParadisEO documentation : module by module, or all the documentation.
|
|
|
|
Targets are :
|
|
doc for all documentations
|
|
doc-eo for building EO documentation
|
|
doc-mo for MO
|
|
doc-moeo for MOEO
|
|
|
|
Each documentation are generated separatly in the module build folder.
|
|
For instance, after the generation of the MO documentation, you will find it in build/paradise-mo/doc.
|
|
|
|
------------------------------------------------------------------------------------------
|
|
3. LESSONS / EXAMPLES
|
|
------------------------------------------------------------------------------------------
|
|
|
|
Examples and lessons are generated by default.
|
|
If you want to disable lessons manually, you have to specify -DENABLE_CMAKE_TESTING=false to CMake.
|
|
If you want to build a specific lesson or example, you can check the list of available targets with make help.
|
|
|
|
All lessons are build on the same pattern : <module>Lesson<number>.
|
|
For instance, make moLesson4 will build the Lesson 4 from the MO module.
|
|
Easy, isn't it ?
|
|
|
|
------------------------------------------------------------------------------------------
|
|
4. TESTS
|
|
------------------------------------------------------------------------------------------
|
|
4.1 CTESTS
|
|
------------------------------------------------------------------------------------------
|
|
|
|
By performing tests, you can check your installation.
|
|
Testing is disable by default and if you enable it, the build type automatically will switch on DEBUG.
|
|
To enable testing, define -DENABLE_TESTING when you launch cmake/
|
|
|
|
To perform tests simply type ctest ou make test.
|
|
|
|
------------------------------------------------------------------------------------------
|
|
4.2 REPORTING
|
|
------------------------------------------------------------------------------------------
|
|
|
|
Feel free to send us reports about building, installation, tests and profiling in order to help us to improve compatibilty and installation process. Sending reports is very simple :
|
|
|
|
ctest -D Experimental
|
|
|
|
WARNING : Reports are anonymous. CTest will also send informations about your configuration such as OS, CPU frequency, etc.
|
|
|
|
|