Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of github.com:mquinson/simgrid
[simgrid.git] / contrib / psg / README.txt
1 Mon Jan 26 16:00 CEST 2015
2 This is version 1.0 of PeerSimGrid
3
4 1) An overview
5 2) Preliminaries
6 3) Compile & Run 
7
8 --------------------------------------------------------------------------------------------
9 1) An overview:
10 PeerSimGrid (PSG) is an interface developed in Java and allows users to simulate 
11 and execute their code under PeerSim or Simgrid simulator, using PeerSim implementation policy.
12         
13 This archive is composed of:
14 * the src/ directory containing the simulator source and examples
15 * the configs/ directory containing example of configuration files
16 * psg.jar, a java archive containing all libraries  
17
18
19 2) Preliminaries:
20         Before using psg simulator, you need to make some changes in your configuration file:
21                 * Replace the "UniformRandomTransport" transport protocol by "psgsim.PSGTransport".
22                 * Replace the "simulation.endtime" by "simulation.duration"
23                 * you can define your platform on the configuration file as:
24                         platform path/to/your/file.xml 
25         
26         
27 3) Compile & Run:
28         In short, the way to compile and execute your code is: 
29                 Compile it:                
30                 $> make compile
31                 
32                 Test it (optional):
33                 $> make test
34                 This test execute two examples, (chord and edaggregation found in the example folder), under the two simulators
35                 and compare their outputs.      
36                 
37                 Run it:
38                 $> ./run.sh path/to/your/configuration_file 
39                 For example: 
40                         $>./run.sh configs/chordPSG.txt 
41                         
42                 For the documentation
43                 $> make doc
44                 
45                 For the help command
46                 $> make help
47                 
48 Note: For more informations please contact khaled.baati@gmail.com