Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
add comment about chiller/battery plugins. Fix chiller doc not showing
[simgrid.git] / docs / source / Plugins.rst
index aeac133..c40e5e6 100644 (file)
@@ -23,6 +23,9 @@ documents some of the plugins distributed with SimGrid:
   - :ref:`Host Energy <plugin_host_energy>`: models the energy dissipation of the compute units.
   - :ref:`Link Energy <plugin_link_energy>`: models the energy dissipation of the network.
   - :ref:`WiFi Energy <plugin_link_energy_wifi>`: models the energy dissipation of wifi links.
+  - :ref:`Battery <plugin_battery>`: models batteries that get discharged by the energy consumption of a given host.
+  - :ref:`Solar Panel <plugin_solar_panel>`: models solar panels which energy production depends on the solar irradiance.
+  - :ref:`Chiller <plugin_chiller>`: models chillers which dissipate heat by consuming energy.
 
 You can activate these plugins with the :ref:`--cfg=plugin <cfg=plugin>` command
 line option, for example with ``--cfg=plugin:host_energy``. You can get the full
@@ -67,7 +70,10 @@ kind of objects, please let us now.
 
   Fire that signal, invoking all callbacks.
 
-Partial list of existing signals in s4u:
+.. _s4u_API_signals:
+
+Existing signals
+================
 
 - In actors:
   :cpp:func:`Actor::on_creation <simgrid::s4u::Actor::on_creation_cb>`
@@ -215,22 +221,22 @@ File System
 .. _plugin_battery:
 
 Battery
-===========
+=======
 
 .. doxygengroup:: plugin_battery
 
-.. _plugin_task:
+.. _plugin_solar_panel:
 
-Task
+Solar Panel
 ===========
 
-.. doxygengroup:: plugin_task
+.. doxygengroup:: plugin_solar_panel
 
-.. _plugin_photovoltaic:
+.. _plugin_chiller:
 
-Photovoltaic
-===========
+Chiller
+=======
 
-.. doxygengroup:: plugin_photovoltaic
+.. doxygengroup:: plugin_chiller
 
 ..  LocalWords:  SimGrid