Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add INSTALL file for cmake.
[simgrid.git] / INSTALL
1 ************************************************
2 * Installation information specific to SimGrid *
3 ************************************************
4
5 The main source of information to compile SimGrid is the project FAQ.
6 It is available online from http://simgrid.gforge.inria.fr/doc/faq.html or
7 in the doc/ directory of this archive.
8
9 Quick way to compile
10 ====================
11
12 In short, the way to compile SimGrid depends on whether you are
13 compiling a tar.gz archive or directly from the SVN.
14
15 (1) configure SimGrid (both in SVN and archives)
16 $ cmake <all options> ./
17
18 Main options are:
19   -DCMAKE_INSTALL_PREFIX=<path>: specify where to install SimGrid
20   -Denable_maintainer_mode=on/off: get the maintainer files regenerated automatically
21   -Denable_compile_optimizations=on/off: compile or not with -O0 instead of -O3
22   -Denable_java=on/off: enable or not binding java
23   -Denable_lua=on/off: enable or not binding lua
24   -Denable_ruby=on/off: enable or not binding ruby
25   -Denable_smpi=on/off: enable or not smpi
26 See below for other configure options which are common to any project,
27 not only SimGrid related.
28
29 (2) Compile it
30 $ make
31
32 (3) Test it (optional)
33 $ make check 
34 $ ctest
35
36 (4) Install it
37 $ make install
38
39
40 Dependencies
41 ============
42 SimGrid archives do not have any firm dependencies. 
43
44 If you want to compile, you must have installed perl and cmake version 2.6 or above.
45 In order to improve memory management you should install libpcre.
46
47 If you want to compile the java bindings, you have to have a java
48 compiler, and the jni.h header file (available from the JDK)
49
50 If you want to compile the lua bindings, you have to have lua5.1 executable and liblua5.1-dev. 
51
52 If you want to compile the ruby bindings, you have to install ruby executable and ruby-dev version 1.9.
53
54 If you want to compile smpi, you should install f2c for use Fortran code.
55
56 If you want to compile the GTNetS backend, you have to have a patched
57 version of GTNetS installed. The patch lives in the contrib section of
58 the SVN.
59
60 Again, you should check the FAQ for more information.