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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1811 - (hide annotations)
Thu Sep 25 23:11:13 2008 UTC (10 years, 5 months ago) by ksteube
File MIME type: application/x-tex
File size: 6632 byte(s)
Copyright updated in all files

1 ksteube 1811
2     %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 ksteube 1316 %
4 ksteube 1811 % Copyright (c) 2003-2008 by University of Queensland
5     % Earth Systems Science Computational Center (ESSCC)
6     % http://www.uq.edu.au/esscc
7 gross 625 %
8 ksteube 1811 % 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 gross 625 %
12 ksteube 1811 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13 ksteube 1316
14 ksteube 1811
15 gross 565 \chapter{Installation}
16     \label{INSTALL}
17 jgs 82
18 gross 723 Visit \url{http://iservo.edu.au/twiki/bin/view/ESSCC/EsysUser} for more information.
19 jgs 82
20 ksteube 1318 \section{Software Needed for Installation}
21 jgs 102
22 gross 723 \begin{itemize}
23 ksteube 1318 \item scons 0.96.91 or newer (see \url{http://www.scons.org/})
24     \item python 2.3.4 or higher (see \url{http://www.python.org/})
25     \item numarray 0.9 or higher (see \url{http://www.stsci.edu/resources/software_hardware/numarray})
26     \item python boost boost 1.31.0 or higher (see \url{http://www.boost.org/})
27 ksteube 1316 \item g++ (see \url{http://gcc.gnu.org/}) or Intel c++ compiler (see \\
28     \url{http://www.intel.com/cd/software/products/asmo-na/eng/compilers/}).
29 gross 723 \end{itemize}
30 gross 707
31 ksteube 1318 \subsection{Optional Libraries}
32 lgraham 1700 These libraries are optional at compile time. By default, they are switched off.
33 gross 723 \begin{itemize}
34 ksteube 1316 \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/}).
36 gross 723 \end{itemize}
37 gross 707
38 ksteube 1318 \subsection{Optional Software}
39 gross 723
40 jgs 107 \begin{itemize}
41 ksteube 1316 \item visualization with our pyvisi interface to VTK:
42     \item vtk 4.2.1 or newer with with python interface (see \url{http://public.kitware.com/VTK/}).
43     \item Alternatives for off-line visualization:
44 gross 723 \begin{itemize}
45 ksteube 1316 \item mayavi (see \url{http://mayavi.sourceforge.net/}).
46     \item opendx (see \url{http://www.opendx.org/}).
47 gross 723 \end{itemize}
48 ksteube 1316 \item Alternatives for on-line visualization:
49 gross 723 \begin{itemize}
50 ksteube 1316 \item gnuplot with with python interface (see \url{http://www.gnuplot.info/}).
51     \item povray (see \url{http://www.povray.org/}).
52 jgs 107 \end{itemize}
53 gross 723 \end{itemize}
54 gross 565
55 ksteube 1318 \section{Get the Source Code}
56 gross 723
57 ksteube 1316 You can download the complete source code, examples and release tests from \url{https://shake200.esscc.uq.edu.au/twiki/bin/view/ESSCC/EsysUser}.
58 gross 723 Files can be downloaded as *.zip or *.tar.gz files.
59 ksteube 1318 This software is distributed under the Open Software License version 3.0 (see \url{http://www.opensource.org/licenses/osl-3.0.php}).
60 gross 723
61 ksteube 1318 \subsection{Unpack zip File}
62 gross 723 Use the commands
63    
64     \begin{verbatim}
65 ksteube 1316 mkdir <my esys dir>
66     mv escript*.zip <my esys dir>
67 gross 723 cd <my esys dir>
68     unzip escript*.zip
69     \end{verbatim}
70    
71     to unzip the source files into the directory \verb|<my esys dir>|.
72    
73 ksteube 1318 \subsection{Unpack tar File}
74 gross 723
75     Use the commands
76    
77     \begin{verbatim}
78     mkdir <my esys dir>
79 ksteube 1316 mv escript*.tar.gz <my esys dir>
80 gross 723 cd <my esys dir>
81     tar xzf escript*.tar.gz
82     \end{verbatim}
83    
84     to unpack the source files into the directory \verb|<my esys dir>|.
85    
86 gross 565 \section{Installation}
87 gross 723
88     The installation is started by
89     \begin{verbatim}
90     cd <my esys dir>
91 ksteube 1705 scons usedebug=no
92 gross 723 \end{verbatim}
93 ksteube 1316 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 gross 723 \begin{verbatim}
95     cd <my esys dir>
96 ksteube 1705 scons usedebug=no options_file=myoptions.py
97 gross 723 \end{verbatim}
98 ksteube 1318 You can also over-ride individual settings through the command line:
99 gross 723 \begin{verbatim}
100     cd <my esys dir>
101 ksteube 1705 scons usedebug=no libinstall=/usr/lib
102 gross 723 \end{verbatim}
103 ksteube 1318 This will install the libraries into the directory \verb|/usr/lib|.
104 gross 723
105 ksteube 1316 Help on options is available with:
106 gross 723 \begin{verbatim}
107     cd <my esys dir>
108     scons -h
109     \end{verbatim}
110 ksteube 1316 To uninstall the software use
111 gross 723 \begin{verbatim}
112     cd <my esys dir>
113     scons -c
114     \end{verbatim}
115    
116     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}
118     cd <my esys dir>
119 ksteube 1705 scons usedebug=no -j 8
120 gross 723 \end{verbatim}
121     \section{Running Release Tests}
122 ksteube 1316 You can run the test suite of approximately 30,000 unit tests in a few hours with
123 gross 723 \begin{verbatim}
124     cd <my esys dir>
125 ksteube 1705 scons usedebug=no all_tests
126 gross 723 \end{verbatim}
127    
128 ksteube 1318 \section{Environment Setup}
129 gross 723 To make esys accessible from python you have to set
130     \begin{verbatim}
131     export PYTHONPATH=<my esys dir>:${PYTHONPATH}
132     export LD_LIBRARY_PATH=<my esys dir>/lib:${LD_LIBRARY_PATH}
133     \end{verbatim}
134    
135 ksteube 1316 If you build \esys with
136 gross 723 \begin{verbatim}
137 ksteube 1316 cd <my esys dir>
138 ksteube 1705 scons usedebug=no prefix=/usr
139 ksteube 1316 \end{verbatim}
140     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
142     /usr/lib/python/site-modules).
143    
144     Now you are ready to test your setup by running one of the supplied examples
145     \begin{verbatim}
146 gross 723 cd <my esys dir>/doc/examples
147     python poisson.py
148     \end{verbatim}
149    
150 ksteube 1318 \subsection{OpenMP Support}
151 gross 723
152 ksteube 1316 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):
153 gross 723 \begin{verbatim}
154     export OMP_NUM_THREADS=4
155     cd <my esys dir>/doc/examples
156     python poisson.py
157     \end{verbatim}
158    
159 ksteube 1318 \subsection{MPI Support}
160    
161 ksteube 1705 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 ksteube 1316 \begin{verbatim}
163     cd <my esys dir>/doc/examples
164     mpirun -np 4 <my esys dir>/lib/pythonMPI poisson.py
165     \end{verbatim}
166    
167 ksteube 1567 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.
169    
170 ksteube 1805 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 ksteube 1318 \section{Getting Help}
185 ksteube 1316 Please direct any questions you might have to \url{mailto:esys@esscc.uq.edu.au}.

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

  ViewVC Help
Powered by ViewVC 1.1.26