X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/8e07254f3777d8ecca2276e9ce60e3ae4473f47e..2d749015a668d1f9eeb095836a828c483fb37f26:/examples/README.rst diff --git a/examples/README.rst b/examples/README.rst index 7a4d9fdca7..197c54c387 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -29,7 +29,7 @@ Actors: the Active Entities =========================== Starting and Stopping Actors ---------------------------- +---------------------------- - **Creating actors:** Most actors are started from the deployment XML file, because this @@ -147,7 +147,7 @@ Starting and Stopping Actors - **Specify the stack size to use** The stack size can be specified by default on the command line, - globally by changing the configuration with :cpp:func:`simgrid::s4u::Engine::set_config(std::string)`, + globally by changing the configuration with :cpp:func:`simgrid::s4u::Engine::set_config`, or for a specific actor using :cpp:func:`simgrid::s4u::Actor::set_stacksize` before its start. .. tabs:: @@ -644,14 +644,22 @@ Energy Simulation ================= - **Describing the energy profiles in the platform:** - 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 instantiation matches your target platform. + The first platform file contains the energy profile of each links and + hosts for a wired network, which is necessary to get energy consumption + predictions. The second platform file is the equivalent for a wireless + network. As usual, you should not trust our example, and you should + strive to double-check that your instantiation matches your target + platform. .. tabs:: - .. example-tab:: examples/platforms/energy_platform.xml + .. group-tab:: XML + + .. showfile:: examples/platforms/energy_platform.xml + :language: xml + + .. showfile:: examples/platforms/wifi_energy.xml + :language: xml - **Consumption due to the CPU:** This example shows how to retrieve the amount of energy consumed @@ -663,14 +671,22 @@ Energy Simulation .. example-tab:: examples/c/energy-exec/energy-exec.c - - **Consumption due to the network:** + - **Consumption due to the wired network:** This example shows how to retrieve and display the energy consumed - by the network during communications. + by the wired network during communications. .. tabs:: .. example-tab:: examples/s4u/energy-link/s4u-energy-link.cpp + - **Consumption due to the wireless network:** + This example shows how to retrieve and display the energy consumed + by the wireless network during communications. + + .. tabs:: + + .. example-tab:: examples/s4u/energy-wifi/s4u-energy-wifi.cpp + - **Modeling the shutdown and boot of hosts:** Simple example of model of model for the energy consumption during the host boot and shutdown periods.