Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics in doc
[simgrid.git] / examples / README.rst
index 7d6dc0b..af59d29 100644 (file)
@@ -108,7 +108,7 @@ Actors can forcefully stop other actors.
 
    .. example-tab:: examples/python/actor-kill/actor-kill.py
 
-      See also :py:func:`simgrid.Actor.kill`, :py:func:`simgrid.Actor.kill_all`, :py:func:`simgrid.this_actor.exit`,
+      See also :py:func:`simgrid.Actor.kill()`, :py:func:`simgrid.Actor.kill_all()`, :py:func:`simgrid.this_actor.exit()`,
       :py:func:`simgrid.this_actor.on_exit`.
 
    .. example-tab:: examples/c/actor-kill/actor-kill.c
@@ -216,7 +216,7 @@ Actors can move or be moved from a host to another very easily. It amounts to se
 
    .. example-tab:: examples/python/actor-migrate/actor-migrate.py
 
-      See also :py:func:`simgrid.this_actor.set_host()` and :py:func:`simgrid.Actor.set_host()`.
+      See also :py:attr:`simgrid.Actor.host`.
 
    .. example-tab:: examples/c/actor-migrate/actor-migrate.c
 
@@ -353,6 +353,10 @@ 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
+
+      See also :py:func:`simgrid.Comm.wait_for()` and :py:func:`simgrid.Comm.wait_any_for()`
+
 Suspending communications
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -469,8 +473,8 @@ You can start asynchronous executions, just like you would fire background threa
       See also :py:func:`simgrid.this_actor.exec_init()`,
       :py:func:`simgrid.Activity.start()`,
       :py:func:`simgrid.Activity.wait()`,
-      :py:func:`simgrid.Activity.get_remaining()`,
-      :py:func:`simgrid.Exec.get_remaining_ratio()`,
+      :py:attr:`simgrid.Exec.remaining`,
+      :py:attr:`simgrid.Exec.remaining_ratio`,
       :py:func:`simgrid.this_actor.exec_async()` and
       :py:func:`simgrid.Activity.cancel()`.
 
@@ -497,12 +501,14 @@ You can start executions on remote hosts, or even change the host on which they
 
    .. example-tab:: examples/python/exec-remote/exec-remote.py
 
-      See also :py:func:`simgrid.Exec.set_host()`.
+      See also :py:attr:`simgrid.Exec.host`.
 
    .. example-tab:: examples/c/exec-remote/exec-remote.c
 
       See also :cpp:func:`sg_exec_set_host()`.
 
+.. _s4u_ex_ptasks:
+
 Parallel executions
 ^^^^^^^^^^^^^^^^^^^
 
@@ -542,7 +548,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:func:`Host.get_pstate_speed` and :py:func:`Host.set_pstate`.
+      See also :py:attr:`Host.pstate_speed` and :py:func:`Host.set_pstate()`.
 
    .. example-tab:: examples/platforms/energy_platform.xml
 
@@ -610,6 +616,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
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -637,6 +645,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
 ^^^^^^^^^
 
@@ -735,6 +745,8 @@ Shows how to specify an external load to resources, variating their peak speed o
 
       .. example-tab:: examples/cpp/platform-profile/s4u-platform-profile.cpp
 
+      .. example-tab:: examples/python/platform-profile/platform-profile.py
+
       .. group-tab:: XML
 
          .. showfile:: examples/platforms/small_platform_profile.xml
@@ -1075,6 +1087,15 @@ Another well-known DHT protocol.
       .. showfile:: examples/c/dht-kademlia/node.c
          :language: cpp
 
+Pastry
+^^^^^^
+
+Yet another well-known DHT protocol.
+
+.. tabs::
+
+   .. example-tab:: examples/c/dht-pastry/dht-pastry.c
+
 .. _s4u_ex_clouds:
 
 Simulating Clouds