INSTALL

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