-/*!
+/*!
@page install Installing Simgrid
@tableofcontents
integrated to the official repositories. Under Windows, SimGrid can be
installed in a few clicks once you downloaded the installer from
gforge. If you just want to use Java, simply copy the jar file on your
-disk and you're set.
+disk and you're set.
Recompiling an official archive is not much more complex, actually.
SimGrid has very few dependencies and rely only on very standard
-tools. Recompiling the archive should be done in a few lines:
+tools. First, download the *@SimGridRelease.tar.gz* archive
+from [the download page](https://gforge.inria.fr/frs/?group_id=12).
+Then, recompiling the archive should be done in a few lines:
-@verbatim
-wget https://gforge.inria.fr/frs/download.php/32047/SimGrid-3.9.tar.gz
-tar xf SimGrid-3.9.tar.gz
-cd SimGrid-3.9
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.sh}
+tar xf @SimGridRelease.tar.gz
+cd @SimGridRelease
cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
make
make install
-@endverbatim
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you want to stay on the bleeding edge, you should get the latest
git version, and recompile it as you would do for an official archive.
Depending on the files you change in the source tree, some extra
tools may be needed.
-@section install_binary Installing a binary package
+@section install_binary Installing a binary package
@subsection install_binary_linux Binary packages for linux
Most of the developers use a Debian or Ubuntu system, and some of us
happen to be Debian Maintainers, so the packages for these systems are
-well integrated with these systems and very uptodate. To install them,
+well integrated with these systems and very up-to-date. To install them,
simply type:
@verbatim
On other Linux variants, you probably want to go for a source install.
Please contact us if you want to contribute the build scripts for your
-prefered distribution.
+preferred distribution.
@subsection install_binary_win Installation wizard for Windows
@subsection install_binary_java Using the binary jar file
The easiest way to install the Java bindings of SimGrid is to grab the
-jar file from the
+jar file from the
<a href="https://gforge.inria.fr/frs/?group_id=12">Download page</a>,
and copy it in your classpath (typically, in the same directory than
your source code). If you go for that version, there is no need to
install the C library as it is bundled within the jar file. Actually,
only a bunch of architectures are supported this way to keep the
-jarfile size under control and because we don't have access to every
-exotic architectures ourselves.
+jar file size under control and because we don't have access to every
+exotic architectures ourselves.
If the jarfile fails on you, complaining that your architecture is not
supported, drop us an email: we may extend the jarfile for you, if we
@subsection install_src_deps Resolving the dependencies
-SimGrid only uses very standard tools:
- @li C compiler, C++ compiler, make and friends.
- @li perl (but you may try to go without it) and libpcre (but we are
- working on removing this dependency)
- @li We use cmake to configure our compilation
+SimGrid only uses very standard tools:
+ - C compiler, C++ compiler, make and friends.
+ - perl (but you may try to go without it)
+ - We use cmake to configure our compilation
(<a href="http://www.cmake.org/cmake/resources/software.html">download page</a>).
You need cmake version 2.8 or higher. You may want to use ccmake
- for a graphical interface over cmake.
+ for a graphical interface over cmake.
+ - LibBoost:
+ - osX: with <a href="http://www.finkproject.org/">fink</a>: `sudo fink install boost1.53.nopython`
+ - debian: `apt-get install libboost-dev`
On MacOSX, it is advised to use the clang compiler (version 3.0 or
higher), from either MacPort or XCode. If you insist on using gcc on
need an unofficial gcc47 from MacPort because the version provided by
Apple is ways to ancient to suffice. See also @ref install_cmake_mac.
-On Windows, it is strongly advised to use the
+On Windows, it is strongly advised to use the
<a href="http://sourceforge.net/projects/mingw/files/MinGW/">MinGW
-environment</a> to build SimGrid. Any other compilers are not tests
-(and thus probably broken). We usually use the
+environment</a> to build SimGrid, with <a href="http://www.mingw.org/wiki/MSYS">
+MSYS tools</a> installed. Any other compilers are not tested
+(and thus probably broken). We usually use the
<a href="http://www.activestate.com/activeperl/downloads">activestate</a>
-version of Perl, and the
+version of Perl, and the
<a href="http://msysgit.googlecode.com/files/Git-1.7.4-preview20110204.exe">msys</a>
version of git on this architecture, but YMMV. See also @ref install_cmake_win.
@subsection install_src_fetch Retrieving the source
If you just want to use SimGrid, you should probably grab the latest
-stable version available from the
+stable version available from the
<a href="https://gforge.inria.fr/frs/?group_id=12">download page</a>.
We do our best to release soon and release often, but sometimes you
need to install the developer version of SimGrid, directly from the
The default configuration should be ok for most usages, but if you
need to change something, there is several ways to do so. First, you
-can use environment variable. For example, you can change the used
+can use environment variables. For example, you can change the used
compilers by issuing these commands before launching cmake:
@verbatim
-export CC=gcc-4.4
-export CXX=g++-4.4
+export CC=gcc-4.7
+export CXX=g++-4.7
@endverbatim
+Note that other variables are available, such as CFLAGS and CXXFLAGS to add
+options for respectively the C compiler and the C++ compiler.
+
Another way to do so is to use the -D argument of cmake as follows.
Note that the terminating dot is mandatory (see @ref
install_cmake_outsrc to understand its meaning).
In addition to the classical cmake configuration variables, SimGrid
accepts several options, as listed below.
- @li <b>CMAKE_INSTALL_PREFIX</b> (path): Where to install SimGrid
+ @li <b>CMAKE_INSTALL_PREFIX</b> (path): Where to install SimGrid
(e.g. /usr/local or /opt).
@li <b>enable_compile_optimizations</b> (ON/OFF): request the
compiler to produce efficient code. You want to activate it,
unless you want to debug SimGrid itself (as efficient code may
- be appear mangled to the debugers).
+ be appear mangled to the debuggers).
@li <b>enable_debug</b> (ON/OFF): disable this if simulation speed
really matters to you. All log messages of gravity debug or
SimGrid if something goes wrong.
@li <b>enable_msg_deprecated</b> (ON/OFF): enable this option if
- your code used a feature of Simgrid that was droped or modified
+ your code used a feature of Simgrid that was dropped or modified
in recent releases of SimGrid. You should update your code if
possible, but with this option, SimGrid will try to emulate its
old behavior.
your simulation speed even if you simulate without activating
the model-checker. We are working on improving this situation.
- @li <b>enable_supernovae</b> (ON/OFF): If you use an ancient
- compiler (such as gcc prior to 4.6), you want to enable this
- option to ensure that the whole SimGrid library is presented to
- the compiler as a unique compilation unit to allow cross-units
- optimizations. This is useless on modern compilers (and will
- soon be droped).
-
@li <b>enable_compile_warnings</b> (ON/OFF): request the compiler to
issue error message whenever the source code is not perfectly
clean. If you develop SimGrid itself, you must activate it to
ensure the code quality, but as a user, that option will only
bring you issues.
-
- @li <b>enable_lib_static</b> (ON/OFF): enable this if you want to
- compile the static library (but you should consider enjoying
- this new century instead).
-
+
@li <b>enable_maintainer_mode</b> (ON/OFF): you only need to set
this option if you modify very specific parts of SimGrid itself
(the XML parsers and other related elements). Adds an extra
dependency on flex and flexml.
-
+
@li <b>enable_tracing</b> (ON/OFF): disable this if you have issues
with the tracing module. But this module is now very stable and
you really should try to enjoy this beauty.
with the module allowing to run MPI code on top of SimGrid. This
module very stable, but if you really don't need it, you can
disable it.
-
+
@li <b>enable_mallocators</b> (ON/OFF): disable this when tracking
memory issues within SimGrid, or the caching mechanism used
- internally will fool the debugers.
+ internally will fool the debuggers.
@li <b>enable_jedule</b> (ON/OFF): enable this to get SimDag
- producing traces that can then be vizualized with the Jedule
+ producing traces that can then be visualized with the Jedule
external tool.
@li <b>enable_lua</b> (ON/OFF): enable this if you want to enjoy the
lua bindings of SimGrid. Adds an extra dependency on lua library
- and developper header files.
+ and developer header files.
- @li <b>enable_gtnets</b> (ON/OFF): whether you want to use gtnets.
- See section @ref pls_simgrid_configuration_gtnets.
- @li <b>gtnets_path</b> (path): GTNetS installation directory
- (eg /usr or /opt).
@li <b>enable_ns3</b> (ON/OFF): whether you want to use ns3.
See section @ref pls_simgrid_configuration_ns3.
- @li <b>ns3_path</b> (path): NS3 installation directory (eg /usr or /opt).
+ @li <b>NS3_HINT</b> (path): Where to search for NS3 (eg /usr or /opt).
@li <b>enable_latency_bound_tracking</b> (ON/OFF): enable it if you
want to be warned when communications are limited by round trip
- time while doing packet-level simulation.
+ time while doing packet-level simulation.
+ @li <b>enable_documentation</b> (ON/OFF) : whether the documentation should be
+ generated during the compilation. Default is ON.
\subsubsection install_cmake_reset Resetting the compilation configuration
easier to cleanup, and this allows to compile several configurations
out of the same source tree. For that, simply enter the directory
where you want the produced files to land, and invoke cmake (or
-ccmake) with the full path to the simgrid source as last argument.
+ccmake) with the full path to the SimGrid source as last argument.
This approach is called "compilation out of source tree".
@verbatim
make
@endverbatim
-\subsubsection install_cmake_win Cmake on Windows (with MinGW)
+\subsubsection install_cmake_win Cmake on Windows (with MinGW + MSYS)
Cmake can produce several kind of of makefiles. Under Windows, it has
no way of determining what kind you want to use, so you have to hint it:
@verbatim
-cmake -G"MinGW Makefiles" (other options) .
-mingw32-make
+cmake -G "MSYS Makefiles" (other options) .
+make
@endverbatim
-\subsubsection install_cmake_mac Cmake on Mac OSX
+\subsubsection install_cmake_mac Cmake on Mac OS X
-SimGrid compiles like a charm with clang on Mac OSX:
+SimGrid compiles like a charm with clang on Mac OS X:
@verbatim
cmake -DCMAKE_C_COMPILER=/path/to/clang -DCMAKE_CXX_COMPILER=/path/to/clang++ .
\subsection install_src_compil Compiling SimGrid
-In most cases, compiling and installing simgrid is enough:
+In most cases, compiling and installing SimGrid is enough:
@verbatim
make
In addition, several compilation targets are provided in SimGrid. If
your system is well configured, the full list of targets is available
for completion when using the Tab key. Note that some of the existing
-targets are not really for publc consumption so don't worry if some
+targets are not really for public consumption so don't worry if some
stuff don't work for you.
@verbatim
-make simgrid Builds only the simgrid library and not any example
-make masterslave Builds only this example (and its dependencies)
+make simgrid Build only the SimGrid library and not any example
+make masterslave Build only this example (and its dependencies)
make clean Clean the results of a previous compilation
make install Install the project (doc/ bin/ lib/ include/)
make uninstall Uninstall the project (doc/ bin/ lib/ include/)
-make dist Cuild a distribution archive (tgz)
+make dist Build a distribution archive (tgz)
make distcheck Check the dist (make + make dist + tests on the distribution)
-make simgrid_documentation Create simgrid documentation
+make doc Create SimGrid documentation
@endverbatim
If you want to see what is really happening, try adding VERBOSE=1 to
your compilation requests:
@verbatim
-make VERBOSE=1
+make VERBOSE=1
@endverbatim
-@subsection install_src_test Testing SimGrid
+@subsection install_src_test Testing SimGrid
Once everything is built, you may want to test the result. SimGrid
comes with an extensive set of regression tests (see @ref
\verbatim
- HelloWorld.c The example source file.
- CMakeLists.txt It allows to configure the project.
-- FindPCRE.cmake This finds and links to the pcre library (Normally included
- into Simgrid directory "GnuWin32").
-- README This explaination.
+- README This explanation.
\endverbatim
Now let's compile this example:
################
#It creates a target called 'TARGET_NAME.exe' with the sources 'SOURCES'
add_executable(TARGET_NAME SOURCES)
-#Links TARGET_NAME with simgrid and pcre
-target_link_libraries(TARGET_NAME simgrid pcre)
+#Links TARGET_NAME with simgrid
+target_link_libraries(TARGET_NAME simgrid)
\endverbatim
\li To initialize and build your project, you'll need to run
\verbatim
