INSTALL

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