Changeset 5778

Timestamp:

Sep 22, 2008, 3:04:24 PM (15 years ago)

Author:

rwilson

Message:

Smoothed out the Windows part of installation.

File:

• anuga_core/documentation/user_manual/anuga_installation_guide.tex (modified) (3 diffs)

anuga_core/documentation/user_manual/anuga_installation_guide.tex

@@ -55 +55 @@
 To run ANUGA you will need a Windows (2000 or XP) or a Linux PC with at 
 least 512MB RAM. The viewer (Windows only) requires a graphics adapter that
-is OpenGL compatible. It has been tested with e.g. ATI FireGL X1 
-and the NVIDIA family. It may not work with cards such as those from the 
+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.
 
@@ -67 +67 @@
 
 \begin{enumerate}  
- 
-  \item For Python 2.5, install Python pre-requisites: Python2.5, 
-  Scientific Python, Mingw, Numeric
-  and the NetCDF library. Note that the scientific Python installation
-  sometimes ends with an error message, although ANUGA still works.
-  These packages are available from:
-  \begin{itemize} 
-    \item The supplied ANUGA distribution folder: \code{pre_requisites$\backslash$2.5} .
-      Install in the order
-      \begin{verbatim} 
-python-2.5.msi
-Numeric-23.8.2.win32-py2.5.exe
-ScientificPython-2.7.8.win32-py2.5.exe
-MinGW-5.1.4.exe
-      \end{verbatim} 
-      and then unpack \code{netcdf-3.6.1-win32.zip} into \code{C:$\backslash$bin} as suggested below.
-    \item The WEB:
-        \begin{itemize}  
-            \item Python2.5: \url{http://www.python.org/download/}.
-            \item Numeric Python: (Numeric-23.8.2.win32-py2.5.exe) \url{http://sourcesup.cru.fr/frs/?group_id=180}
-            \item Scientific Python: (ScientificPython-2.X.X.win32-py2.5.exe) \url{http://sourcesup.cru.fr/frs/?group_id=180}
-            \item MinGW: (MinGW-5.X.X.exe) \url{http://sourceforge.net/project/showfiles.php?group_id=2435}
-            \item NETCDF: Go to \url{http://www.unidata.ucar.edu/software/netcdf/binaries.html} and click on the 
-              "\code{Windows DLL}" link in the NetCDF 3.6.1 section.  This will download the file 
-              \code{netcdf-3.6.1-win32.zip} .
-              Unpack this in a folder that is available on the system path. 
-              We suggest unpacking it into \code{C:$\backslash$bin} .
-        \end{itemize}   
-  \end{itemize}   
+  \item For Python 2.5, install: Python2.5, Scientific Python, Mingw, Numeric
+    and the NetCDF library. Note that the scientific Python installation
+    sometimes ends with an error message, although ANUGA still works.
+    These packages are available from either:
+    \begin{itemize} 
+      \item The supplied ANUGA distribution folder: \code{pre_requisites$\backslash$2.5} .
+        Install in order:
+        \begin{enumerate}
+          \item \code{python-2.5.msi}
+          \item \code{Numeric-23.8.2.win32-py2.5.exe}
+          \item \code{ScientificPython-2.7.8.win32-py2.5.exe}
+          \item \code{MinGW-5.1.4.exe}
+        \end{enumerate} and then unpack \code{netcdf-3.6.1-win32.zip} into \code{C:$\backslash$bin} as suggested below.
+      \item The WEB. Install in order:
+          \begin{enumerate}  
+              \item \url{http://www.python.org/download/} and click on the \code{Python 2.5.x Windows installer} link to get
+                \code{python-2.5.x.msi}. Execute this file to install Python 2.5.
+              \item \url{http://sourcesup.cru.fr/frs/?group\%5Fid=180}. Download \code{Numeric-23.8.2.win32-py2.5.exe}
+                and execute it to install Numeric Python.
+              \item \url{http://sourcesup.cru.fr/frs/?group\%5Fid=180}. Download \code{ScientificPython-2.X.X.win32-py2.5.exe}
+                and execute it to install Scientific Python.
+              \item \url{http://sourceforge.net/project/showfiles.php?group\%5Fid=2435}. Click on the \code{Download} link for
+                the \code{Automated MinGW Installer} package. Execute the file \code{MinGW-5.X.X.exe} to install the MinGW environment.
+                Note that you will need a working internet connection to install WinGW.
+              \item \url{http://www.unidata.ucar.edu/software/netcdf/binaries.html} and click on the 
+                "\code{Windows DLL}" link in the NetCDF 3.6.1 section.  This will download the file \code{netcdf-3.6.1-win32.zip}.
+                Unpack this in a folder that is available on the system path. 
+                We suggest unpacking it into \code{C:$\backslash$bin}.
+          \end{enumerate}   
+    \end{itemize}   
   
+  \item For Python 2.4, install: The Enthought version of Python2.4, Scientific Python 
+    and the NetCDF library\footnote{Separate installation of Scientific 
+    Python and NetCDF 
+    will become unneccesary once Enthought sorts out netcdf support 
+    (see \url{https://svn.enthought.com/enthought/ticket/917})}. 
+    These are available from either:
+    \begin{itemize} 
+      \item The supplied ANUGA distribution, under the folder \code{pre_requisites} .
+        Install in order:
+        \begin{enumerate}
+          \item enthon-python2.4-1.0.0.exe
+          \item ScientificPython-2.4.9.win32-py2.4.exe
+        \end{enumerate}
+        and then unpack \code{netcdf-3.6.1-beta1-win32dll.zip} into \code{C:$\backslash$bin} as suggested below.
+      \item The WEB. Install in order:
+      \begin{enumerate}  
+        \item \url{http://code.enthought.com/projects/} and install the Enthought environment for Python 2.4.x.
+        \item \url{http://sourceforge.net/project/showfiles.php?group\%5Fid=172848}. Click on the \code{Download} link for Scientific Python
+          and download \code{ScientificPython-2.4.9.win32-py2.4.exe} which will install Scientific Python.
+        \item \url{http://www.unidata.ucar.edu/software/netcdf/binaries.html} and click on the 
+          "\code{Windows DLL}" link in the NetCDF 3.6.1 section.  This will download the file \code{netcdf-3.6.1-win32.zip}.
+          Unpack this in a folder that is available on the system path. We suggest unpacking it into \code{C:$\backslash$bin} .
+      \end{enumerate}   
+    \end{itemize}   
   
-  \item For Python 2.4, install Python pre-requisites: The Enthought version of Python2.4, 
-  Scientific Python 
-  and the NetCDF library\footnote{Separate installation of Scientific 
-  Python and NetCDF 
-  will become unneccesary once Enthought sorts out netcdf support 
-  (see \url{https://svn.enthought.com/enthought/ticket/917})}. 
-  These are available from either 
-  \begin{itemize} 
-    \item The supplied ANUGA distribution as under the folder \code{pre_requisites} .
-      Install in the order
-      \begin{verbatim} 
-enthon-python2.4-1.0.0.exe
-ScientificPython-2.4.9.win32-py2.4.exe
-      \end{verbatim} 
-      and then unpack \code{netcdf-3.6.1-beta1-win32dll.zip} into \code{C:$\backslash$bin} as 
-      suggested below.
-    \item The WEB:
-    \begin{itemize}  
-      \item Enthought version of Python2.4: \url{http://code.enthought.com/projects/}
-      \item Scientific Python: \url{http://sourceforge.net/project/showfiles.php?group_id=172848}
-%      \item NETCDF: download the file netcdf-3.6.1-beta1-win32dll.zip from 
-%      \url{http://www.unidata.ucar.edu/software/netcdf/binaries.html} 
-%      (\url{ftp://ftp.unidata.ucar.edu/pub/netcdf/contrib/win32/netcdf-3.6.1-beta1-win32dll.zip}). 
-%      Unpack this in a folder that is available on the system path. 
-%      We suggest unpacking it into 
-%      \begin{verbatim} 
-%      C:\bin
-%      \end{verbatim}  
-     \item NETCDF: Go to \url{http://www.unidata.ucar.edu/software/netcdf/binaries.html} and click on the 
-        "\code{Windows DLL}" link in the NetCDF 3.6.1 section.  This will download the file 
-        \code{netcdf-3.6.1-win32.zip} .
-        Unpack this in a folder that is available on the system path. 
-        We suggest unpacking it into \code{C:$\backslash$bin} .
-    \end{itemize}   
-  \end{itemize}   
-  
-  \item Add the following to the PATH environment variable
-    \begin{verbatim}
-PATH=C:\Python24;C:\Python24\Enthought\MingW\bin;C:\bin
-    \end{verbatim}   %C:\Program Files\anuga_viewer;
-  \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$Python24$\backslash$Lib$\backslash$site-packages}. This is often done in Windows by 
-  double clicking on the .tgz file and then 'browse to' the 
-  destination directory.
+  \item Add the following to the PATH environment variable:
+    \begin{verbatim}PATH=C:\Python24;C:\Python24\Enthought\MingW\bin;C:\bin\end{verbatim}
+    For details on how to do this under windows please refer to Section \ref{sec:windowspath}.
+
+  \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$Python24$\backslash$Lib$\backslash$site-packages}.
+    This is often done in Windows by double clicking on the .tgz file and then 'browse to' the destination directory.
+
   \item In the ANUGA root directory (\code{C:$\backslash$Python24$\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, 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.
+    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, 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 \code{anuga_validation$\backslash$automated_validation_tests} in 
-  which you can run
-  \begin{verbatim}
-python validate_all.py
-  \end{verbatim}
+    to the directory \code{anuga_validation$\backslash$automated_validation_tests} in which you can run
+    \begin{verbatim}python validate_all.py\end{verbatim}
+
+
+  \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 .sww files with the executable
+      \begin{verbatim}C:\Program Files\anuga_viewer\animate.exe\end{verbatim}        
+    \end{enumerate} 
+
+    Try the demos provided in the ANUGA directory \code{anuga\_demos} 
+    (discussed in the ANUGA user manual 
+    and also at 
+    \url{http://datamining.anu.edu.au/\~{}ole/anuga/user_manual/anuga_user_manual.pdf})
+    and view the resulting .sww files with the anuga_viewer.
 \end{enumerate}   
 
-
-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 .sww files with the executable
-  \begin{verbatim} 
-C:\Program Files\anuga_viewer\animate.exe
-  \end{verbatim}        
-\end{enumerate} 
-
-Try the demos provided in the ANUGA directory \code{anuga\_demos} 
-(also discussed in the ANUGA user manual available with the distribution 
-and also at 
-\url{http://datamining.anu.edu.au/\~{}ole/anuga/user_manual/anuga_user_manual.pdf})
-and view the resulting .sww files with the anuga_viewer.
 
 %To run the ANUGA against the Okushiri Island wave tank validation dataset
@@ -318 +295 @@
 
 
+\chapter{Appendix}
+\section{Setting the PATH on Windows}
+\label{sec:windowspath}