From 53a2c2d3eef909b7e5a0003adb16a7adf3d15e58 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Tue, 7 Jul 2020 10:29:43 +0200 Subject: [PATCH] small improvements to the ns3 doc --- docs/source/ns3.rst | 69 ++++++++++++++++++++------------------------- 1 file changed, 30 insertions(+), 39 deletions(-) diff --git a/docs/source/ns3.rst b/docs/source/ns3.rst index c4e27ea7a7..3760835462 100644 --- a/docs/source/ns3.rst +++ b/docs/source/ns3.rst @@ -18,27 +18,14 @@ SimGrid requires ns-3 version 3.26 or higher, and you probably want the most recent version of both SimGrid and ns-3. While the Debian package of SimGrid don't have the ns-3 bindings activated, you can still use the packaged version of ns-3 by grabbing the ``libns3-dev ns3`` packages. Alternatively, you can -install ns-3 from scratch as follows: - -.. code-block:: shell - - # Download the source - wget http://www.nsnam.org/release/ns-allinone-3.29.tar.bz2 - tar -xf ns-allinone-3.29.tar.bz2 - cd ns-allinone-3.29/ns-3.29/ - # Configure, build and install - ./waf configure --prefix="/opt/ns3" # or give another path if you prefer - ./waf - ./waf install - -For more information, please refer to the ns-3 documentation -(`official website `_). +install ns-3 from scratch (see the `ns-3 documentation `_). Enabling ns-3 in SimGrid ======================== SimGrid must be recompiled with the ``enable_ns3`` option activated in cmake. -Optionally, use ``NS3_HINT`` to hint cmake about where to find ns-3. +Optionally, use ``NS3_HINT`` to hint cmake about the path on disk +where ns-3 is installed. .. code-block:: shell @@ -80,21 +67,23 @@ Platform files compatibility Any route longer than one will be ignored when using ns-3. They are harmless, but you still need to connect your hosts using one-hop routes. The best solution is to add routers to split your route. Here is an -example of invalid platform: +example of an invalid platform: .. code-block:: shell - - + + + - - - - - - - + + + + + + + + This can be reformulated as follows to make it usable with the ns-3 binding. @@ -104,21 +93,23 @@ ns-3 automatically routes from point to point. .. code-block:: shell - - + + + - + - - + + - - - + + + - - - + + + + Once your platform is OK, just change the :ref:`network/model @@ -131,7 +122,7 @@ is unchanged. Many other files from the ``examples/platform directory`` are usable with the ns-3 model, such as `examples/platforms/dogbone.xml `_. -Check the file `examples/deprecated/msg/network-ns3/network-ns3.tesh `_ +Check the file `examples/s4u/network-ns3/network-ns3.tesh `_ to see which ones are used in our regression tests. Limitations @@ -151,7 +142,7 @@ platform. However, there are some known caveats: Our goal is to keep the ns-3 plugin of SimGrid as easy (and hopefully readable) as possible. If the current state does not fit your needs, you should modify this plugin, and/or create your own plugin from the existing one. If you come up -with interesting improvements, please contribute them back +with interesting improvements, please contribute them back. Troubleshooting =============== -- 2.20.1