Merge branch 'charm' of charmgit:charm into harshitha/adaptive_lb
[charm.git] / README.bigsim_quick
1 This is a step-by-step quick tutorial for simple usage of BigSim simulation framework and visualizing its Projections output logs.
2 For more information, please refer to BigSim and Projections manuals.
3
4 1- download latest version of Charm from website or git repository:
5         cd ~
6         git clone git://charm.cs.uiuc.edu/charm.git
7
8 2- build charm (and AMPI) with bigemulator and bigsim (replace "linux" with "darwin" for mac):
9         cd charm
10         ./build charm++ net-linux-x86_64 bigemulator bigsim
11         ./build AMPI net-linux-x86_64 bigemulator bigsim
12
13 3- compile your code using charm or AMPI compilers located in "net-linux-x86_64-bigemulator-bigsim/bin", for example:
14         cd tests/ampi/jacobi3d; make 
15
16 4- run your application emulating the target machine, for example:
17         ./charmrun +p1 jacobi 4 4 2 5 +vp32 +x32 +y1 +z1 +cth1 +wth1 +bglog
18
19 5- download BigSim's simulator
20         cd ~
21         git clone git://charm.cs.uiuc.edu/BigFastSim
22
23 6- build BigFastSim:
24         cd BigFastSim/Release
25         vim makefile  #change CHARMPATH=$(HOME)/charm/net-linux-x86_64-bigemulator-bigsim/
26         make
27
28 7- copy simulator to trace files' directory:
29         cd ~/charm/tests/ampi/jacobi3d
30         cp ~/BigFastSim/Release/seqSimulator .
31
32 8- run the simulator with projections output: (to see other options such as changing latency and bandwidth run "./seqSimulator -help")
33         ./seqSimulator -tproj
34
35 9- download and make Projections:
36         git clone git://charm.cs.uiuc.edu/projections.git
37         cd projections
38         ant
39
40 10- run Projections:
41         ./bin/projections64 #open tproj.sts file
42
43 After opeing the symbol file (file/open <tproj.sts>), you can use different features of Projections such as tools/Timelines.
44
45 -by Ehsan (totoni2@illinois.edu) April 9, 2012
46