Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
document another s4u example
[simgrid.git] / examples / s4u / README.doc
index 776b9b0..7c8a609 100644 (file)
@@ -175,7 +175,10 @@ also the tesh files in the example directories for details.
     Show how define a set of pstatesfor a host in the XML, and how the current
     pstate can be accessed/changed with @ref simgrid::s4u::Host::getPstateSpeed and @ref simgrid::s4u::Host::setPstate.
 
-  TODO: add an example about parallel executions.
+  - <b>Parallel tasks</b>
+    @ref examples/s4u/exec-ptask/s4u-exec-ptask.cpp\n
+    These objects are convenient abstractions of parallel
+    computational kernels that span over several machines. 
 
 @subsection s4u_ex_activity_io I/O on disks and files
 
@@ -224,11 +227,23 @@ result in short reads and short write, as in reality.
 
 @section s4u_ex_energy Simulating the energy consumption
 
+  - <b>Describing the energy profiles in the platform</b>
+    @ref examples/platforms/energy_platform.xml \n
+    This platform file contains the energy profile of each links and
+    hosts, which is necessary to get energy consumption predictions.
+    As usual, you should not trust our example, and you should strive
+    to double-check that your instanciation matches your target platform.
+
   - <b>Consumption due to the CPU</b> 
     @ref examples/s4u/energy-exec/s4u-energy-exec.cpp \n
     This example shows how to retrieve the amount of energy consumed
     by the CPU during computations, and the impact of the pstate.
 
+  - <b>Consumption due to the network</b>
+    @ref examples/s4u/energy-link/s4u-energy-link.cpp
+    This example shows how to retrieve and display the energy consumed
+    by the network during communications.
+
 @section s4u_ex_tracing Tracing and visualization features
 
 Tracing can be activated by various configuration options which
@@ -266,7 +281,7 @@ than the previous examples.
 @subsection s4u_ex_app_data Data diffusion
 
   - <b>Bit Torrent</b> 
-    @ref examples/s4u/app-bittorrent/s4u-app-bittorrent.cpp\n
+    @ref examples/s4u/app-bittorrent/s4u-bittorrent.cpp\n
     Classical protocol for Peer-to-Peer data diffusion.
     
   - <b>Chained send</b> 
@@ -276,7 +291,7 @@ than the previous examples.
 @subsection s4u_ex_app_dht Distributed Hash Tables (DHT)
 
   - <b>Chord Protocol</b> 
-    @ref examples/s4u/app-chord/s4u-app-chord.cpp\n
+    @ref examples/s4u/dht-chord/s4u-dht-chord.cpp\n
     One of the most famous DHT protocol.
 
 */
@@ -295,17 +310,20 @@ than the previous examples.
 @example examples/s4u/async-wait/s4u-async-wait.cpp
 @example examples/s4u/async-waitall/s4u-async-waitall.cpp
 @example examples/s4u/async-waitany/s4u-async-waitany.cpp
+@example examples/s4u/dht-chord/s4u-dht-chord.cpp
 @example examples/s4u/exec-basic/s4u-exec-basic.cpp
 @example examples/s4u/exec-async/s4u-exec-async.cpp
 @example examples/s4u/exec-dvfs/s4u-exec-dvfs.cpp
 @example examples/s4u/exec-monitor/s4u-exec-monitor.cpp
+@example examples/s4u/exec-ptask/s4u-exec-ptask.cpp
 @example examples/s4u/exec-remote/s4u-exec-remote.cpp 
-@example examples/s4u/app-bittorrent/s4u-app-bittorrent.cpp
+@example examples/s4u/app-bittorrent/s4u-bittorrent.cpp
 @example examples/s4u/app-chainsend/s4u-app-chainsend.cpp
 @example examples/s4u/app-masterworker/s4u-app-masterworker.cpp
 @example examples/s4u/app-pingpong/s4u-app-pingpong.cpp
 @example examples/s4u/app-token-ring/s4u-app-token-ring.cpp
 @example examples/s4u/energy-exec/s4u-energy-exec.cpp
+@example examples/s4u/energy-link/s4u-energy-link.cpp
 @example examples/s4u/io-file-system/s4u-io-file-system.cpp
 @example examples/s4u/io-file-remote/s4u-io-file-remote.cpp
 @example examples/s4u/io-storage-raw/s4u-io-storage-raw.cpp