Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Cosmetics: "transfert" -> "transfer".
[simgrid.git] / examples / README.rst
index c11029c..a03eb65 100644 (file)
@@ -319,6 +319,8 @@ the simulators (as detailed in Section :ref:`options`).
 
    .. example-tab:: examples/cpp/comm-pingpong/s4u-comm-pingpong.cpp
 
+   .. example-tab:: examples/python/comm-pingpong/comm-pingpong.py
+
    .. example-tab:: examples/c/comm-pingpong/comm-pingpong.c
 
 
@@ -353,9 +355,9 @@ This example is very similar to the previous one, simply adding how to declare t
 
       See also :cpp:func:`simgrid::s4u::Activity::wait_until()` and :cpp:func:`simgrid::s4u::Comm::wait_for()`.
 
-   .. example-tab:: examples/python/comm-waitfor/comm-waitfor.py
+   .. example-tab:: examples/python/comm-waituntil/comm-waituntil.py
 
-      See also :py:func:`simgrid.Comm.wait_for()` and :py:func:`simgrid.Comm.wait_any_for()`
+      See also :py:func:`simgrid.Comm.wait_until()`
 
 Suspending communications
 ^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -371,6 +373,11 @@ The ``suspend()`` and ``resume()`` functions block the progression of a given co
       :cpp:func:`simgrid::s4u::Activity::resume()` and
       :cpp:func:`simgrid::s4u::Activity::is_suspended()`.
 
+   .. example-tab:: examples/python/comm-suspend/comm-suspend.py
+
+      See also :py:func:`simgrid.Comm::suspend()` and
+      :py:func:`simgrid.Comm.resume()`.
+
 Waiting for all communications in a set
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -420,6 +427,9 @@ The ``test_any()`` returns whether at least one activity of the set has complete
 
       See also :cpp:func:`simgrid::s4u::Comm::test_any()`.
 
+   .. example-tab:: examples/python/comm-testany/comm-testany.py
+
+      See also :py:func:`simgrid.Comm.test_any()`.
 
 .. _s4u_ex_execution:
 
@@ -471,12 +481,12 @@ You can start asynchronous executions, just like you would fire background threa
    .. example-tab:: examples/python/exec-async/exec-async.py
 
       See also :py:func:`simgrid.this_actor.exec_init()`,
-      :py:func:`simgrid.Activity.start()`,
-      :py:func:`simgrid.Activity.wait()`,
+      :py:func:`simgrid.Exec.start()`,
+      :py:func:`simgrid.Exec.wait()`,
       :py:attr:`simgrid.Exec.remaining`,
       :py:attr:`simgrid.Exec.remaining_ratio`,
       :py:func:`simgrid.this_actor.exec_async()` and
-      :py:func:`simgrid.Activity.cancel()`.
+      :py:func:`simgrid.Exec.cancel()`.
 
    .. example-tab:: examples/c/exec-async/exec-async.c
 
@@ -507,6 +517,8 @@ You can start executions on remote hosts, or even change the host on which they
 
       See also :cpp:func:`sg_exec_set_host()`.
 
+.. _s4u_ex_ptasks:
+
 Parallel executions
 ^^^^^^^^^^^^^^^^^^^
 
@@ -528,6 +540,10 @@ This allows simulating malleable tasks.
 
       See also :cpp:func:`simgrid::s4u::this_actor::parallel_execute()`.
 
+   .. example-tab:: examples/python/exec-ptask/exec-ptask.py
+
+      See also :ref:`simgrid.this_actor.parallel_execute()`
+
 DVFS and pstates
 ^^^^^^^^^^^^^^^^
 
@@ -546,7 +562,7 @@ of a host can then be accessed and changed from the program.
 
    .. example-tab:: examples/python/exec-dvfs/exec-dvfs.py
 
-      See also :py:attr:`Host.pstate_speed` and :py:func:`Host.set_pstate()`.
+      See also :py:func:`simgrid.Host.pstate_speed()` and :py:attr:`simgrid.Host.pstate`.
 
    .. example-tab:: examples/platforms/energy_platform.xml
 
@@ -614,6 +630,8 @@ Shows how to use :cpp:type:`simgrid::s4u::Barrier` synchronization objects.
 
    .. example-tab:: examples/cpp/synchro-barrier/s4u-synchro-barrier.cpp
 
+   .. example-tab:: examples/python/synchro-barrier/synchro-barrier.py
+
 Condition variable: basic usage
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -641,6 +659,8 @@ Shows how to use :cpp:type:`simgrid::s4u::Mutex` synchronization objects.
 
    .. example-tab:: examples/cpp/synchro-mutex/s4u-synchro-mutex.cpp
 
+   .. example-tab:: examples/python/synchro-mutex/synchro-mutex.py
+
 Semaphore
 ^^^^^^^^^
 
@@ -650,6 +670,8 @@ Shows how to use :cpp:type:`simgrid::s4u::Semaphore` synchronization objects.
 
    .. example-tab:: examples/cpp/synchro-semaphore/s4u-synchro-semaphore.cpp
 
+   .. example-tab:: examples/python/synchro-semaphore/synchro-semaphore.py
+
    .. example-tab:: examples/c/synchro-semaphore/synchro-semaphore.c
 
 =============================
@@ -721,6 +743,8 @@ failures in your code. See also :ref:`howto_churn`.
 
    .. example-tab:: examples/c/platform-failures/platform-failures.c
 
+   .. example-tab:: examples/python/platform-failures/platform-failures.py
+
    .. group-tab:: XML
 
       .. showfile:: examples/platforms/small_platform_failures.xml
@@ -949,7 +973,7 @@ Shows how to implement a classical communication pattern, where a token is excha
 Master Workers
 ^^^^^^^^^^^^^^
 
-Another good old example, where one Master acto$ has a bunch of tasks to dispatch to a set of several Worker actors. 
+Another good old example, where one Master actor has a bunch of tasks to dispatch to a set of several Worker actors.
 This example is used in the :ref:`SimGrid tutorial <usecase_simalgo>`.
 
 .. tabs::
@@ -973,6 +997,8 @@ This example is used in the :ref:`SimGrid tutorial <usecase_simalgo>`.
       .. showfile:: examples/c/app-masterworker/app-masterworker.c
          :language: cpp
 
+   .. example-tab:: examples/python/app-masterworkers/app-masterworkers.py
+
 Data diffusion
 --------------