/[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 1317 by ksteube, Tue Sep 25 03:18:30 2007 UTC revision 1318 by ksteube, Wed Sep 26 04:39:14 2007 UTC
# Line 19  Line 19 
19    
20  Visit \url{http://iservo.edu.au/twiki/bin/view/ESSCC/EsysUser} for more information.  Visit \url{http://iservo.edu.au/twiki/bin/view/ESSCC/EsysUser} for more information.
21    
22  \section{Software needed for installation}  \section{Software Needed for Installation}
23    
24  \begin{itemize}  \begin{itemize}
25     \item scons  0.96.91 or newer (see \url{http://www.scons.org/}     \item scons  0.96.91 or newer (see \url{http://www.scons.org/})
26     \item python  2.3.4 or higher (see \url{http://www.python.org/}     \item python  2.3.4 or higher (see \url{http://www.python.org/})
27     \item numarray  0.9 or higher (see \url{http://www.stsci.edu/resources/software_hardware/numarray}     \item numarray  0.9 or higher (see \url{http://www.stsci.edu/resources/software_hardware/numarray})
28     \item python boost boost  1.31.0 or higher (build system defaults to boost 1.33.0) (see \url{http://www.boost.org/}     \item python boost boost  1.31.0 or higher (see \url{http://www.boost.org/})
29     \item g++ (see \url{http://gcc.gnu.org/}) or Intel c++  compiler (see \\     \item g++ (see \url{http://gcc.gnu.org/}) or Intel c++  compiler (see \\
30  \url{http://www.intel.com/cd/software/products/asmo-na/eng/compilers/}).  \url{http://www.intel.com/cd/software/products/asmo-na/eng/compilers/}).
31  \end{itemize}  \end{itemize}
32    
33  \subsection{optional Libraries}  \subsection{Optional Libraries}
34  These libraries are optional at compile time. By default, thay are switched off.  These libraries are optional at compile time. By default, thay are switched off.
35  \begin{itemize}  \begin{itemize}
36     \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})
37     \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/}).
38  \end{itemize}  \end{itemize}
39    
40  \subsection{optional Software}  \subsection{Optional Software}
41    
42  \begin{itemize}  \begin{itemize}
43     \item visualization with our pyvisi interface to VTK:     \item visualization with our pyvisi interface to VTK:
# Line 54  These libraries are optional at compile Line 54  These libraries are optional at compile
54  \end{itemize}  \end{itemize}
55  \end{itemize}  \end{itemize}
56    
57  \section{Get the source code}  \section{Get the Source Code}
58    
59  You can download the complete source code, examples and release tests from \url{https://shake200.esscc.uq.edu.au/twiki/bin/view/ESSCC/EsysUser}.  You can download the complete source code, examples and release tests from \url{https://shake200.esscc.uq.edu.au/twiki/bin/view/ESSCC/EsysUser}.
60  Files can be downloaded as *.zip or *.tar.gz files.  Files can be downloaded as *.zip or *.tar.gz files.
61  This software is distributed under the Open Software License version 3.0 (see \url{http://www.opensource.org/licenses/osl-3.0.php}.  This software is distributed under the Open Software License version 3.0 (see \url{http://www.opensource.org/licenses/osl-3.0.php}).
62    
63  \subsection{Unpack zip file}  \subsection{Unpack zip File}
64  Use the commands  Use the commands
65    
66  \begin{verbatim}  \begin{verbatim}
# Line 72  Use the commands Line 72  Use the commands
72    
73  to unzip the source files into the directory  \verb|<my esys dir>|.  to unzip the source files into the directory  \verb|<my esys dir>|.
74    
75  \subsection{Unpack tar file}  \subsection{Unpack tar File}
76        
77  Use the commands  Use the commands
78    
# Line 97  By default the configuration for Linux i Line 97  By default the configuration for Linux i
97    cd <my esys dir>    cd <my esys dir>
98    scons dodebug=no options_file=myoptions.py    scons dodebug=no options_file=myoptions.py
99  \end{verbatim}  \end{verbatim}
100  You can also over-ride individual setting through the command line:  You can also over-ride individual settings through the command line:
101  \begin{verbatim}  \begin{verbatim}
102     cd <my esys dir>     cd <my esys dir>
103    scons dodebug=no libinstall=/usr/lib    scons dodebug=no libinstall=/usr/lib
104  \end{verbatim}  \end{verbatim}
105  will install the libraries into the directory \verb|/usr/lib|.  This will install the libraries into the directory \verb|/usr/lib|.
106    
107  Help on options is available with:  Help on options is available with:
108  \begin{verbatim}  \begin{verbatim}
# Line 127  You can run the test suite of approximat Line 127  You can run the test suite of approximat
127     scons dodebug=no all_tests     scons dodebug=no all_tests
128  \end{verbatim}  \end{verbatim}
129    
130  \section{Environment setup}  \section{Environment Setup}
131  To make esys accessible from python you have to set  To make esys accessible from python you have to set
132  \begin{verbatim}  \begin{verbatim}
133  export PYTHONPATH=<my esys dir>:${PYTHONPATH}  export PYTHONPATH=<my esys dir>:${PYTHONPATH}
# Line 149  cd <my esys dir>/doc/examples Line 149  cd <my esys dir>/doc/examples
149  python poisson.py  python poisson.py
150  \end{verbatim}  \end{verbatim}
151    
152  \subsection{OpenMP support}  \subsection{OpenMP Support}
153    
154  If your system and compiler support OpenMP parallelization and OpenMP parallelization has been switched on during compilation you need to set the following environment variable to run scripts in parallel (in this case with four threads):  If your system and compiler support OpenMP parallelization and OpenMP parallelization has been switched on during compilation you need to set the following environment variable to run scripts in parallel (in this case with four threads):
155  \begin{verbatim}  \begin{verbatim}
# Line 158  cd <my esys dir>/doc/examples Line 158  cd <my esys dir>/doc/examples
158  python poisson.py  python poisson.py
159  \end{verbatim}  \end{verbatim}
160    
161  If you with to use MPI parallelization, which 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):  \subsection{MPI Support}
162    
163    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):
164  \begin{verbatim}  \begin{verbatim}
165  cd <my esys dir>/doc/examples  cd <my esys dir>/doc/examples
166  mpirun -np 4 <my esys dir>/lib/pythonMPI poisson.py  mpirun -np 4 <my esys dir>/lib/pythonMPI poisson.py
167  \end{verbatim}  \end{verbatim}
168    
169  \section{Getting help}  \section{Getting Help}
170  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.1317  
changed lines
  Added in v.1318
  ViewVC Help
Powered by ViewVC 1.1.26