Merge nodehelper lib and example codes into charm
[charm.git] / README.bigsim_quick
1 This is a step-by-step quick tutorial for simple usage of BigSim 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" with Projections module, for example:
14         cd tests/ampi/jacobi3d; make OPTS="-tracemode projections"
15
16 4- run your application emulating the target machine and rename the symbol file, for example:
17         ./charmrun +p1 jacobi 4 4 2 5 +vp32 +x32 +y1 +z1 +cth1 +wth1 +bglog
18         mv jacobi.sts tproj.sts  #rename the symbol file
19
20 5- download BigSim's simulator
21         cd ~
22         git clone git://charm.cs.uiuc.edu/BigFastSim
23
24 6- build BigFastSim:
25         cd BigFastSim/Release
26         vim makefile  #change CHARMPATH=$(HOME)/charm/net-linux-x86_64-bigemulator-bigsim/
27         make
28
29 7- copy simulator to trace files' directory:
30         cd ~/charm/tests/ampi/jacobi3d
31         cp ~/BigFastSim/Release/seqSimulator .
32
33 8- run the simulator with projections output: (to see other options such as changing latency and bandwidth run "./seqSimulator -help")
34         ./seqSimulator -tproj
35
36 9- download and make Projections:
37         git clone git://charm.cs.uiuc.edu/projections.git
38         cd projections
39         ant
40
41 10- run Projections:
42         ./bin/projections64 #open tproj.sts file
43
44 After opeing the symbol file (file/open <tproj.sts>), you can use different features of Projections such as tools/Timelines.
45
46 -by Ehsan (totoni2@illinois.edu) April 9, 2012
47