doc: Add serial to list of ci file reserved words
[charm.git] / examples / pose / LBSim / README
1 How to run it
2
3 ./charmrun sched <maxObjects> <connectivity> <value> <endTime> <topology> > <datafilename>
4
5 1.maxObjects : Number of scheduler objects ie no. of processors in the simulation
6
7 2.connectivity: Only for the graph topology (TODO: Needs to be made functional)
8
9 3.value: Value for which fibonacci is to be calculated
10
11 4.endTime: The POSE endTime, the simulation stops when GVT reaches this value.
12
13 5.topology: Four topologies supported now: graph, ring, tours2d, torus3d
14
15 5.datafilename: The name of file in which the output will be stored. This is done by directing the output to the file by '>'.
16
17 Next step would be 
18 ./statcoll <datafilename> <outputfilename1> <maxObjects> <endTime>
19 ./statanly <outputfilename1> <outputfilename2> <maxObjects> <endTime>
20
21 statcoll parses the data file so as to collect the raw statistics of each processor for each period.
22 statanly analyses the outputfile1 to calculate average utilisation per processor per period
23
24 Note: endTime here is actual end of simulation i.e. last time entry in the datafile
25
26 (TODO: Combine both steps into one (?))
27
28 Next <outputfilename2>  should be appropriately entered in the gnuplot script such as plotsim.p 
29
30 Then a command "gnuplot plotsim.p" will generate the graphical output.
31
32 To add a new topology:
33 1)Declare the topology class in topology.h.
34 2)Include two functions: a) max_neighbors() which gives the number of neighbors and b)neighbors() which returns the list of neighbors
35 3)Define the functions in topology.C
36 4)Register the topology in class CkLBTopoVec