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

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

Added blurb about netcdf

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