bigsim tutorial added to manual
authorEhsan Totoni <totoni2@illinois.edu>
Fri, 18 May 2012 15:15:01 +0000 (10:15 -0500)
committerEhsan Totoni <totoni2@illinois.edu>
Fri, 18 May 2012 15:15:01 +0000 (10:15 -0500)
README.bigsim_quick
doc/charm++/manual.tex
doc/charm++/quickbigsim.tex [new file with mode: 0644]

index caf0e8e93d1ce1c82c546125b8c4f3028b9db645..03b91e255d9a1fef2b1e50bae0053089e0af6442 100644 (file)
@@ -1,4 +1,4 @@
-This is a step-by-step quick tutorial for simple usage of BigSim and visualizing its Projections output logs.
+This is a step-by-step quick tutorial for simple usage of BigSim simulation framework and visualizing its Projections output logs.
 For more information, please refer to BigSim and Projections manuals.
 
 1- download latest version of Charm from website or git repository:
index 0c38f31e064178ba0e4599011520a2e69c979059..c1146a3f2ecadf904cfe855f9d73eaa4031bb16d 100644 (file)
@@ -2,6 +2,7 @@
 
 \usepackage{../pplmanual} \input{../pplmanual} \usepackage{html}
 \usepackage{listings}
+\usepackage{textcomp}
 %sadly latex2html does not understand listings
 %this hack will at least give you the program listing instead of garbage
 \begin{htmlonly}
 
 \input{sdag}
 
+\input{quickbigsim}
+
 \input{further}
 
 \input{index}
diff --git a/doc/charm++/quickbigsim.tex b/doc/charm++/quickbigsim.tex
new file mode 100644 (file)
index 0000000..5445087
--- /dev/null
@@ -0,0 +1,50 @@
+\section{Quick BigSim Tutorial}
+\label{sec:bigtutor}
+
+This is a step-by-step quick tutorial for simple usage of BigSim simulation framework and visualizing its Projections output logs.
+For more information, please refer to BigSim and Projections manuals.
+
+\begin{enumerate}
+
+\item download latest version of Charm from website or git repository:\\
+        cd $\sim$ \\
+        git clone git://charm.cs.uiuc.edu/charm.git\\
+
+\item build charm (and AMPI) with bigemulator and bigsim (replace ``linux" with ``darwin" for mac):\\
+        cd charm\\
+        ./build charm++ net-linux-x86\_64 bigemulator bigsim\\
+        ./build AMPI net-linux-x86\_64 bigemulator bigsim\\
+
+\item compile your code using charm or AMPI compilers located in ``net-linux-x86\_64-bigemulator-bigsim/bin", for example:\\
+        cd tests/ampi/jacobi3d; make\\
+
+\item run your application emulating the target machine, for example:\\
+        ./charmrun +p1 jacobi 4 4 2 5 +vp32 +x32 +y1 +z1 +cth1 +wth1 +bglog\\
+
+\item download BigSim's simulator\\
+        cd $\sim$\\
+        git clone git://charm.cs.uiuc.edu/BigFastSim\\
+
+\item build BigFastSim:\\
+        cd BigFastSim/Release\\
+        vim makefile  \#change CHARMPATH=\$(HOME)/charm/net-linux-x86\_64-bigemulator-bigsim/\\
+        make\\
+
+\item copy simulator to trace files' directory:\\
+        cd $\sim$/charm/tests/ampi/jacobi3d\\
+        cp $\sim$/BigFastSim/Release/seqSimulator .\\
+
+\item run the simulator with projections output: (to see other options such as changing latency and bandwidth run ``./seqSimulator -help")\\
+        ./seqSimulator -tproj\\
+
+\item download and make Projections:\\
+        git clone git://charm.cs.uiuc.edu/projections.git\\
+        cd projections\\
+        ant\\
+
+\item run Projections:\\
+        ./bin/projections64 \#open tproj.sts file\\
+
+\end{enumerate}
+
+After opeing the symbol file (file/open tproj.sts), you can use different features of Projections such as tools/Timelines.