source: documentation/user_manual/anuga_installation_guide.tex @ 3563

\documentclass{manual}


\title{ANUGA Installation Guide}

\author{Howard Silcock, Ole Nielsen, Duncan Gray, Jane Sexton}

% Please at least include a long-lived email address;
% the rest is at your discretion.
\authoraddress{Geoscience Australia \\
  Email: \email{ole.nielsen@ga.gov.au}
}

%Draft date
\date{\today}                   % update before release!
                % Use an explicit date so that reformatting
                % doesn't cause a new date to be used.  Setting
                % the date to \today can be used during draft
                % stages to make it easier to handle versions.

\release{1.0}           % release version; this is used to define the
                % \version macro

\makeindex          % tell \index to actually write the .idx file
%\makemodindex          % If this contains a lot of module sections.



\begin{document}
\maketitle



% This makes the contents more accessible from the front page of the HTML.
\ifhtml
\chapter*{Front Matter\label{front}}
\fi




\chapter{Introduction}

This document outlines the required software for installing the Anuga toolbox.
All components are licensed as open source and readily available from the net.


\section{Pre-requisites}

The Anuga software core (pyvolution, pmesh, least\_squares, ...) depends on the following:

\begin{itemize}
  \item python 2.3 or later \url{http://www.python.org}
  \item python-numeric for Linux.  It's called Numeric in Windows.  
  \item python-dev (Interestingly, numeric seems to be installed as
  well) for Linux.  This is not necessary for Windows.
  \item python-scientific (to provide python-netcdf) for Linux.  It's
    called ScientificPython in Windows.
  \item NETCDF.  Extract the file netcdf.dll, and put in C://Windows//System32// (Windows XP) or C://WINNT//System32 (Windows NT or 2000). 

  \item A C compiler such as gcc (from GNU in case of Linux and MinGW
  in case of Windows)
  \item scons for automatically compiling the distribution.
\end{itemize}


\section{Recommended software}

\begin{itemize}
  \item psyco \url{http://psyco.sourceforge.net/index.html}
  \item visual python \url{http://vpython.org}
  \item matplotlib (pylab) for quality 2d plotting (moving towards mandatory requirement)
  \item VTK \url{http://mayavi.sourceforge.net/dwnld/vtk/win32/}
\end{itemize}



\section{System configuration}


The system path on Win32 architectures must contain the directories
\begin{verbatim}
  PATH=C:\Python23;C:\MinGW\bin;C:\Program Files\swollen
\end{verbatim}
(similar for Linux....)

In addition the root directory for all anuga/inundation modules must be on
the pythonpath, e.g.\
\begin{verbatim}
PYTHONPATH=C:\anuga\inundation
\end{verbatim}





\section{Installation}

(Explain how to check out from svn or obtain from elsewhere)


In the ANUGA root directory, run the compilation script:
{\small \begin{verbatim}
  scons
\end{verbatim}}



\subsection{Testing}

In the ANUGA root directory, run the test suite:
{\small \begin{verbatim}
  python test_all.py
\end{verbatim}}




\section{Other stuff to be included}

\begin{verbatim}
Install tortoise from downloads (ITs didn't integrate wih explorer).
In settings set proxy to proxy.agso.gov.au  8080


Install swollen from latest distro (in subversion)


\end{verbatim}





\end{document}