X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/15badc71ce964f6dae6428c9a4c0198fad5d4936..242fde5e8077f8193db4df5f262a9672085c8d8a:/doc/doxygen/install.doc diff --git a/doc/doxygen/install.doc b/doc/doxygen/install.doc index 8867f4c70f..366b75c4d8 100644 --- a/doc/doxygen/install.doc +++ b/doc/doxygen/install.doc @@ -1,4 +1,4 @@ -/*! +/*! @page install Installing Simgrid @tableofcontents @@ -8,7 +8,7 @@ Under Debian or Ubuntu, this is very easy as SimGrid is directly 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 @@ -29,13 +29,13 @@ 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 @@ -44,7 +44,7 @@ apt-get install simgrid 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 @@ -67,14 +67,14 @@ execute it and follow instructions. @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 Download page, 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 @@ -84,13 +84,16 @@ have access to your architecture to build SimGrid on it. @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) - @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 (download page). 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 fink: `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 @@ -98,19 +101,20 @@ this system, you still need a recent version of this compiler, so you 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 MinGW -environment to build SimGrid. Any other compilers are not tests -(and thus probably broken). We usually use the +environment to build SimGrid, with +MSYS tools installed. Any other compilers are not tested +(and thus probably broken). We usually use the activestate -version of Perl, and the +version of Perl, and the msys 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 download page. We do our best to release soon and release often, but sometimes you need to install the developer version of SimGrid, directly from the @@ -130,14 +134,17 @@ Note that compile-time options are very different from @ref options 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 CC=gcc-4.4 export CXX=g++-4.4 @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). @@ -159,13 +166,13 @@ ccmake . In addition to the classical cmake configuration variables, SimGrid accepts several options, as listed below. - @li CMAKE_INSTALL_PREFIX (path): Where to install SimGrid + @li CMAKE_INSTALL_PREFIX (path): Where to install SimGrid (e.g. /usr/local or /opt). @li enable_compile_optimizations (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 enable_debug (ON/OFF): disable this if simulation speed really matters to you. All log messages of gravity debug or @@ -176,7 +183,7 @@ accepts several options, as listed below. SimGrid if something goes wrong. @li enable_msg_deprecated (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. @@ -188,28 +195,21 @@ accepts several options, as listed below. your simulation speed even if you simulate without activating the model-checker. We are working on improving this situation. - @li enable_supernovae (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 enable_compile_warnings (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 enable_lib_static (ON/OFF): enable this if you want to compile the static library (but you should consider enjoying this new century instead). - + @li enable_maintainer_mode (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 enable_tracing (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. @@ -218,30 +218,32 @@ accepts several options, as listed below. 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 enable_mallocators (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 enable_jedule (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 enable_lua (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 enable_gtnets (ON/OFF): whether you want to use gtnets. See section @ref pls_simgrid_configuration_gtnets. - @li gtnets_path (path): GTNetS installation directory + @li gtnets_path (path): GTNetS installation directory (eg /usr or /opt). @li enable_ns3 (ON/OFF): whether you want to use ns3. See section @ref pls_simgrid_configuration_ns3. @li ns3_path (path): NS3 installation directory (eg /usr or /opt). @li enable_latency_bound_tracking (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 enable_documentation (ON/OFF) : whether the documentation should be + generated during the compilation. Default is ON. \subsubsection install_cmake_reset Resetting the compilation configuration @@ -259,7 +261,7 @@ is advised to to put them all in a separate directory. It is then 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 @@ -269,19 +271,19 @@ cmake [options] .. 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++ . @@ -302,7 +304,7 @@ CMAKE_OSX_SYSROOT:PATH=/Applications/XCode.app/Contents/Developer/Platforms/MacO \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 @@ -312,28 +314,28 @@ make install # try "sudo make install" if you don't have the permission to write 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 @@ -441,7 +443,7 @@ compiling a source file. There are: \verbatim - HelloWorld.c The example source file. - CMakeLists.txt It allows to configure the project. -- README This explaination. +- README This explanation. \endverbatim Now let's compile this example: