From: Martin Quinson Date: Fri, 15 Dec 2017 22:55:42 +0000 (+0100) Subject: document another s4u example X-Git-Tag: v3.18~28^2~5 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/63a8fb284a051f3748a3eb0cdf73882a47c00c9d document another s4u example --- diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc index 09cfb460c2..7c8a609304 100644 --- a/examples/s4u/README.doc +++ b/examples/s4u/README.doc @@ -227,11 +227,23 @@ result in short reads and short write, as in reality. @section s4u_ex_energy Simulating the energy consumption + - Describing the energy profiles in the platform + @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. + - Consumption due to the CPU @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. + - Consumption due to the network + @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 @@ -311,6 +323,7 @@ than the previous examples. @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