Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
doc: split the calibration sections in their own file
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Sat, 25 Dec 2021 18:48:18 +0000 (19:48 +0100)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Sun, 26 Dec 2021 22:09:02 +0000 (23:09 +0100)
MANIFEST.in
docs/source/Calibrating_the_models.rst [new file with mode: 0644]
docs/source/Modeling_howtos.rst
docs/source/index.rst
docs/source/tuto_disk/analysis.irst
docs/source/tuto_network_calibration/network_calibration_tutorial.rst
tools/cmake/DefinePackages.cmake

index 400d836..57b0fb5 100644 (file)
@@ -1825,6 +1825,7 @@ include docs/manpages/smpiff.1
 include docs/manpages/smpirun.1
 include docs/manpages/tesh.pod
 include docs/requirements.txt
+include docs/source/Calibrating_the_models.rst
 include docs/source/Configuring_SimGrid.rst
 include docs/source/Deploying_your_application.rst
 include docs/source/Design_goals.rst
diff --git a/docs/source/Calibrating_the_models.rst b/docs/source/Calibrating_the_models.rst
new file mode 100644 (file)
index 0000000..55e90ea
--- /dev/null
@@ -0,0 +1,44 @@
+.. raw:: html
+
+   <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("PlatformBox")
+     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/>
+
+.. _models_calibration:
+
+Calibrating the models
+######################
+
+The simulation models in SimGrid have been object of thorough validation/invalidation campaigns, but the default values may
+not be appropriate for simulating a particular system.
+
+They are configured
+through parameters from the :ref:`XML platform description file <platform>` and parameters passed via
+:ref:`--cfg=Item:Value command-line arguments <options>`. A simulator may also include any number of custom model
+parameters that are used to instantiate particular simulated activities (e.g., a simulator developed with the S4U API
+typically defines volumes of computation, communication, and time to pass to methods such as :cpp:func:`execute()
+<simgrid::s4u::this_actor::execute>`, :cpp:func:`put() <simgrid::s4u::Mailbox::put>`, or :cpp:func:`sleep_for()
+<simgrid::s4u::this_actor::sleep_for>`). Regardless of the potential accuracy of the simulation models, if they are
+instantiated with unrealistic parameter values, then the simulation will be inaccurate. 
+
+Given the above, an integral and crucial part of simulation-driven research is **simulation calibration**: the process by
+which one picks simulation parameter values based on observed real-world executions so that simulated executions have high
+accuracy. We then say that a simulator is "calibrated". Once a simulator is calibrated for a real-world system, it can be
+used to simulate that system accurately. But it can also be used to simulate different but structurally similar systems
+(e.g., different scales, different basic hardware characteristics, different application workloads) with high confidence.
+
+Research conclusions derived from simulation results obtained with an uncalibrated simulator are questionable in terms of
+their relevance for real-world systems. Unfortunately, because simulation calibration is often a painstaking process, is it
+often not performed sufficiently thoroughly (or at all!). We strongly urge SimGrid users to perform simulation calibration.
+Here is an example of a research publication in which the authors have calibrated their (SimGrid) simulators:
+https://hal.inria.fr/hal-01523608
+
+.. include:: tuto_network_calibration/network_calibration_tutorial.rst
+
+.. include:: tuto_disk/analysis.irst
index d17d765..3772a67 100644 (file)
@@ -56,49 +56,6 @@ Unsupported claims, (6) Toy duck approach, and (7) The tunnel view. As
 you can see, this article is a must read. It's a pity that it's not
 freely available, though.
 
-.. _howto_calibration:
-
-Getting realistic results
-*************************
-
-The simulation models in SimGrid have been developed with care and the
-object of thorough validation/invalidation campaigns. These models
-come with parameters that configure their behaviors. The values of
-these parameters are set based on the :ref:`XML platform description
-file <platform>` and on parameters passed via :ref:`--cfg=Item:Value
-command-line arguments <options>`. A simulator may also include any
-number of custom model parameters that are used to instantiate
-particular simulated activities (e.g., a simulator developed with the
-S4U API typically defines volumes of computation, communication, and
-time to pass to methods such as :cpp:func:`execute()
-<simgrid::s4u::this_actor::execute>`, :cpp:func:`put()
-<simgrid::s4u::Mailbox::put>`, or :cpp:func:`sleep_for()
-<simgrid::s4u::this_actor::sleep_for>`).  Regardless of the potential
-accuracy of the simulation models, if they are instantiated with
-unrealistic parameter values, then the simulation will be inaccurate.
-The provided default values may or may not be appropriate for
-simulating a particular system.
-
-Given the above, an integral and crucial part of simulation-driven
-research is **simulation calibration**: the process by which one picks
-simulation parameter values based on observed real-world executions so
-that simulated executions have high accuracy.  We then say that a
-simulator is "calibrated".  Once a simulator is calibrated for a
-real-world system, it can be used to simulate that system accurately.
-But it can also be used to simulate different but structurally
-similar systems (e.g., different scales, different basic hardware
-characteristics, different application workloads) with high confidence.
-
-Research conclusions derived from simulation results obtained with an
-uncalibrated simulator are questionable in terms of their relevance
-for real-world systems. Unfortunately, because simulation calibration
-is often a painstaking process, is it often not performed sufficiently
-thoroughly (or at all!). We strongly urge SimGrid users to perform
-simulation calibration. Here is an example of a research publication
-in which the authors have calibrated their (SimGrid) simulators:
-https://hal.inria.fr/hal-01523608
-
-
 .. _howto_churn:
 
 Modeling churn (e.g., in P2P)
@@ -289,6 +246,3 @@ So the final platform for our example becomes :
         <link_ctn id="link2"/>
     </route>
 
-.. include:: tuto_disk/analysis.irst
-
-.. include:: tuto_network_calibration/network_calibration_tutorial.rst
index b171262..79d0214 100644 (file)
@@ -81,11 +81,11 @@ of every page. Bugs in the code should be reported
       The SimGrid models <Models.rst>      
          SimGrid plugins <Plugins.rst>
          Modeling hints <Modeling_howtos.rst>
+         Calibrating the models <Calibrating_the_models.rst>   
       Running an experiment <Experimental_setup.rst>
          Configuring SimGrid <Configuring_SimGrid.rst>
          Deploying your application <Deploying_your_application.rst>
          Simulation outcomes <Outcomes.rst>
-      Frequently asked questions <faq.rst>
 
 .. toctree::
    :hidden:
index d782b38..2f564af 100644 (file)
@@ -1,8 +1,8 @@
 .. This file has "irst" as an extension to ensure that it's not parsed by sphinx as is. Instead, it's included in another file that is parsed.
 .. _howto_disk:
 
-Modeling I/O: the realistic way
-*******************************
+I/O calibration
+***************
 
 Introduction
 ============
index 202bd92..566b78f 100644 (file)
@@ -1,5 +1,5 @@
-SimGrid MPI calibration of a Grid5000 cluster
-*********************************************
+MPI Network calibration
+***********************
 
 This tutorial demonstrates how to properly calibrate SimGrid to reflect
 the performance of MPI operations in a Grid’5000 cluster. However, the same
index c0f2055..22263af 100644 (file)
@@ -917,6 +917,7 @@ set(DOC_SOURCES
   docs/source/app_s4u.rst
   docs/source/app_smpi.rst
   docs/source/The_XBT_toolbox.rst
+  docs/source/Calibrating_the_models.rst
   docs/source/community.rst
   docs/source/Configuring_SimGrid.rst
   docs/source/Deploying_your_application.rst