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 Git.
  15
  16 (1) configure SimGrid (both in Git 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 optimizations
  24   -Denable_java=on/off: enable or not the Java bindings
  25   -Denable_scala=on/off: enable or not the Scala bindings
  26   -Denable_lua=on/off: enable or not the lua bindings
  27   -Denable_smpi=on/off: enable or not smpi
  28   -Denable_model-checking=on/off: enable or not the model-checker
  29 See below for other configure options which are common to any project,
  30 not only SimGrid related.
  31
  32 (2) Compile it
  33 $ make
  34
  35 (3) Test it (optional)
  36 $ make check
  37 $ ctest
  38
  39 (4) Install it
  40 $ make install
  41
  42
  43 Dependencies
  44 ============
  45 SimGrid archives do not have any firm dependencies.
  46
  47 If you want to compile, you must have installed perl and cmake version 2.6 or
  48 above.
  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 smpi, you should install f2c to use Fortran code.
  57
  58 If you want to compile the GTNetS backend, you have to have a patched version of
  59 GTNetS installed. The patch lives in the contrib section of the Git.