Make opt::exit_on_convergence an unsigned int.

[loba.git] / README

diff --git a/README b/README
index 1cfa637ec3ed18036537b88478fb1d8d8ad58f30..7368386da22bca7f2c5c49fbc7b1ab7e2575762b 100644 (file)
--- a/README
+++ b/README
@@ -46,6 +46,45 @@ Pour changer le niveau de détail des affichages :
 Pour plus de détail sur les options de logging :
     http://simgrid.gforge.inria.fr/doc/group__XBT__log.html#log_use
 
+Sorties
+=======
+
+* pendant la simulation :
+[Bourassa 5.000000] [proc/INFO] (6:1) current load: 5
+ +------- +-------   +--------   + +  -----+---------
+ |        |          |           | |       |
+ |        |          |           | |       \_ charge courante
+ |        |          |           | |
+ |        |          |           | \_ nombre d'itérations de calculs
+ |        |          |           |
+ |        |          |           \_ nombre d'itérations d'équilibrage
+ |        |          |
+ |        |          \_ catégorie de messages
+ |        |
+ |        \_ date courante (en secondes, dans la simulation)
+ |
+ \ nom du nœud
+
+* à la fin de la simulation :
+[Bourassa 108.886866] [proc/INFO] Final load after 107:4 iterations: 1.04113
+ +------- +---------   +--------                   +-- +             +------
+ |        |            |                           |   |             |
+ |        |            |                           |   |             \_ charge
+ |        |            |                           |   |                courante
+ |        |            |                           |   |
+ |        |            |                           |   \_ nombre d'itérations
+ |        |            |                           |      de calculs
+ |        |            |                           |
+ |        |            |                           \_ nombre d'itérations
+ |        |            |                              d'équilibrage
+ |        |            |
+ |        |            \_ catégorie de messages
+ |        |
+ |        \_ date courante (en secondes, dans la simulation)
+ |
+ \ nom du nœud
+
+
 Tracé de courbes
 ================
 
@@ -53,9 +92,14 @@ Le script extract.pl permet d'extraire les données à partir des traces
 de simulation et de le présenter sous un format acceptable par gnuplot
 ou par graph (plotutils).
 
-Exemple:
+Exemples:
         ./loba platform.xml 2>&1 | ./extract.pl | graph -CTX
 
+        ./loba platform.xml 2>&1 | ./extract.pl | graph -CTX -y 0 250
+
+        ./loba platform.xml 2>&1 | ./extract.pl \
+            | gnuplot -p -e 'plot "-" using 1:2:(column(-2)) with lines lc variable'
+
 Communications
 ==============
 
@@ -98,6 +142,7 @@ Pour ajouter un nouvel algorithme d'équilibrage
            pneigh[i]->get_load() ;
      - définit la charge à envoyer avec
            send(pneigh[i], quantité) ;
+   NB: le script new_loba.sh peut servir à créer les fichiers.
 
 2. Ajouter l'algorithme dans la liste des options.  Dans options.cpp :
    - faire le #include adéquat ;
@@ -135,14 +180,16 @@ Liste de fichiers
 
 * fichiers sources
 
-    communicator.h
-    communicator.cpp            la couche de communication
+    atomic_compat.h             chargement des la classe std::atomic<T>
+
+    communicator.h              la couche de communication
+    communicator.cpp
 
-    cost_func.h
-    cost_func.cpp               fonctions de coût pour comm_cost et comp_cost
+    cost_func.h                 fonctions de coût pour comm_cost et comp_cost
+    cost_func.cpp
 
-    deployment.h
-    deployment.cpp              génération automatique de déploiement
+    deployment.h                génération automatique de déploiement
+    deployment.cpp
 
     hostdata.h                  gestion des boites de réception, par hôte
     hostdata.cpp
@@ -154,9 +201,15 @@ Liste de fichiers
 
     main.cpp                    le programme principal
 
+    message.h                   file de messages reçus
+    message.cpp
+
     misc.h                      divers trucs inclassables
     misc.cpp
 
+    msg_thread.h                creation de threads SG/MSG
+    msg_thread.cpp
+
     named_object_list.h         gestion d'une table de constructeurs
                                 avec des noms et des descriptions
 
@@ -171,10 +224,16 @@ Liste de fichiers
 
     simgrid_features.h          macros pour détecter la version de SimGrid
 
-    simple_async.cpp            un simple programme de test
+    statistics.h                pour calculer moyenne, variance, etc.
+
+    synchro.h                   mutex, condition, etc.
+
+    sync_queue.h                lock-free synchronized queue
 
     timer.h                     gestion de timer
 
+    tracing.h                   définitions liées au traçage
+
     version.h                   gestion de la version du programme
     version.cpp
 
@@ -186,11 +245,14 @@ Liste de fichiers
     extract.pl                  outil d'extraction des données à partir des
                                 traces, pour tracer des courbes
 
+    new_loba.sh                 pour créer le squelette d'un nouvel algo
+                                d'équiblibrage loba_*
+
     setlocalversion             calcule un numéro de version à partir du hash
                                 du dernier commit (git)
 
 * autres fichiers
 
     .gitignore                  liste des fichiers ignorés par git
-    valgrind_suppressions_3.5   liste de quelques suppressions pour valgrind
+    valgrind_suppressions       liste de quelques suppressions pour valgrind
                                 avec SimGrid 3.5