.. documentation, but it should remain readable directly.
-------------
S4U Examples
-------------
+************
SimGrid comes with an extensive set of examples, documented on this
page. Most of them only demonstrate one single feature, with some
larger examplars listed below.
-Each of these examples can be found in a subdirectory under
-examples/s4u in the archive. It contains the source code (also listed
+The C++ examples can be found under examples/s4u while python examples
+are in examples/python. Each such directory contains the source code (also listed
from this page), and the so-called tesh file containing how to call
the binary obtained by compiling this example and also the expected
output. Tesh files are used to turn each of our examples into an
of the provided examples to constitute the skeleton of what you plan
to simulate.
-...........................
+===========================
Actors: the Active Entities
-...........................
+===========================
Starting and Stoping Actors
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------
- **Creating actors:**
Most actors are started from the deployment XML file, but there is other methods.
|br| `examples/s4u/actor-daemon/s4u-actor-daemon.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/actor-daemon/s4u-actor-daemon.cpp>`_
Inter-Actors Interactions
-^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------
- **Suspend and Resume actors:**
Actors can be suspended and resumed during their executions thanks
|br| `examples/s4u/actor-yield/s4u-actor-yield.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/actor-yield/s4u-actor-yield.cpp>`_
Traces Replay as a Workload
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------
This section details how to run trace-driven simulations. It is very
handy when you want to test an algorithm or protocol that only react
primitives (open, read, close).
|br| `examples/s4u/replay-storage/s4u-replay-storage.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/replay-storage/s4u-replay-storage.cpp>`_
-..........................
+==========================
Activities: what Actors do
-..........................
+==========================
Communications on the Network
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------------
- **Basic asynchronous communications:**
Illustrates how to have non-blocking communications, that are
.. todo:: add the `ready` example here
+.. _s4u_ex_execution:
+
Executions on the CPU
-^^^^^^^^^^^^^^^^^^^^^
+---------------------
- **Basic execution:**
The computations done in your program are not reported to the
the actor until a given amount of flops gets computed on its simulated
host. Some executions can be given an higher priority so that they
get more resources.
- |br| `examples/s4u/exec-basic/s4u-exec-basic.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/exec-basic/s4u-exec-basic.cpp>`_
+ |br| |cpp| `examples/s4u/exec-basic/s4u-exec-basic.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/exec-basic/s4u-exec-basic.cpp>`_
+ |br| |py| `examples/python/exec-basic/exec-basic.py <https://framagit.org/simgrid/simgrid/tree/master/examples/python/exec-basic/exec-basic.py>`_
- **Asynchronous execution:**
You can start asynchronous executions, just like you would fire
|br| `examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp>`_
|br| `examples/platforms/energy_platform.xml <https://framagit.org/simgrid/simgrid/tree/master/examples/platforms/energy_platform.xml>`_
- - **Parallel tasks:**
+ - **Parallel executions:**
These objects are convenient abstractions of parallel
- computational kernels that span over several machines.
+ computational kernels that span over several machines, such as a
+ PDGEM and the other ScaLAPACK routines.
|br| `examples/s4u/exec-ptask/s4u-exec-ptask.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/exec-ptask/s4u-exec-ptask.cpp>`_
I/O on Disks and Files
-^^^^^^^^^^^^^^^^^^^^^^
+----------------------
SimGrid provides two levels of abstraction to interact with the
simulated storages. At the simplest level, you simply create read and
|br| `examples/s4u/io-file-remote/s4u-io-file-remote.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/io-file-remote/s4u-io-file-remote.cpp>`_
Classical synchronization objects
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------------
- **Mutex:**
Shows how to use simgrid::s4u::Mutex synchronization objects.
Shows how to use simgrid::s4u::Barrier synchronization objects.
|br| `examples/s4u/synchro-barrier/s4u-synchro-barrier.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/synchro-barrier/s4u-synchro-barrier.cpp>`_
-.............................
-Interacting with the platform
-.............................
+ - **Semaphore:**
+ Shows how to use simgrid::s4u::Semaphore synchronization objects.
+ |br| `examples/s4u/synchro-semaphore/s4u-synchro-semaphore.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/synchro-semaphore/s4u-synchro-semaphore.cpp>`_
+
+=============================
+Interacting with the Platform
+=============================
- **Retrieving the list of hosts matching a given criteria:**
Shows how to filter the actors that match a given criteria.
|br| `examples/s4u/platform-properties/s4u-platform-properties_d.xml <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/platform-properties/s4u-platform-properties_d.xml>`_
|br| `examples/platforms/prop.xml <https://framagit.org/simgrid/simgrid/tree/master/examples/platforms/prop.xml>`_
-.................
+=================
Energy Simulation
-.................
+=================
- **Describing the energy profiles in the platform:**
This platform file contains the energy profile of each links and
|br| `examples/s4u/energy-boot/platform_boot.xml <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/energy-boot/platform_boot.xml>`_
|br| `examples/s4u/energy-boot/s4u-energy-boot.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/energy-boot/s4u-energy-boot.cpp>`_
-.......................
+=======================
Tracing and Visualizing
-.......................
+=======================
Tracing can be activated by various configuration options which
are illustrated in these example. See also the
``--cfg=tracing:yes --cfg=tracing/categorized:yes``
|br| `examples/s4u/trace-platform/s4u-trace-platform.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/trace-platform/s4u-trace-platform.cpp>`_
-........................
+========================
Larger SimGrid Examplars
-........................
+========================
This section contains application examples that are somewhat larger
than the previous examples.
|br| `examples/s4u/app-masterworkers/s4u-app-masterworkers-fun.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/app-masterworkers/s4u-app-masterworkers-fun.cpp>`_
Data diffusion
-^^^^^^^^^^^^^^
+--------------
- **Bit Torrent:**
Classical protocol for Peer-to-Peer data diffusion.
|br| `examples/s4u/app-chainsend/s4u-app-chainsend.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/app-chainsend/s4u-app-chainsend.cpp>`_
Distributed Hash Tables (DHT)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+-----------------------------
- **Chord Protocol**
One of the most famous DHT protocol.
.. |br| raw:: html
<br />
+
+.. |cpp| image:: /img/lang_cpp.png
+ :align: middle
+ :width: 12
+
+.. |py| image:: /img/lang_python.png
+ :align: middle
+ :width: 12