X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f23b0fb864cb60978c1fcfd48d50f62dd054fe31..93e627932e2b4dfb8b7b4e319a820aeda261ceb9:/doc/doxygen/ns3.doc diff --git a/doc/doxygen/ns3.doc b/doc/doxygen/ns3.doc index 91950b9201..b1763a7147 100644 --- a/doc/doxygen/ns3.doc +++ b/doc/doxygen/ns3.doc @@ -1,23 +1,23 @@ -/*! \page pls_ns3 ns-3 as a SimGrid model +/*! @page pls_ns3 ns-3 as a SimGrid model -\tableofcontents +@tableofcontents You can use the well-known ns-3 packet-level network simulator as a SimGrid model, for example to investigate the validity of your simulation. Just install ns-3 and recompile SimGrid accordingly. -\section pls_ns3_install Installing ns-3 +@section pls_ns3_install Installing ns-3 The easiest is to install it with the package manager. Under Debian/Ubuntu, simply type as root: -\verbatim +@verbatim apt-get install libns3-dev ns3 -\endverbatim +@endverbatim You can also install it from scratch with the following commands: -\verbatim +@verbatim # Download the source wget http://www.nsnam.org/release/ns-allinone-3.26.tar.bz2 tar -xf ns-allinone-3.26.tar.bz2 @@ -26,35 +26,35 @@ cd ns-allinone-3.26/ns-3.26/ ./waf configure --prefix="/opt/ns3" # or give another path if you prefer ./waf ./waf install -\endverbatim +@endverbatim For more information, please refer to the ns-3 documentation (official website). -\section pls_ns3_config Enabling SimGrid's support for ns-3 +@section pls_ns3_config Enabling SimGrid's support for ns-3 Normally, you just have to enable ns-3 in ccmake or cmake as follows. If you installed ns-3 in a regular path, just drop the NS3_HINT configuration item. -\verbatim +@verbatim cmake . -Denable_ns3=ON -DNS3_HINT=/opt/ns3 # or change the path if needed -\endverbatim +@endverbatim By the end of the configuration, cmake reports whether ns-3 was found, and this information is also available in include/simgrid/config.h -If your local copy defines the variable \c SIMGRID_HAVE_NS3 to 1, then ns-3 +If your local copy defines the variable @c SIMGRID_HAVE_NS3 to 1, then ns-3 was correctly detected. If it's defined to 0, then something went wrong. Explore CMakeFiles/CMakeOutput.log and CMakeFiles/CMakeError.log to diagnose the problem. Afterward, you can test your installation as follows: -\verbatim +@verbatim $ ctest -R ns3 -\endverbatim +@endverbatim -\section pls_ns3_use Using ns-3 from SimGrid +@section pls_ns3_use Using ns-3 from SimGrid The SimGrid-ns3 binding only contains features that are common to both systems: ns-3 wireless models are not available, while SimGrid routes @@ -109,13 +109,13 @@ ns-3 will find the path from point to point. Once your platform is OK, just change the "network/model" configuration option to "NS3" as follows. The rest remains unchanged. -\verbatim +@verbatim ./network-ns3 ../../platforms/small_platform_one_link_routes.xml 3hosts_2links_d.xml --cfg=network/model:NS3 -\endverbatim +@endverbatim Many other files from the examples/platform directory are usable with the ns-3 model, such as @ref examples/platforms/dogbone.xml. Check the file -examples/msg/network-ns3/network-ns3.tesh to see which ones are used +examples/deprecated/msg/network-ns3/network-ns3.tesh to see which ones are used in our regression tests. You may also be interested in the @ref msg_ex_ns3 "ns-3/SimGrid examples". @@ -148,7 +148,7 @@ existing one. @subsection pls_ns3_config_trouble I fail to compile ns-3 within SimGrid -If you have a ns-3 version that is not known to SimGrid yet, edit \c +If you have a ns-3 version that is not known to SimGrid yet, edit @c tools/cmake/Modules/FindNS3.cmake in your SimGrid tree, according to the comments on top of this file.