updated.
authorGengbin Zheng <gzheng@illinois.edu>
Thu, 14 Oct 2004 06:34:55 +0000 (06:34 +0000)
committerGengbin Zheng <gzheng@illinois.edu>
Thu, 14 Oct 2004 06:34:55 +0000 (06:34 +0000)
doc/bigsim/Makefile
doc/bigsim/install.tex

index 83441bd4363291e923b85332ae950bd3623c66ae..f1609b5d5fb6560f0b86d9ca53648ffd86304377 100644 (file)
@@ -2,7 +2,7 @@
 FILE=manual
 TEX=$(FILE).tex install.tex emulator.tex
 
-DEST=bluegene
+DEST=bigsim
 LATEX2HTML=$(L2H) -split 5
 
 include ../Makefile.common
index 980b25ae8c996d8f97b8078c3ea26eec52e63f12..ec48b48ce423399d0fbeda4dc5b3bc20af28cada 100644 (file)
@@ -3,13 +3,11 @@
 
 \subsection{Installing Charm++ and BigSim}
 
-Blue Gene Simulator now is integrated into Charm++ distribution as a runtime 
-library. Unfortunately, the precompiled binary package distribution doesnot 
-contain the Blue Gene Simulator, thus you need to download source code
-and compile yourself. 
+BigSim Simulator is part of Charm++ distribution as a runtime 
+library. One needs to download Charm++ and compile BigSim simulator.
 
-You begin by downloading Charm++ from our website:
-http://charm.cs.uiuc.edu/beta.html
+You should begin with downloading Charm++ from website:
+http://charm.cs.uiuc.edu
 
 Please refer to "Charm++ Installation and Usage Manual" and also the README
 in the source code for detailed instruction on how to compile Charm++.
@@ -21,47 +19,62 @@ You need to provide target and platform options:
 
 For example, to compile on a Linux machine, type:
 \begin{verbatim}
-./build charm++ net-linux
+./build charm++ net-linux -O
 \end{verbatim}
 
-which builds essential \charmpp{} kernel using UDP as communication method, 
-alternatively, you can build Charm++ kernel on MPI:
+which builds essential \charmpp{} kernel using UDP sockets as 
+communication method, 
+alternatively, you can build Charm++ kernel on MPI like:
 \begin{verbatim}
-./build charm++ mpi-linux
+./build charm++ mpi-linux -O
 \end{verbatim}
 
 For other platforms, change net-linux to whatever platform you are compiling 
 on. See the charm/README file for a complete list of supported platforms.
 
-However, those commands donot automatically compile for Blue Gene Simulator, 
-thus in order to compile both \charmpp{} kernel and Blue Gene Simulator, 
-you need to provide a special target "bluegene" and an extra option for 
-"build" script, for example:
+\subsubsection{Compile Charm++ Emulator Only}
+
+BigSIm emulator is implemented on top of Converse in Charm++, 
+to compile BigSim emualtor only, one can compile emulator libraries
+directly on top of normal Charm++ using ``bluegene'' as the compilation
+target, like
+\begin{verbatim}
+./build bluegene net-linux -O
+\end{verbatim}
+
+With emulator libraries, one can write BigSim applications using its
+low level emulator message passing API.
+
+\subsubsection{Compile Charm++ on BigSim Emulator}
+
+In order to build Charm++ on top of BigSim Emulator (which itself is 
+implemented on top of Converse), a special build option ``bluegene''
+needs to be specified:
 \begin{verbatim}
-./build bluegene net-linux bluegene
+./build bluegene net-linux bluegene -O
 \end{verbatim}
 
-The first "bluegene" is the compilation target, it tells "build" to
-compile Blue Gene Simulator libraries as well as \charmpp{} kernel;
-The second "bluegene" is an option to platform "net-linux", which tells
-"build" to compile the Charm++ kernel itself upon Blue Gene Emulator. 
-To compile AMPI on Blue Gene, use "bgampi" as target, which subsumes target
-"bluegene":
+The first "bluegene" is the compilation target that tells "build" to
+compile BigSim emulator libraries in addition to \charmpp{} kernel;
+The second "bluegene" is a build option to platform "net-linux", which tells
+"build" to compile the Charm++ on top of BigSim Emulator. 
+To build AMPI on BigSim, use "bgampi" as make target, which subsumes target
+of "bluegene":
 \begin{verbatim}
-./build bgampi net-linux bluegene
+./build bgampi net-linux bluegene -O
 \end{verbatim}
 
 For the above "build" command, it creates a directory named 
 "net-linux-bluegene" under charm, which contains all the header files and
 libraries needed for compiling a user application.
 
-\subsection{Compiling Blue Gene Applications}
+\subsection{Compiling BigSim Applications}
 
 \charmpp{} provides a compiler script {\tt charmc} to compile all programs.
 
-There are three methods to write a Blue Gene applicaiton:
+There are three methods to write a BigSim applicaiton:
 
-\subsubsection{Writing a Blue Gene application using low level machine API}
+\subsubsection{Writing a BigSim application using low level machine API}
 The low level machine API mimics the actual machine low level programming
 API. It is defined in section~\ref{bgemulator}. Writing a program in the 
 low level machine API, you just need to link \charmpp{}'s Blue Gene emulator