/[escript]/trunk/doc/user/Installation.tex
ViewVC logotype

Diff of /trunk/doc/user/Installation.tex

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1567 by ksteube, Thu May 22 22:52:41 2008 UTC revision 1811 by ksteube, Thu Sep 25 23:11:13 2008 UTC
# Line 1  Line 1 
1    
2    %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3  %  %
4  % $Id$  % Copyright (c) 2003-2008 by University of Queensland
5  %  % Earth Systems Science Computational Center (ESSCC)
6  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%  % http://www.uq.edu.au/esscc
 %  
 %           Copyright 2003-2007 by ACceSS MNRF  
 %       Copyright 2007 by University of Queensland  
 %  
 %                http://esscc.uq.edu.au  
 %        Primary Business: Queensland, Australia  
 %  Licensed under the Open Software License version 3.0  
 %     http://www.opensource.org/licenses/osl-3.0.php  
7  %  %
8  %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%  % Primary Business: Queensland, Australia
9    % Licensed under the Open Software License version 3.0
10    % http://www.opensource.org/licenses/osl-3.0.php
11  %  %
12    %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13    
14    
15  \chapter{Installation}  \chapter{Installation}
16  \label{INSTALL}  \label{INSTALL}
# Line 31  Visit \url{http://iservo.edu.au/twiki/bi Line 29  Visit \url{http://iservo.edu.au/twiki/bi
29  \end{itemize}  \end{itemize}
30    
31  \subsection{Optional Libraries}  \subsection{Optional Libraries}
32  These libraries are optional at compile time. By default, thay are switched off.  These libraries are optional at compile time. By default, they are switched off.
33  \begin{itemize}  \begin{itemize}
34     \item parallel direct solver from the SGI SCSL library (see \url{http://www.sgi.com/products/software/scsl.html})     \item parallel direct solver from the SGI SCSL library (see \url{http://www.sgi.com/products/software/scsl.html})
35     \item parallel direct solver from Intel MKL library which is included with the Intel compilers (see \url{http://www.intel.com/cd/software/products/asmo-na/eng/perflib/mkl/}).     \item parallel direct solver from Intel MKL library which is included with the Intel compilers (see \url{http://www.intel.com/cd/software/products/asmo-na/eng/perflib/mkl/}).
# Line 90  to unpack the source files into the dire Line 88  to unpack the source files into the dire
88  The installation is started by  The installation is started by
89  \begin{verbatim}  \begin{verbatim}
90    cd <my esys dir>    cd <my esys dir>
91    scons dodebug=no    scons usedebug=no
92  \end{verbatim}  \end{verbatim}
93  By default the configuration for Linux is used. If there is a file \verb|scons/<hostname>_options.py| it will contain values to over-ride the default settings. Use =scons/ess_options.py= as a staring point to create a file for your machine. If you want to use personalized settings in a file called =myoptions.py= you can run  By default the configuration for Linux is used. If there is a file \verb|scons/<hostname>_options.py| it will contain values to over-ride the default settings. Use =scons/ess_options.py= as a staring point to create a file for your machine. If you want to use personalized settings in a file called =myoptions.py= you can run
94  \begin{verbatim}  \begin{verbatim}
95    cd <my esys dir>    cd <my esys dir>
96    scons dodebug=no options_file=myoptions.py    scons usedebug=no options_file=myoptions.py
97  \end{verbatim}  \end{verbatim}
98  You can also over-ride individual settings through the command line:  You can also over-ride individual settings through the command line:
99  \begin{verbatim}  \begin{verbatim}
100     cd <my esys dir>     cd <my esys dir>
101    scons dodebug=no libinstall=/usr/lib    scons usedebug=no libinstall=/usr/lib
102  \end{verbatim}  \end{verbatim}
103  This will install the libraries into the directory \verb|/usr/lib|.  This will install the libraries into the directory \verb|/usr/lib|.
104    
# Line 118  To uninstall the software use Line 116  To uninstall the software use
116  If you have more than one processor available for compilation you can use the -j option to tell scons to do parallel compiles:  If you have more than one processor available for compilation you can use the -j option to tell scons to do parallel compiles:
117  \begin{verbatim}  \begin{verbatim}
118     cd <my esys dir>     cd <my esys dir>
119     scons dodebug=no -j 8     scons usedebug=no -j 8
120  \end{verbatim}  \end{verbatim}
121  \section{Running Release Tests}  \section{Running Release Tests}
122  You can run the test suite of approximately 30,000 unit tests in a few hours with  You can run the test suite of approximately 30,000 unit tests in a few hours with
123  \begin{verbatim}  \begin{verbatim}
124     cd <my esys dir>     cd <my esys dir>
125     scons dodebug=no all_tests     scons usedebug=no all_tests
126  \end{verbatim}  \end{verbatim}
127    
128  \section{Environment Setup}  \section{Environment Setup}
# Line 137  export LD_LIBRARY_PATH=<my esys dir>/lib Line 135  export LD_LIBRARY_PATH=<my esys dir>/lib
135  If you build \esys with  If you build \esys with
136  \begin{verbatim}  \begin{verbatim}
137     cd <my esys dir>     cd <my esys dir>
138     scons dodebug=no prefix=/usr     scons usedebug=no prefix=/usr
139  \end{verbatim}  \end{verbatim}
140  then your libraries and python modules will be installed in system directories and you will  then your libraries and python modules will be installed in system directories and you will
141  not have to set LD_LIBRARY_PATH and PYTHONPATH (assuming python is installed in  not have to set LD_LIBRARY_PATH and PYTHONPATH (assuming python is installed in
# Line 160  python poisson.py Line 158  python poisson.py
158    
159  \subsection{MPI Support}  \subsection{MPI Support}
160    
161  If you wish to use MPI parallelization, and it has been switched on during compilation with useMPI=yes, you need to use the following commands to run scripts in parallel (in this case with four CPUs):  If you wish to use MPI parallelization, and it has been switched on during compilation with usempi=yes, you need to use the following commands to run scripts in parallel (in this case with four CPUs):
162  \begin{verbatim}  \begin{verbatim}
163  cd <my esys dir>/doc/examples  cd <my esys dir>/doc/examples
164  mpirun -np 4 <my esys dir>/lib/pythonMPI poisson.py  mpirun -np 4 <my esys dir>/lib/pythonMPI poisson.py
# Line 169  mpirun -np 4 <my esys dir>/lib/pythonMPI Line 167  mpirun -np 4 <my esys dir>/lib/pythonMPI
167  When running an MPI job the standard output of process zero goes to the screen, while the standard output of the other processes  When running an MPI job the standard output of process zero goes to the screen, while the standard output of the other processes
168  is automatically redirected to files with names like stdout_cpu_0001.out.  is automatically redirected to files with names like stdout_cpu_0001.out.
169    
170    A python script can obtain the MPI rank and size in two ways.
171    The global number of MPI processes and rank (relative to MPI_COMM_WORLD) are available through
172    \begin{verbatim}
173    iam = getMPIRankWorld()
174    nPE = getMPISizeWorld()
175    \end{verbatim}
176    
177    The rank and size relative to a particular domain object (which may be limited to run on a subset of the
178    total list of MPI processes in future versions of Escript) are available through
179    \begin{verbatim}
180    iam = domain.getMPIRankWorld()
181    nPE = domain.getMPISizeWorld()
182    \end{verbatim}
183    
184  \section{Getting Help}  \section{Getting Help}
185  Please direct any questions you might have to \url{mailto:esys@esscc.uq.edu.au}.  Please direct any questions you might have to \url{mailto:esys@esscc.uq.edu.au}.

Legend:
Removed from v.1567  
changed lines
  Added in v.1811

  ViewVC Help
Powered by ViewVC 1.1.26