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