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

Last change on this file since 3894 was 3894, checked in by ole, 17 years ago

Added comment about where to get netcdf.dll

  • Property svn:keywords set to LastChangedDate LastChangedRevision LastChangedBy HeadURL Id
File size: 7.0 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  \item Download and install the Enthought version of Python2.4 from \url{http://code.enthought.com/enthon/}.
55 
56 
57  %NETCDF ftp://ftp.unidata.ucar.edu/pub/netcdf/contrib/win32/netcdf-3.6.1-beta1-win32dll.zip
58 
59  \item Add the following to the PATH environment variable
60    \begin{verbatim}
61      PATH=C:\Python24;C:\Python24\Enthought\MingW\bin;C:\Program Files\anuga_viewer
62    \end{verbatim} 
63  \item Unpack the ANUGA source code (anuga.tgz) in the python site-packages
64  directory (C:\Python24\Lib\site-packages)
65  \item In the ANUGA root directory (C:\Python24\Lib\site-packages\anuga), run the compilation script:
66    {\small \begin{verbatim}
67        python compile_all.py
68    \end{verbatim}}
69  \item In the ANUGA root directory, run the test suite:
70    {\small \begin{verbatim}
71        python test_all.py
72    \end{verbatim}}
73    ANUGA has been succesfully installed if the tests pass.
74\end{enumerate}   
75
76To install the anuga\_viewer
77\begin{enumerate} 
78  \item Unpack the distribution () in
79    \begin{verbatim} 
80      C:\Program Files\anuga_viewer
81    \end{verbatim}
82  \item Associate .sww files with the executable
83  \begin{verbatim} 
84    C:\Program Files\anuga_viewer\animate.exe
85  \end{verbatim}       
86  \item Double click on the test file
87    \begin{verbatim} 
88      C:\Program Files\anuga_viewer\cylinders.sww
89    \end{verbatim}       
90\end{enumerate} 
91
92Try the demos provided in the ANUGA root directory (also discussed in the ANUGA user manual
93\url{http://datamining.anu.edu.au/~ole/anuga/user_manual/anuga_user_manual.pdf}) and
94view the resulting sww files with the anuga\_viewer.
95
96
97
98\section{Pre-requisites}
99\label{sec:prerequisites}
100
101The Anuga software core (shallow\_water, pmesh, least\_squares, ...) depends on the following:
102
103
104\begin{itemize}
105  \item python 2.3 or later \url{http://www.python.org}/footnote{Note, the
106  dll python2X.dll is needed to compile ANUGA, but is not always
107  automatically added for versions 2.4 and above.  Install it into the
108  python2X directory, if you need it.}
109  \item python-numeric for Linux.  It's called Numeric in Windows. 
110  %\item python-dev (Interestingly, numeric seems to be installed as
111  %well) for Linux.  This is not necessary for Windows.
112  \item python-scientific (to provide python-netcdf) for Linux.  It's
113    called ScientificPython in Windows.
114  \item NETCDF.  Extract the file netcdf.dll, and put in C://Windows//System32// (Windows XP) or C://WINNT//System32 (Windows NT or 2000).     
115  \item A C compiler such as gcc (from GNU in case of Linux and MinGW
116  in case of Windows)
117  %\item scons for automatically compiling the distribution.
118\end{itemize}
119
120Note: All of these can be installed in one go on Windows platforms by using the Enthought Python
121distribution available at \url{http://code.enthought.com/enthon/}.
122
123\section{Recommended software}
124
125\begin{itemize}
126  \item psyco \url{http://psyco.sourceforge.net/index.html}
127  %\item visual python \url{http://vpython.org}
128  \item matplotlib (pylab) for quality 2d plotting (moving towards mandatory requirement)
129  \item VTK \url{http://mayavi.sourceforge.net/dwnld/vtk/win32/}
130\end{itemize}
131
132
133
134\section{System configuration}
135
136
137The system path on Win32 architectures must contain the directories (this examples assumes the
138Enthought Python 2.4 distribution has been installed. Path names may vary depending on the
139exact configuration).
140\begin{verbatim}
141  PATH=C:\Python24;C:\Python24\Enthought\MingW\bin;C:\Program Files\anuga_viewer
142\end{verbatim}
143The path should be analoguous for Unix operating systems.
144
145If anuga is not installed in the python site-packages directory the root directory for all
146anuga/inundation modules must be on the pythonpath, e.g.\
147\begin{verbatim}
148PYTHONPATH=C:\anuga_core\source
149\end{verbatim}
150
151
152
153
154
155\section{Installation of source zip file}
156Get a source zip file, for example, anuga_source_3807.zip, and expand
157it in the python site-packages directory (C:\Python24\Lib\site-packages)
158
159In the ANUGA root directory (C:\Python24\Lib\site-packages\anuga), run the compilation script:
160{\small \begin{verbatim}
161  python compile_all.py
162\end{verbatim}}
163
164%or (in anuga_core)
165% scons install
166% scons -c #(clean)
167
168
169\subsection{Testing}
170
171In the ANUGA root directory, run the test suite:
172{\small \begin{verbatim}
173  python test_all.py
174\end{verbatim}}
175ANUGA has been succesfully installed if the tests pass as follows:
176
177{\tiny
178\begin{verbatim}
179  ...
180  test_data_manager.py
181  test_interpolate_sww.py
182  test_mesh.py
183  test_mesh_interface.py
184  test_triangmodule.py
185  test_triangmoduleII.py
186  test_advection.py
187............................................................................................................................................
188............................................................................................................................................
189............................................................................................................................................
190............................................................................................................................................
191.................................
192----------------------------------------------------------------------
193Ran 593 tests in 42.712s
194
195OK
196\end{verbatim} }
197
198
199
200%\section{Other stuff to be included}
201%
202%\begin{verbatim}
203%Install tortoise from downloads (ITs didn't integrate wih explorer).
204%In settings set proxy to proxy.agso.gov.au  8080
205%%
206%
207%Install swollen from latest distro (in subversion)
208%
209%
210%\end{verbatim}
211
212
213
214
215
216\end{document}
Note: See TracBrowser for help on using the repository browser.