From 4c6d90871c15284343a2c72211b895c4309c81ba Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Mon, 11 Dec 2017 01:31:04 +0100 Subject: [PATCH 1/1] improve doc --- doc/doxygen/platform.doc | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc index 1ef202b403..a146547b4e 100644 --- a/doc/doxygen/platform.doc +++ b/doc/doxygen/platform.doc @@ -1543,6 +1543,36 @@ for @ref pf_trace "trace_connect": ./two_hosts.xml:17: @endverbatim +\subsection pf_hint_generating How to generate different platform files? + +This is actually a good idea to search for a better platform file, +that better fit the need of your study. To be honest, the provided +examples are not representative of anything. They exemplify our XML +syntax, but that's all. small_platform.xml for example was generated +without much thought beyond that. + +The best thing to do when possible is to write your own platform file, +that model the platform on which you run your code. For that, you +could use our +calibration scripts. This leads to very good fits between the +platform, the model and the needs. The g5k.xml example resulted of +such an effort, which also lead to an +ongoing attempt to automatically extract the SimGrid platform from +the Grid'5000 experimental platform. +But it's hard to come up with generic models. Don't take these files +too seriously. Actually, you should always challenge our models and +your instanciation if the accuracy really matters to you (see this discussion). + +But such advices only hold if you have a real platform and a real +application at hand. It's moot for more abstract studies working on +ideas and algorithms instead of technical artefacts. Well, in this +case, there unfortunately is nothing better than this old and rusty +simulacrum. +This project is dormant since over 10 years (and you will have to +update the generated platforms with bin/simgrid_update_xml to +use them), but that's the best we have for this right now.... + \subsection pf_as_h AS Hierarchy The AS design allows SimGrid to go fast, because computing route is done only for the set of resources defined in this AS. If you're using -- 2.20.1