Changeset 8083 for branches/anuga_1_2_1/anuga_core/documentation/user_manual/anuga_installation_guide.tex

Timestamp:

Nov 24, 2010, 4:55:55 PM (13 years ago)

Author:

habili

Message:

Bug fixes, including correct use of starttime and duration.

File:

• branches/anuga_1_2_1/anuga_core/documentation/user_manual/anuga_installation_guide.tex (modified) (7 diffs)

branches/anuga_1_2_1/anuga_core/documentation/user_manual/anuga_installation_guide.tex

@@ -3 +3 @@
 \title{ANUGA Installation Guide}
 
-%\author{Ole Nielsen, Duncan Gray, Jane Sexton}
-
 \usepackage{graphicx}
-
+\usepackage{hyperref}
 
 % Please at least include a long-lived email address;
 % the rest is at your discretion.
 \authoraddress{Geoscience Australia \\
-  Email: \email{nariman.habili@ga.gov.au}
+  Email: \email{anuga@ga.gov.au}
 }
 
@@ -56 +54 @@
 \label{sec:requirements}
 
-To run ANUGA you will need a Windows PC (XP or Vista) or a Linux PC with at 
+To run ANUGA you will need a Windows PC (XP, Vista or 7) or a Linux PC with at 
 least 512MB RAM.  As ANUGA is a memory-intensive numerical system, more memory is better than less.
 
 The viewer (Windows only) requires a graphics adapter that
-is OpenGL compatible. It has been tested with ATI FireGL X1 cards
-and the NVIDIA family. It may not work with other cards such as those from the
-Intel(R) 82915G Express chipset family.
-
-The instructions below are written for the numpy version of ANUGA.  ANUGA changed from
-relying on the Numeric package to the numpy package early in July, 2009.  If you have a Numeric ANUGA,
-you should refer to the installation instructions for that version.  The last Numeric version of 
+is OpenGL compatible. It has been tested with ATI, NVIDIA and Mobile Intel(R) GM45 Express chipsets.
+
+The instructions below are written for the numpy version of ANUGA. ANUGA changed from
+relying on the Numeric package to the numpy package early in July, 2009. If you have a Numeric ANUGA,
+you should refer to the installation instructions for that version. The last Numeric version of 
 ANUGA had a build number of 7163.
 
@@ -76 +72 @@
 \section{Installation}
 
-Below are the install procedures for Windows XP, Windows Vista (both 32 bit) and Linux (32 and 64 bit).
-
-\subsection{Quick install - Windows XP (32 bit)}
+Below are the install procedures for Windows XP, Windows Vista, Windows 7 (all 32 bit) and Linux (32 and 64 bit).
+
+\subsection{Quick install - Windows XP, Vista and 7 (32 bit)}
 \label{sec:winxp}
 
@@ -90 +86 @@
 run the test suite (optional) and then run a series of validation examples (optional). This may take some time.
 Try the demonstrations provided in the ANUGA directory \code{anuga\_demos} (discussed in the ANUGA user manual at 
-\url{http://datamining.anu.edu.au/\%7Eole/anuga/user\%5Fmanual/anuga\%5Fuser\%5Fmanual.pdf}) 
+\url{https://datamining.anu.edu.au/anuga/attachment/wiki/WikiStart/anuga_user_manual-1.2.0.pdf}) 
 and view the resulting \code{.sww} files with the ANUGA viewer.
 
-%This procedure assumes that you do not have python installed on the target machine.
-%If you do have a python installed already then skip the installation of python as
-%long as you have version 2.5 or later installed.
-%
-%\begin{itemize}  
-%  \item Install the support software, in order.
-%    \begin{enumerate}
-%      \item Execute \code{python-2.5.4.msi} to install python.
-%
-%      \item Install MinGW from \code{MinGW-5.1.4.exe}.  Install components:
-%        \begin{enumerate}
-%          \item MinGW base tools
-%          \item g++ compiler
-%          \item MinGW Make
-%        \end{enumerate}
-%        Note that you will need an internet connection for the above install.
-%
-%      \item Execute \code{numpy-1.3.0-win32-superpack-python2.5.exe} to install numpy.
-%
-%      \item Execute \code{netCDF_binary_4.0.exe} to install NetCDF.
-%
-%      \item Execute \code{ScientificPython-2.9.0.win32-py2.5.exe} to install Scientific Python.
-%  
-%      \item Execute \code{matplotlib-0.98.5.2.win32-py2.5.exe} to install matplotlib.
-%    \end{enumerate}
-%  
-%  \item Add the following to the end of the PATH environment variable:
-%    \begin{verbatim};C:\Python25;C:\MingW\bin;C:\netcdf4\bin\end{verbatim}
-%    For details on how to do this under Windows please refer to Appendix \ref{sec:setwindowspath}.
-%\end{itemize}  
-%
-%\subsubsection{ANUGA Installation}
-%\label{sec:ANUGA}
-%
-%\begin{itemize}  
-%  \item Unpack the ANUGA source code (\code{anuga-1.0_xxxx.tgz})\footnote{Internet Explorer has the habit of renaming the .tgz files to .gz - 
-%                                                                          the remedy is to rename them back or use another browser such as Firefox.} 
-%    in the python site-packages directory \code{C:$\backslash$Python25$\backslash$Lib$\backslash$site-packages}.
-%    This is often done in Windows by double clicking on the \code{.tgz} file and then 'browse to' the destination directory.
-%
-%  \item In the ANUGA root directory (\code{C:$\backslash$Python25$\backslash$Lib$\backslash$site-packages$\backslash$anuga}), 
-%    run the compilation script (either from the commandline or by running it in IDLE):
-%    \begin{verbatim}python compile_all.py\end{verbatim}
-%
-%  \item In the ANUGA root directory (\code{C:$\backslash$Python25$\backslash$Lib$\backslash$site-packages$\backslash$anuga}),
-%    run the test suite (either from the commandline or by running it in IDLE):
-%    \begin{verbatim}python test_all.py\end{verbatim} ANUGA has been succesfully installed if the tests pass.
-%
-%  \item To verify that ANUGA succesfully reproduces a series of validation examples, go
-%    to the directory
-%    \linebreak
-%    \code{anuga_validation$\backslash$automated_validation_tests} under the ANUGA root directory where you can run:
-%    \begin{verbatim}python validate_all.py\end{verbatim}
-%    This may take some time.
-%
-%  \item To install the ANUGA viewer:
-%    \begin{enumerate} 
-%      \item Unpack the distribution (\code{anuga_viewer_1.0.tgz}) into:
-%        \begin{verbatim}C:\Program Files\end{verbatim}
-%
-%      \item Double click on the test file:
-%        \begin{verbatim}C:\Program Files\anuga_viewer\cylinders.sww\end{verbatim}
-%
-%      \item Associate \code{.sww} files with the executable:
-%      \begin{verbatim}C:\Program Files\anuga_viewer\animate.exe\end{verbatim}        
-%      For details on how to do this under Windows please refer to Appendix \ref{sec:assocanimatesww}.
-%    \end{enumerate} 
-%
-%    Try the demonstrations provided in the ANUGA directory \code{anuga\_demos} 
-%    (discussed in the ANUGA user manual at 
-%    \url{http://datamining.anu.edu.au/\%7Eole/anuga/user\%5Fmanual/anuga\%5Fuser\%5Fmanual.pdf})
-%    and view the resulting \code{.sww} files with the ANUGA viewer.
-%\end{itemize}   
 
 
@@ -177 +100 @@
 %details.
 
-\subsection{Quick install - Windows Vista}
-\label{sec:winvista}
-
-The installation of the support software and the ANUGA software should be the same as for Windows XP above.
-The installation and use of ANUGA under Windows Vista has not been heavily tested.  Feedback on any aspect
-of using ANUGA under Vista is welcomed.
-
 \subsection{Quick install - Linux}
 \label{sec:linux}
 
-The procedure to install onto a Linux platform is targetted at a Debian-like Linux, such as Ubuntu.
-If you use another Linux the overall procedure should be followed, although the details will vary.
-
-The steps below assume that you do not have python installed on the target machine.
-If you do have a python installed already then skip the installation of python as
-long as you have version 2.5 or later.
-
-Note that even if you already have python installed you should still check if things like 
-\code{python-dev} and \code{python-profiler} need to be installed.
-
-\subsubsection{Support Software - Linux 32 bit}
-\label{sec:linux32bit}
-
-Install support software (in order):
-\begin{enumerate}  
-  \item Install the python development environment, either through Synaptic or by:
-    \begin{verbatim}sudo apt-get install python python-dev python-profiler\end{verbatim}
-    If you already have python 2.5 or later installed, don't include \code{python} above.
-
-  \item Install g++, either through Synaptic or by:
-    \begin{verbatim}sudo apt-get install g++\end{verbatim}
-
-  \item Install the numpy package, either through Synaptic or by:
-    \begin{verbatim}sudo apt-get install python-numpy\end{verbatim}
-
-  \item Install the NetCDF package from the .tar.gz file:
-    \begin{verbatim}tar xzf netcdf.tar.gz
-cd netcdf-4.0.1
-./configure
-make check
-sudo make install
-cd\end{verbatim}
-
-  \item Install the ScientificPython package from the .tar.gz file:
-    \begin{verbatim}tar xzf ScientificPython-2.9.0.tar.gz
-cd ScientificPython-2.9.0
-python setup.py build --numpy
-sudo python setup.py install
-cd\end{verbatim}
-
-  \item Install matplotlib, either through Synaptic or by:
-    \begin{verbatim}sudo apt-get install python-matplotlib\end{verbatim}
-\end{enumerate}   
-
-\subsubsection{Support Software - Linux 64 bit}
-\label{sec:linux64bit}
-
-Install support software (in order):
-\begin{enumerate}  
-  \item Install the python development environment, either through Synaptic or by:
-    \begin{verbatim}sudo apt-get install python python-dev python-profiler\end{verbatim}
-    If you already have python 2.5 or later installed, don't include \code{python} above.
-
-  \item Install g++, either through Synaptic or by:
-    \begin{verbatim}sudo apt-get install g++\end{verbatim}
-
-  \item Define a CFLAGS value:
-    \begin{verbatim}export CFLAGS=-fPIC\end{verbatim}
-
-  \item Install the numpy package, either through Synaptic or by:
-    \begin{verbatim}sudo apt-get install python-numpy\end{verbatim}
-
-  \item Install the NetCDF package from the .tar.gz file:
-    \begin{verbatim}tar xzf netcdf.tar.gz
-cd netcdf-4.0.1
-./configure
-make check
-sudo make install
-cd\end{verbatim}
-
-  \item Install the ScientificPython package from the .tar.gz file:
-    \begin{verbatim}tar xzf ScientificPython-2.9.0.tar.gz
-cd ScientificPython-2.9.0
-python setup.py build --numpy
-sudo python setup.py install
-cd\end{verbatim}
-
-  \item Install matplotlib, either through Synaptic or by:
-    \begin{verbatim}sudo apt-get install python-matplotlib\end{verbatim}
-\end{enumerate}   
-
-\subsubsection{ANUGA Installation - 32 or 64 bit}
-\label{sec:ANUGA32-64bit}
-
-\begin{enumerate}  
-  \item Get the ANUGA source from \url{http://sourceforge.net/projects/anuga} (\code{anuga-1.0_5789.tgz} say),
-    and expand it into the python site-packages directory \code{/usr/lib/python2.5/site-packages}.
-    In the unpacked ANUGA directory \code{/usr/lib/python2.5/site-packages/anuga} run the command:
-    \begin{verbatim}sudo python compile_all.py\end{verbatim}
-
-  \item In the ANUGA root directory (\code{/usr/lib/python2.5/site-packages/anuga})
-    run the test suite:
-    \begin{verbatim}python test_all.py\end{verbatim} ANUGA has been succesfully installed if the tests pass.
-
-  \item To verify that ANUGA succesfully reproduces a series of validation examples, go
-    to the directory
-    \linebreak
-    \code{/usr/lib/python2.5/site-packages/anuga_validation/automated_validation_tests}
-    where you can run validation tests to ensure the correct running of ANUGA:
-    \begin{verbatim}python validate_all.py\end{verbatim}
-    This may take some time.
-\end{enumerate}
+Please note that the following applies only to Ubuntu 10.04 and 10.10. We currently do not
+support any other Linux distributions.
+
+Open a terminal and enter:
+\begin{verbatim}
+sudo add-apt-repository ppa:anuga/ppa
+sudo apt-get update
+sudo apt-get install python-anuga
+\end{verbatim}
+
+For the Ubuntu version, you do not need to run test_all.py or compile_all.py. They have already been done for you.
+
 
 \section{Optional but recommended software}
@@ -309 +135 @@
 \section{Testing}
 
-In the ANUGA root directory, run the test suite:
+If you install ANUGA directly from the SVN repository (not the Windows one-click installer or using apt-get install for Ubuntu),
+you should run the unit tests to verify that all the tests pass. In the ANUGA root directory, run the test suite:
 \begin{verbatim}
 python test_all.py
@@ -361 +188 @@
 environment "System variables". However, in case you do not have
 permission to modify the system variable, then the method of setting the PATH environment "User variable" 
-for Windows XP is shown here. Setting the variable for Windows Vista should be similar.
+for Windows XP is shown here. Setting the variable for Windows Vista and 7 should be similar.
 
 \setlength\fboxsep{0pt}