.. _plugins:
+SimGrid Plugins
+###############
+
.. raw:: html
- <object id="TOC" data="graphical-toc.svg" width="100%" type="image/svg+xml"></object>
+ <object id="TOC" data="graphical-toc.svg" type="image/svg+xml"></object>
<script>
window.onload=function() { // Wait for the SVG to be loaded before changing it
var elem=document.querySelector("#TOC").contentDocument.getElementById("PluginsBox")
elem.style="opacity:0.93999999;fill:#ff0000;fill-opacity:0.1;stroke:#000000;stroke-width:0.35277778;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1";
}
</script>
- <br/>
- <br/>
-
-SimGrid Plugins
-###############
+ <br />
+ <br />
You can extend SimGrid without modifying it, thanks to our plugin
mechanism. This page describes how to write your own plugin, and
-documents some of the plugins distributed with SimGrid.
+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:`Host Load <plugin_host_load>`: monitors the load of the compute units.
-- :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:`Host Load <plugin_host_load>`: monitors the load of the compute units.
+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
+list of existing plugins with ``--cfg=plugin:help``.
Defining a Plugin
*****************
.. _plugin_host_energy:
-Host Energy Plugin
-==================
+Host Energy
+===========
.. doxygengroup:: Plugin_host_energy
+
+
.. _plugin_link_energy:
-Link Energy Plugin
-==================
+Link Energy
+===========
.. doxygengroup:: Plugin_link_energy
+
+
.. _plugin_host_load:
-Host Load Plugin
-================
+Host Load
+=========
.. doxygengroup:: Plugin_host_load
+
+
+.. _plugin_filesystem:
+
+File System
+===========
+
+.. doxygengroup:: Plugin_filesystem
+
+
.. LocalWords: SimGrid
+
