source: branches/anuga_1_2_1/anuga_core/documentation/user_manual/anuga_installation_guide.tex @ 8083

Last change on this file since 8083 was 8083, checked in by habili, 13 years ago

Bug fixes, including correct use of starttime and duration.

  • Property svn:keywords set to LastChangedDate LastChangedRevision LastChangedBy HeadURL Id
File size: 11.4 KB
Line 
1\documentclass{manual}
2
3\title{ANUGA Installation Guide}
4
5\usepackage{graphicx}
6\usepackage{hyperref}
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{anuga@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               
22\input{version} % Get version info - this file may be modified by
23                % update_anuga_user_manual.py - if not a dummy
24                % will be used.
25                               
26
27\makeindex          % tell \index to actually write the .idx file
28%\makemodindex          % If this contains a lot of module sections.
29
30
31
32\begin{document}
33\maketitle
34
35
36
37% This makes the contents more accessible from the front page of the HTML.
38\ifhtml
39\chapter*{Front Matter\label{front}}
40\fi
41
42
43
44
45\chapter{Introduction}
46
47This document outlines the procedure for installing the Anuga toolbox.
48All components are licensed as open source and readily available from the net.
49It is assumed that the reader is familiar with the Python programming language
50and the process of downloading, installing and unpacking files into directories.
51
52
53\section{System requirements}
54\label{sec:requirements}
55
56To run ANUGA you will need a Windows PC (XP, Vista or 7) or a Linux PC with at
57least 512MB RAM.  As ANUGA is a memory-intensive numerical system, more memory is better than less.
58
59The viewer (Windows only) requires a graphics adapter that
60is OpenGL compatible. It has been tested with ATI, NVIDIA and Mobile Intel(R) GM45 Express chipsets.
61
62The instructions below are written for the numpy version of ANUGA. ANUGA changed from
63relying on the Numeric package to the numpy package early in July, 2009. If you have a Numeric ANUGA,
64you should refer to the installation instructions for that version. The last Numeric version of
65ANUGA had a build number of 7163.
66
67Where the text below refers to a specific package file such as \code{python-2.5.msi} you will find that
68file in a download area linked through the \emph{numpy_support_software} link on the page
69\url{https://datamining.anu.edu.au/anuga/wiki/NumpyInstall}.
70
71
72\section{Installation}
73
74Below are the install procedures for Windows XP, Windows Vista, Windows 7 (all 32 bit) and Linux (32 and 64 bit).
75
76\subsection{Quick install - Windows XP, Vista and 7 (32 bit)}
77\label{sec:winxp}
78
79If you already have previous versions of Python, ANUGA support software or the ANUGA source code installed
80on the target machine, start off by uninstalling them. Next, download the latest version of the ANUGA
81Windows installer from \url{http://sourceforge.net/projects/anuga/files/}. The Windows installer will
82install Python, MingW (select the "Minimal" install), NumPy, NetCDF, Scientific Python, Matplotlib, the
83ANUGA source code and the viewer (animate). Note that you will need an internet connection to install MingW.
84
85After all the necessary packages have been installed, the installer will proceed to compile the ANUGA C code,
86run the test suite (optional) and then run a series of validation examples (optional). This may take some time.
87Try the demonstrations provided in the ANUGA directory \code{anuga\_demos} (discussed in the ANUGA user manual at
88\url{https://datamining.anu.edu.au/anuga/attachment/wiki/WikiStart/anuga_user_manual-1.2.0.pdf})
89and view the resulting \code{.sww} files with the ANUGA viewer.
90
91
92
93%To run the ANUGA against the Okushiri Island wave tank validation dataset
94%(\url{http://www.cee.cornell.edu/longwave})
95%go to \code{anuga_validation}
96% into
97%any directory and run the scripts \code{create_okushiri.py},
98%\code{run_okushiri.py} and \code{compare_timeseries.py}.  See also the
99%\code{README.txt} file that comes with the validation scripts for more
100%details.
101
102\subsection{Quick install - Linux}
103\label{sec:linux}
104
105Please note that the following applies only to Ubuntu 10.04 and 10.10. We currently do not
106support any other Linux distributions.
107
108Open a terminal and enter:
109\begin{verbatim}
110sudo add-apt-repository ppa:anuga/ppa
111sudo apt-get update
112sudo apt-get install python-anuga
113\end{verbatim}
114
115For the Ubuntu version, you do not need to run test_all.py or compile_all.py. They have already been done for you.
116
117
118\section{Optional but recommended software}
119This software is not required to run the ANUGA toolbox, but it is recommended.
120\begin{itemize}
121  \item psyco. Speeds up ANUGA by about 30\%, so is strongly recommended.
122    Under Ubuntu install either through Synaptic or by:
123    \begin{verbatim}sudo apt-get install python-psyco\end{verbatim}
124    Under Windows install the file \code{psyco-1.6.win32-py25.exe}
125    which you can find on the \url{http://psyco.sourceforge.net/download.html} page.
126
127  \item VTK. The Visualization Toolkit. Under Ubuntu install either through Synaptic or by:
128    \begin{verbatim}sudo apt-get install python-vtk\end{verbatim}
129    Under Windows install the file \code{vtk-5.4.2-win32.exe}
130    from the \url{http://www.vtk.org/VTK/resources/software.html} page.
131\end{itemize}
132
133
134
135\section{Testing}
136
137If you install ANUGA directly from the SVN repository (not the Windows one-click installer or using apt-get install for Ubuntu),
138you should run the unit tests to verify that all the tests pass. In the ANUGA root directory, run the test suite:
139\begin{verbatim}
140python test_all.py
141\end{verbatim}
142ANUGA has been succesfully installed if the tests pass as follows:
143\begin{verbatim}
144  ...
145  test_data_manager.py
146  test_interpolate_sww.py
147  test_mesh.py
148  test_mesh_interface.py
149  test_triangmodule.py
150  test_triangmoduleII.py
151  test_advection.py
152.................................................................................
153.................................................................................
154.................................................................................
155.................................................................................
156.................................................................................
157.................................................................................
158.................................................................................
159..........................
160----------------------------------------------------------------------
161Ran 593 tests in 42.712s
162
163OK
164\end{verbatim}
165
166Note that if psycho is not installed, a number of psycho related warnings will appear. These warnings
167can be ignored.
168
169%\section{Other stuff to be included}
170%
171%\begin{verbatim}
172%Install tortoise from downloads (ITs didn't integrate wih explorer).
173%In settings set proxy to proxy.agso.gov.au  8080
174%%
175%
176%Install swollen from latest distro (in subversion)
177%
178%
179%\end{verbatim}
180
181
182\appendix
183\chapter{Miscellaneous procedures}
184\section{Setting the PATH on Windows}
185\label{sec:setwindowspath}
186
187The Windows one-click installer should automatically set the necessary PATH
188environment "System variables". However, in case you do not have
189permission to modify the system variable, then the method of setting the PATH environment "User variable"
190for Windows XP is shown here. Setting the variable for Windows Vista and 7 should be similar.
191
192\setlength\fboxsep{0pt}
193\setlength\fboxrule{1.0pt}
194
195First, open the Control Panel:
196\begin{figure}[ht]
197  \centerline{\fbox{\includegraphics[scale=0.75]{installgraphics/winsetpath1.png}}}
198%  \caption{Run Control Panel from the Start menu}
199  \label{fig:winsetpath1}
200\end{figure}
201
202Next, start the System applet:
203\begin{figure}[ht]
204  \centerline{\fbox{\includegraphics[scale=0.75]{installgraphics/winsetpath2.png}}}
205%  \caption{Start the System applet}
206  \label{fig:winsetpath2}
207\end{figure}
208
209\pagebreak
210
211Select the \code{Advanced} tab in the System Properties window:
212\begin{figure}[ht]
213  \centerline{\includegraphics[scale=0.5]{installgraphics/winsetpath3.png}}
214%  \caption{Select the Advanced tab}
215  \label{fig:winsetpath3}
216\end{figure}
217
218%\pagebreak
219
220Press the \code{Environment Variables} button in the \code{Advanced} tab:
221\begin{figure}[ht]
222  \centerline{\includegraphics[scale=0.5]{installgraphics/winsetpath4.png}}
223%  \caption{Press the Environment Variables button}
224  \label{fig:winsetpath4}
225\end{figure}
226
227\pagebreak
228
229If the \code{PATH} variable is not defined in the 'User variables' or 'System variables' windows,
230press the \code{New} button in either of the two windows (for a personal machine, choose the 'System variables' window).
231
232If \code{PATH} already exists in the 'User variable' or 'System variables' window,
233select the row with the \code{PATH} variable name in the appropriate window
234and press the \code{Edit} button next to the \code{New} button in that window:
235\begin{figure}[ht]
236  \centerline{\includegraphics[scale=0.5]{installgraphics/winsetpath5.png}}
237%  \caption{Press the New button}
238  \label{fig:winsetpath5}
239\end{figure}
240
241%\pagebreak
242
243You will be shown the editor window whichever button you pressed in the above step. If the \code{Variable name} box is empty
244type in the name \code{PATH}.  In the \code{Variable value} box type the value you want the \code{PATH} variable to have.  If there
245is already some text in the box, place your additional value at the front of the existing value, not forgetting to terminate your additional
246string with the ';' character. The final value string must be a series of directory names seperated by ';' characters:
247\begin{figure}[ht]
248  \centerline{\includegraphics[scale=0.75]{installgraphics/winsetpath6.png}}
249%  \caption{Modifying the PATH value}
250  \label{fig:winsetpath6}
251\end{figure}
252
253When you are finished, press the \code{OK} button and exit from the applet.
254
255\pagebreak
256
257\section{Associating animate.exe with a .sww file}
258\label{sec:assocanimatesww}
259
260The one-click installer should associate animate.exe with .sww files automatically. However, the method of associating
261\code{animate.exe} with a \code{.sww} file manually is shown here for Windows XP.
262A similar process should work for Windows Vista.
263
264Double left-click on any \code{.sww} file.  This brings up a dialog because Windows doesn't know how to open the file:
265\begin{figure}[ht]
266  \centerline{\fbox{\includegraphics[scale=0.5]{installgraphics/winassoc1.png}}}
267%  \caption{Try to open the .sww file}
268  \label{fig:winassoc1}
269\end{figure}
270
271Select the "\code{Select the program from a list}" radiobutton and press the \code{OK} button:
272\begin{figure}[ht]
273  \centerline{\includegraphics[scale=0.5]{installgraphics/winassoc2.png}}
274%  \caption{Select the program from a list}
275  \label{fig:winassoc2}
276\end{figure}
277
278\pagebreak
279
280Press the \code{Browse...} button to find the \code{animate.exe} program:
281\begin{figure}[ht]
282  \centerline{\includegraphics[scale=0.5]{installgraphics/winassoc3.png}}
283%  \caption{Find animate.exe program}
284  \label{fig:winassoc3}
285\end{figure}
286
287Navigate to the \code{C:$\backslash$Program Files$\backslash$anuga_viewer} directory:
288\begin{figure}[ht]
289  \centerline{\includegraphics[scale=0.5]{installgraphics/winassoc4.png}}
290%  \caption{Navigate into Program Files|anuga_viewer directory}
291  \label{fig:winassoc4}
292\end{figure}
293
294\pagebreak
295
296Select \code{animate.exe} and press the \code{Open} button:
297\begin{figure}[ht]
298  \centerline{\includegraphics[scale=0.5]{installgraphics/winassoc5.png}}
299%  \caption{Select the animate.exe program press Open}
300  \label{fig:winassoc5}
301\end{figure}
302
303Finally, press the \code{OK} button:
304\begin{figure}[ht]
305  \centerline{\includegraphics[scale=0.5]{installgraphics/winassoc6.png}}
306%  \caption{Press the OK button}
307  \label{fig:winassoc6}
308\end{figure}
309
310
311\end{document}
Note: See TracBrowser for help on using the repository browser.