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