source: anuga_core/documentation/user_manual/anuga_installation_guide.tex @ 3921

Last change on this file since 3921 was 3921, checked in by ole, 16 years ago

Updated installation guide

  • Property svn:keywords set to LastChangedDate LastChangedRevision LastChangedBy HeadURL Id
File size: 8.4 KB
Line 
1\documentclass{manual}
2
3
4\title{ANUGA Installation Guide}
5
6\author{Howard Silcock, Ole Nielsen, Duncan Gray, Jane Sexton}
7
8% Please at least include a long-lived email address;
9% the rest is at your discretion.
10\authoraddress{Geoscience Australia \\
11  Email: \email{ole.nielsen@ga.gov.au}
12}
13
14%Draft date
15\date{\today}                   % update before release!
16                % Use an explicit date so that reformatting
17                % doesn't cause a new date to be used.  Setting
18                % the date to \today can be used during draft
19                % stages to make it easier to handle versions.
20
21\release{1.0}           % release version; this is used to define the
22                % \version macro
23
24\makeindex          % tell \index to actually write the .idx file
25%\makemodindex          % If this contains a lot of module sections.
26
27
28
29\begin{document}
30\maketitle
31
32
33
34% This makes the contents more accessible from the front page of the HTML.
35\ifhtml
36\chapter*{Front Matter\label{front}}
37\fi
38
39
40
41
42\chapter{Introduction}
43
44This document outlines the required software for installing the Anuga toolbox.
45All components are licensed as open source and readily available from the net.
46
47
48\section{Quick install (Windows only)}
49
50This section provides the quickest path to getting ANUGA up and running on a Windows machine.
51For Linux and for more details please refer to Section \ref{sec:prerequisites}.
52
53\begin{enumerate} 
54 
55  \item Install Python pre-requisites: The Enthought version of Python2.4, Scientific Python
56  and the NetCDF library\footnote{Separate installation of Scientific Python and NetCDF
57  will become unneccesary once Enthought sorts out netcdf support
58  (see \url{https://svn.enthought.com/enthought/ticket/917})}. These are available from either
59  \begin{itemize} 
60    \item The supplied ANUGA distribution as under the folder pre_requisites
61    \item The WEB:
62    \begin{itemize} 
63      \item Enthought version of Python2.4: \url{http://code.enthought.com/enthon/}.
64      \item Scientific Python: \url{http://sourcesup.cru.fr/frs/download.php/745/ScientificPython-2.4.9.win32-py2.4.exe}
65      \item NETCDF \url{ftp://ftp.unidata.ucar.edu/pub/netcdf/contrib/win32/netcdf-3.6.1-beta1-win32dll.zip}
66    \end{itemize}   
67  \end{itemize}   
68 
69  \item Add the following to the PATH environment variable
70    \begin{verbatim}
71      PATH=C:\Python24;C:\Python24\Enthought\MingW\bin;C:\Program Files\anuga_viewer
72    \end{verbatim} 
73  \item Unpack the ANUGA source code (\code{anuga-1.0_xxxx.tgz})
74  in the python site-packages
75  directory \code{C:\\Python24\\Lib\\site-packages}
76  \item In the ANUGA root directory (\code{C:\\Python24\\Lib\\site-packages\\anuga}),
77  run the compilation script (either from the commandline or by clicking on it):
78    {\small \begin{verbatim}
79        python compile_all.py
80    \end{verbatim}}
81  \item In the ANUGA root directory, run the test suite:
82    {\small \begin{verbatim}
83        python test_all.py
84    \end{verbatim}}
85    ANUGA has been succesfully installed if the tests pass.
86\end{enumerate}   
87
88To install the anuga\_viewer
89\begin{enumerate} 
90  \item Unpack the distribution (\code{anuga_viewer_1.0.tgz}) in
91    \begin{verbatim} 
92      C:\Program Files
93    \end{verbatim}
94  \item Associate .sww files with the executable
95  \begin{verbatim} 
96    C:\Program Files\anuga_viewer\animate.exe
97  \end{verbatim}       
98  \item Double click on the test file
99    \begin{verbatim} 
100      C:\Program Files\anuga_viewer\cylinders.sww
101    \end{verbatim}       
102\end{enumerate} 
103
104Try the demos provided in the ANUGA root directory
105(also discussed in the ANUGA user manual available with the distribution and also at
106\url{http://datamining.anu.edu.au/~ole/anuga/user_manual/anuga_user_manual.pdf}) and
107view the resulting sww files with the anuga\_viewer.
108
109To verify that the installed version of ANUGA validates satisfactorily
110against the Okushiri Island wave tank validation dataset
111(\url{http://www.cee.cornell.edu/longwave/index.cfm?page=benchmark&problem=2})
112unpack the distribution (\code{anuga_validation_1.0_xxxx.tgz}) into
113any directory and run the scripts \code{create_okushiri.py},
114\code{run_okushiri.py} and \code{compare_timeseries.py}.  See also the
115\code{README.txt} file that comes with the validation scripts for more
116details.
117
118
119
120\clearpage
121\section{Pre-requisites}
122\label{sec:prerequisites}
123
124This and the following sections is for custom installations and installations using Linux.
125
126The ANUGA software core (shallow\_water, pmesh, least\_squares, ...) depends on the following:
127
128
129\begin{itemize}
130  \item python 2.3 or later \url{http://www.python.org}/footnote{Note, the
131  dll python2X.dll is needed to compile ANUGA, but is not always
132  automatically added for versions 2.4 and above.  Install it into the
133  python2X directory, if you need it.}
134  \item python-numeric for Linux.  It's called Numeric in Windows. 
135  %\item python-dev (Interestingly, numeric seems to be installed as
136  %well) for Linux.  This is not necessary for Windows.
137  \item python-scientific (to provide python-netcdf) for Linux.  It's
138    called ScientificPython in Windows.
139  \item NETCDF.  Extract the file netcdf.dll, and put in C://Windows//System32// (Windows XP) or C://WINNT//System32 (Windows NT or 2000).     
140  \item A C compiler such as gcc (from GNU in case of Linux and MinGW
141  in case of Windows)
142  %\item scons for automatically compiling the distribution.
143\end{itemize}
144
145Note: All of these can be installed in one go on Windows platforms by using the Enthought Python
146distribution available at \url{http://code.enthought.com/enthon/}.
147
148\section{Recommended software}
149
150\begin{itemize}
151  \item psyco \url{http://psyco.sourceforge.net/index.html}
152  %\item visual python \url{http://vpython.org}
153  \item matplotlib (pylab) for quality 2d plotting (moving towards mandatory requirement)
154  \item VTK \url{http://mayavi.sourceforge.net/dwnld/vtk/win32/}
155\end{itemize}
156
157
158
159\section{System configuration}
160
161
162The system path on Win32 architectures must contain the directories (this examples assumes the
163Enthought Python 2.4 distribution has been installed. Path names may vary depending on the
164exact configuration).
165\begin{verbatim}
166  PATH=C:\Python24;C:\Python24\Enthought\MingW\bin;C:\Program Files\anuga_viewer
167\end{verbatim}
168The path should be analoguous for Unix operating systems.
169
170If anuga is not installed in the python site-packages directory the root directory for all
171anuga/inundation modules must be on the pythonpath, e.g.\
172\begin{verbatim}
173PYTHONPATH=C:\anuga_core\source
174\end{verbatim}
175
176
177
178
179
180\section{Installation of source zip file}
181Get a source zip file, for example, anuga_source_3807.zip, and expand
182it in the python site-packages directory (\code{C:\\Python24\\Lib\\site-packages})
183
184In the ANUGA root directory (\code{C:\\Python24\\Lib\\site-packages\\anuga}),
185run the compilation script:
186{\small \begin{verbatim}
187  python compile_all.py
188\end{verbatim}}
189
190%or (in anuga_core)
191% scons install
192% scons -c #(clean)
193
194
195\subsection{Testing}
196
197In the ANUGA root directory, run the test suite:
198{\small \begin{verbatim}
199  python test_all.py
200\end{verbatim}}
201ANUGA has been succesfully installed if the tests pass as follows:
202
203{\tiny
204\begin{verbatim}
205  ...
206  test_data_manager.py
207  test_interpolate_sww.py
208  test_mesh.py
209  test_mesh_interface.py
210  test_triangmodule.py
211  test_triangmoduleII.py
212  test_advection.py
213............................................................................................................................................
214............................................................................................................................................
215............................................................................................................................................
216............................................................................................................................................
217.................................
218----------------------------------------------------------------------
219Ran 593 tests in 42.712s
220
221OK
222\end{verbatim} }
223
224
225
226%\section{Other stuff to be included}
227%
228%\begin{verbatim}
229%Install tortoise from downloads (ITs didn't integrate wih explorer).
230%In settings set proxy to proxy.agso.gov.au  8080
231%%
232%
233%Install swollen from latest distro (in subversion)
234%
235%
236%\end{verbatim}
237
238
239
240
241
242\end{document}
Note: See TracBrowser for help on using the repository browser.