source: documentation/user_manual/anuga_installation_guide.tex @ 2363

Last change on this file since 2363 was 2363, checked in by ole, 19 years ago

Tried to move documentation again

File size: 2.8 KB
Line 
1\documentclass{report}
2%\usepackage{url}
3
4\newcommand{\url}{\texttt}  %Hack until \url is installed
5
6\title{AnuGA Installation Guide}
7\author{Howard Silcock, Ole Nielsen, Duncan Gray, Jane Sexton}
8
9\setlength{\parindent}{0mm} %\setlength{\parskip}{3pt}
10\setlength{\oddsidemargin}{0.6in}\setlength{\evensidemargin}{0.6in}
11\addtolength{\textheight}{1in} \addtolength{\textwidth}{0.5in}
12\setlength{\marginparwidth}{0in}
13\setlength{\topmargin}{0mm}\setlength{\headheight}{0in}
14
15\begin{document}
16\maketitle
17
18
19%Subversion keywords:
20%
21%$LastChangedDate: 2006-01-13 16:43:01 +1100 (Fri, 13 Jan 2006) $
22%$LastChangedRevision: 2206 $
23%$LastChangedBy: steve $
24
25\section*{Introduction}
26
27This document outlines the required software for installing the Anuga toolbox.
28All components are licensed as open source and readily available from the net.
29
30
31
32\subsection{Pre-requisites}
33
34The Anuga software core (pyvolution, pmesh, least\_squares, ...) depends on the following:
35
36\begin{itemize} 
37  \item python 2.3 or later \url{http://www.python.org}
38  \item python-numeric
39  \item python-dev (Interestingly, numeric seems to be installed as well)
40  \item python-scientific (to provide python-netcdf) \url{http://www-md.fsl.noaa.gov/eft/developer/netCDFPythonInterface.html} 
41    (The file netcdf.dll shipped with python-scientific must be copied to a location somewhere on the system PATH - e.g.\ in C:\\bin)
42  \item A C compiler such as gcc (from GNU in case of Linux and MinGW in case of Windows)
43\end{itemize} 
44
45
46\subsection{Recommended software}
47
48\begin{itemize} 
49  \item psyco \url{http://psyco.sourceforge.net/index.html}
50  \item visual python \url{http://vpython.org}
51  \item matplotlib (pylab) for quality 2d plotting
52\end{itemize} 
53
54
55
56\subsection*{Systom configuration}
57
58
59The system path on Win32 architectures must contain the directories
60\begin{verbatim} 
61  PATH=C:\Python24;C:\MinGW\bin;C:\Program Files\swollen
62\end{verbatim}   
63(similar for Linux....)
64
65In addition the root directory for all anuga/inundation modules must be on the pythonpath, e.g.\
66\begin{verbatim} 
67PYTHONPATH=V:\1\cit\risk_assessment_methods_project\inundation\sandpits\onielsen\anuga\inundation
68\end{verbatim}   
69
70 
71 
72
73
74
75\subsection*{Installation}
76
77(Explain how to check out from svn or obtain from elsewhere)
78
79
80In directory inundation, run the compilation script:
81{\small \begin{verbatim}
82  python compile_all.py
83\end{verbatim}}
84
85
86
87\subsection{Testing}
88
89
90In directory inundation, run the test suite:
91{\small \begin{verbatim}
92  python test_all.py
93\end{verbatim}}
94
95
96
97
98\section{Other stuff to be included}
99
100\begin{verbatim} 
101Install tortoise from downloads (IT`s didnt integrate wih explorer).
102In settings set proxy to proxy.agso.gov.au  8080
103
104
105Install swollen from latest distro (in subversion)
106
107
108\end{verbatim} 
109 
110
111
112
113\end{document}
Note: See TracBrowser for help on using the repository browser.