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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1316 - (hide annotations)
Tue Sep 25 03:18:30 2007 UTC (11 years, 6 months ago) by ksteube
File MIME type: application/x-tex
File size: 5928 byte(s)
Quickly edited chapters 1 and 2 of the User Guide, but it needs more work.
Ran entire document through spell checker.

1 ksteube 1316 %
2 gross 625 % $Id$
3     %
4 ksteube 1316 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5 gross 625 %
6 ksteube 1316 % Copyright 2003-2007 by ACceSS MNRF
7     % Copyright 2007 by University of Queensland
8     %
9     % http://esscc.uq.edu.au
10     % Primary Business: Queensland, Australia
11     % Licensed under the Open Software License version 3.0
12     % http://www.opensource.org/licenses/osl-3.0.php
13     %
14     %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
15     %
16    
17 gross 565 \chapter{Installation}
18     \label{INSTALL}
19 jgs 82
20 gross 723 Visit \url{http://iservo.edu.au/twiki/bin/view/ESSCC/EsysUser} for more information.
21 jgs 82
22 gross 723 \section{Software needed for installation}
23 jgs 102
24 gross 723 \begin{itemize}
25 ksteube 1316 \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/}
27     \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/}
29     \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/}).
31 gross 723 \end{itemize}
32 gross 707
33 gross 723 \subsection{optional Libraries}
34     These libraries are optional at compile time. By default, thay are switched off.
35     \begin{itemize}
36 ksteube 1316 \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/}).
38 gross 723 \end{itemize}
39 gross 707
40 gross 723 \subsection{optional Software}
41    
42 jgs 107 \begin{itemize}
43 ksteube 1316 \item visualization with our pyvisi interface to VTK:
44     \item vtk 4.2.1 or newer with with python interface (see \url{http://public.kitware.com/VTK/}).
45     \item Alternatives for off-line visualization:
46 gross 723 \begin{itemize}
47 ksteube 1316 \item mayavi (see \url{http://mayavi.sourceforge.net/}).
48     \item opendx (see \url{http://www.opendx.org/}).
49 gross 723 \end{itemize}
50 ksteube 1316 \item Alternatives for on-line visualization:
51 gross 723 \begin{itemize}
52 ksteube 1316 \item gnuplot with with python interface (see \url{http://www.gnuplot.info/}).
53     \item povray (see \url{http://www.povray.org/}).
54 jgs 107 \end{itemize}
55 gross 723 \end{itemize}
56 gross 565
57 gross 723 \section{Get the source code}
58    
59 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}.
60 gross 723 Files can be downloaded as *.zip or *.tar.gz files.
61 ksteube 1316 This software is distributed under the Open Software License version 3.0 (see \url{http://www.opensource.org/licenses/osl-3.0.php}.
62 gross 723
63     \subsection{Unpack zip file}
64     Use the commands
65    
66     \begin{verbatim}
67 ksteube 1316 mkdir <my esys dir>
68     mv escript*.zip <my esys dir>
69 gross 723 cd <my esys dir>
70     unzip escript*.zip
71     \end{verbatim}
72    
73     to unzip the source files into the directory \verb|<my esys dir>|.
74    
75     \subsection{Unpack tar file}
76    
77     Use the commands
78    
79     \begin{verbatim}
80     mkdir <my esys dir>
81 ksteube 1316 mv escript*.tar.gz <my esys dir>
82 gross 723 cd <my esys dir>
83     tar xzf escript*.tar.gz
84     \end{verbatim}
85    
86     to unpack the source files into the directory \verb|<my esys dir>|.
87    
88 gross 565 \section{Installation}
89 gross 723
90     The installation is started by
91     \begin{verbatim}
92     cd <my esys dir>
93     scons dodebug=no
94     \end{verbatim}
95 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
96 gross 723 \begin{verbatim}
97     cd <my esys dir>
98     scons dodebug=no options_file=myoptions.py
99     \end{verbatim}
100 ksteube 1316 You can also over-ride individual setting through the command line:
101 gross 723 \begin{verbatim}
102     cd <my esys dir>
103     scons dodebug=no libinstall=/usr/lib
104     \end{verbatim}
105     will install the libraries into the directory \verb|/usr/lib|.
106    
107 ksteube 1316 Help on options is available with:
108 gross 723 \begin{verbatim}
109     cd <my esys dir>
110     scons -h
111     \end{verbatim}
112 ksteube 1316 To uninstall the software use
113 gross 723 \begin{verbatim}
114     cd <my esys dir>
115     scons -c
116     \end{verbatim}
117    
118     If you have more than one processor available for compilation you can use the -j option to tell scons to do parallel compiles:
119     \begin{verbatim}
120     cd <my esys dir>
121     scons dodebug=no -j 8
122     \end{verbatim}
123     \section{Running Release Tests}
124 ksteube 1316 You can run the test suite of approximately 30,000 unit tests in a few hours with
125 gross 723 \begin{verbatim}
126     cd <my esys dir>
127     scons dodebug=no all_tests
128     \end{verbatim}
129    
130     \section{Environment setup}
131     To make esys accessible from python you have to set
132     \begin{verbatim}
133     export PYTHONPATH=<my esys dir>:${PYTHONPATH}
134     export LD_LIBRARY_PATH=<my esys dir>/lib:${LD_LIBRARY_PATH}
135     \end{verbatim}
136    
137 ksteube 1316 If you build \esys with
138 gross 723 \begin{verbatim}
139 ksteube 1316 cd <my esys dir>
140     scons dodebug=no prefix=/usr
141     \end{verbatim}
142     then your libraries and python modules will be installed in system directories and you will
143     not have to set LD_LIBRARY_PATH and PYTHONPATH (assuming python is installed in
144     /usr/lib/python/site-modules).
145    
146     Now you are ready to test your setup by running one of the supplied examples
147     \begin{verbatim}
148 gross 723 cd <my esys dir>/doc/examples
149     python poisson.py
150     \end{verbatim}
151    
152     \subsection{OpenMP support}
153    
154 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):
155 gross 723 \begin{verbatim}
156     export OMP_NUM_THREADS=4
157     cd <my esys dir>/doc/examples
158     python poisson.py
159     \end{verbatim}
160    
161 ksteube 1316 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):
162     \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 gross 723 \section{Getting help}
168 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