Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix some long -> double faulty convertions reported by sonar
[simgrid.git] / examples / README.rst
index 227aa3b..0ae9e50 100644 (file)
@@ -28,12 +28,12 @@ to simulate.
 Actors: the Active Entities
 ===========================
 
-Starting and Stoping Actors
+Starting and Stopping Actors
 ---------------------------
 
   - **Creating actors:**
     Most actors are started from the deployment XML file, because this
-    is a :ref:`better scientific habbit <howto_science>`, but you can
+    is a :ref:`better scientific habit <howto_science>`, but you can
     also create them directly from your code.
 
     .. tabs::
@@ -106,7 +106,7 @@ Starting and Stoping Actors
 
           See also :cpp:func:`sg_actor_kill`, :cpp:func:`sg_actor_kill_all`, :cpp:func:`sg_actor_exit`, :cpp:func:`sg_actor_on_exit`.
 
-  - **Controling the actor life cycle from the XML:**
+  - **Controlling the actor life cycle from the XML:**
     You can specify a start time and a kill time in the deployment file.
 
     .. tabs::
@@ -679,7 +679,7 @@ options to see the task executions:
 
   - **Platform Tracing:**
     This program is a toy example just loading the platform, so that
-    you can play with the platform visualization. Recommanded options:
+    you can play with the platform visualization. Recommended options:
     ``--cfg=tracing:yes --cfg=tracing/categorized:yes``
 
     .. tabs::
@@ -863,6 +863,29 @@ Simulating Clouds
 
        .. example-tab:: examples/c/cloud-migration/cloud-migration.c
 
+=======================
+Model-Related Examples
+=======================
+
+  - **ns-3 as a SimGrid Network Model**
+    This simple ping-pong example demonstrates how to use the bindings to the Network
+    Simulator. The most interesting is probably not the C++ files since
+    they are unchanged from the other simulations, but the associated files,
+    such as the platform file to see how to declare a platform to be used 
+    with the ns-3 bindings of SimGrid and the tesh file to see how to actually
+    start a simulation in these settings.
+
+    .. tabs::
+
+      .. example-tab:: examples/s4u/network-ns3/s4u-network-ns3.cpp
+
+      .. group-tab:: XML
+
+         **Platform files:**
+
+         .. showfile:: examples/platforms/small_platform_one_link_routes.xml
+            :language: xml
+
 =======================
 Model-Checking Examples
 =======================