From d7e102ce6c4eb6c2bd7f629e4beb6fc4f6fedc3b Mon Sep 17 00:00:00 2001 From: Adrien Gougeon Date: Thu, 2 Nov 2023 17:52:13 +0100 Subject: [PATCH] add comment about chiller/battery plugins. Fix chiller doc not showing --- ChangeLog | 4 ++++ docs/source/Plugins.rst | 5 +++-- docs/source/Release_Notes.rst | 7 ++++--- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/ChangeLog b/ChangeLog index 605242b95a..c3e7d414e3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -9,6 +9,9 @@ S4U: - Introduce a Mailbox::get_async() with no payload parameter. You can use the new Comm::get_payload() once the communication is over to retrieve the payload. - Implement recursive mutexes. Simply pass true to the constructor to get one. + - Update of the Task model. Each Task now consists of a dispatcher, a collector + and one or more instances. The parallelism degree of each of these can be set. + Several examples have been added or modified accordingly. SMPI: - New SMPI_app_instance_join(): wait for the completion of a started MPI instance @@ -32,6 +35,7 @@ C API: Plugins: - Revamp the battery plugin: rewrite completely the API, for a better usability. The examples were updated accordingly. + The battery can now act as a simple connector. See battery-connector example. - Revamp of the Photovoltaic plugin: now called SolarPanel and complete rewrite of the API - Add chiller plugin: enable the management of chillers consuming electrical energy to compensate heat generated by hosts. diff --git a/docs/source/Plugins.rst b/docs/source/Plugins.rst index 659e67c1ce..c40e5e61b9 100644 --- a/docs/source/Plugins.rst +++ b/docs/source/Plugins.rst @@ -25,6 +25,7 @@ documents some of the plugins distributed with SimGrid: - :ref:`WiFi Energy `: models the energy dissipation of wifi links. - :ref:`Battery `: models batteries that get discharged by the energy consumption of a given host. - :ref:`Solar Panel `: models solar panels which energy production depends on the solar irradiance. + - :ref:`Chiller `: models chillers which dissipate heat by consuming energy. You can activate these plugins with the :ref:`--cfg=plugin ` command line option, for example with ``--cfg=plugin:host_energy``. You can get the full @@ -231,11 +232,11 @@ Solar Panel .. doxygengroup:: plugin_solar_panel +.. _plugin_chiller: + Chiller ======= .. doxygengroup:: plugin_chiller - .. doxygentypedef:: ChillerPtr - .. LocalWords: SimGrid diff --git a/docs/source/Release_Notes.rst b/docs/source/Release_Notes.rst index 55b0d5a2d8..bd5f6a7b59 100644 --- a/docs/source/Release_Notes.rst +++ b/docs/source/Release_Notes.rst @@ -626,9 +626,10 @@ reacting to every signals of a class, and then filtering on the object you want. completion) are now specialized by activity class. That is, callbacks registered in Exec::on_suspend_cb will not be fired for Comms nor Ios -Two new useful plugins were added: The :ref:`battery plugin` can be used to create batteries that get discharged -by the energy consumption of a given host, while the :ref:`solar panel plugin ` can be used to create -solar panels which energy production depends on the solar irradiance. These plugins could probably be better integrated +Three new useful plugins were added: The :ref:`battery plugin` can be used to create batteries that get discharged +by the energy consumption of a given host, the :ref:`solar panel plugin ` can be used to create +solar panels which energy production depends on the solar irradiance and the :ref:`chiller plugin ` can be used to +create chillers and compensate the heat generated by hosts. These plugins could probably be better integrated in the framework, but our goal is to include in SimGrid the building blocks upon which everybody would agree, while the model elements that are more arguable are provided as plugins, in the hope that the users will carefully assess the plugins and adapt them to their specific needs before usage. Here for example, there is several models of batteries (the one provided does not -- 2.20.1