X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7b98df0790cc3fec26293ba257f64d94135098c4..c51823541276dc4b772e8c1c94dafb1291715268:/doc/install.doc diff --git a/doc/install.doc b/doc/install.doc index 5c93761ed7..935fc528ef 100644 --- a/doc/install.doc +++ b/doc/install.doc @@ -1,4 +1,4 @@ -/*! \page install Install Simgrid +/*! \page install Installing Simgrid \htmlinclude .install.doc.toc @@ -37,6 +37,7 @@ For Windows : "cmake -D[name]=[value] ... ./" [name] enable_gtnets [value] ON/OFF or TRUE/FALSE or 1/0 + enable_ns3 ON/OFF or TRUE/FALSE or 1/0 enable_lua ON/OFF or TRUE/FALSE or 1/0 enable_compile_optimizations ON/OFF or TRUE/FALSE or 1/0 enable_compile_warnings ON/OFF or TRUE/FALSE or 1/0 @@ -50,8 +51,11 @@ For Windows : enable_jedule ON/OFF or TRUE/FALSE or 1/0 enable_latency_bound_tracking ON/OFF or TRUE/FALSE or 1/0 enable_lib_static ON/OFF or TRUE/FALSE or 1/0 - custom_flags + enable_supernovae ON/OFF or TRUE/FALSE or 1/0 + enable_msg_deprecated ON/OFF or TRUE/FALSE or 1/0 + enable_print_message ON/OFF or TRUE/FALSE or 1/0 gtnets_path + ns3_path CMAKE_INSTALL_PREFIX CMAKE_C_COMPILER CMAKE_CXX_COMPILER @@ -61,6 +65,8 @@ For Windows : \subsubsection install_cmakeoption2 Options explaination \li enable_gtnets : set to true implie that user wants to use gtnets. + + \li enable_ns3 : set to true implie that user wants to use ns3. \li enable_lua : set to true implie that user wants to add lua langage into simgrid compilation. @@ -86,11 +92,17 @@ For Windows : \li enable_latency_bound_tracking : Set to on if you want to be warned when communications are limited by round trip time. - \li enable_lib_static : Enable generated Simgrid and smpi static libraries. + \li enable_lib_static : Enable generated Simgrid and smpi static libraries. + + \li enable_supernovae : Set to true make one file for each lib and compile with those generated files. + + \li enable_msg_deprecated : Simgrid is compiled with msg deprecated functions. + + \li enable_print_message : When set to true configuration print more debug output. - \li custom_flags : If user wants to use a specific flag during compilation, give here. - \li gtnets_path : Path to gtnets install directory (ex /usr) + + \li ns3_path : Path to ns3 install directory (ex /usr) \li CMAKE_INSTALL_PREFIX : Path where are installed lib/ doc/ and include/ directories (ex /usr/local) @@ -120,7 +132,6 @@ enable_jedule off enable_latency_bound_tracking off enable_lib_static off CMAKE_INSTALL_PREFIX /usr/local -custom_flags null gtnets_path null pipol_user null \endverbatim @@ -286,9 +297,9 @@ set(JMSG_JAVA_SRC ) \endverbatim -\section install_Win Installing the SimGrid library with Windows pakage +\section install_Win Installing the SimGrid framework on Windows -\subsection install_Win_install Installing SimGrid +\subsection install_Win_install Installing SimGrid with the automatic installer Before start the installation, you need to be sure to have the following dependencies: \li cmake 2.8 (download page) @@ -321,7 +332,19 @@ Step 3: Choice where to install packets previously selected. Please don't use sp \endhtmlonly -Step 4: Restart your computer to take in consideration environment variables. +Step 4: Add CLASSPATH to environment variables. + +\htmlonly + +\endhtmlonly + +Step 5: Add PATH to environment variables. + +\htmlonly + +\endhtmlonly + +Step 6: Restart your computer to take in consideration environment variables. \subsection install_Win_compile1 Compile a project "HelloWorld" @@ -363,6 +386,13 @@ cmake -G"MinGW Makefiles" \ \li Run "mingw32-make" \li You should obtain "TARGET_NAME.exe". +\subsection install_Win_ruby Setup a virtualbox to use SimGrid-Ruby on windows + +Allan Espinosa made these set of Vagrant rules available so that you +can use the SimGrid Ruby bindings in a virtual machine using +VirtualBox. Thanks to him for that. You can find his project here: +https://github.com/aespinosa/simgrid-vagrant + \section install_setting_MSG Setting up your own MSG code Do not build your simulator by modifying the SimGrid examples. Go @@ -381,7 +411,7 @@ feel free to organize it as you want). \li sched.c: a C file including sched.h and implementing the core of the scheduler. Most of these functions use the MSG functions defined in section \ref - msg_gos_functions. + msg_task_usage. \li masterslave.c: a C file with the main function, i.e. the MSG initialization (MSG_global_init()), the platform