Changeset 3888


Ignore:
Timestamp:
Oct 30, 2006, 3:31:25 PM (16 years ago)
Author:
ole
Message:

Added quick-install info to installation guide

File:
1 edited

Legend:

Unmodified
Added
Removed
  • anuga_core/documentation/user_manual/anuga_installation_guide.tex

    r3822 r3888  
    4646
    4747
     48\section{Quick install (Windows only)}
     49
     50This section provides the quickest path to getting ANUGA up and running on a Windows machine.
     51For Linux and for more details please refer to Section \ref{sec:prerequisites}.
     52
     53\begin{enumerate} 
     54  \item Download and install the Enthought version of Python2.4 from \url{http://code.enthought.com/enthon/}.
     55  \item Add the following to the PATH environment variable
     56    \begin{verbatim}
     57      PATH=C:\Python24;C:\Python24\Enthought\MingW\bin;C:\Program Files\anuga_viewer
     58    \end{verbatim}
     59  \item Unpack the ANUGA source code (anuga.tgz) in the python site-packages
     60  directory (C:\Python24\Lib\site-packages)
     61  \item In the ANUGA root directory (C:\Python24\Lib\site-packages\anuga), run the compilation script:
     62    {\small \begin{verbatim}
     63        python compile_all.py
     64    \end{verbatim}}
     65  \item In the ANUGA root directory, run the test suite:
     66    {\small \begin{verbatim}
     67        python test_all.py
     68    \end{verbatim}}
     69    ANUGA has been succesfully installed if the tests pass.
     70\end{enumerate}   
     71
     72To install the anuga\_viewer
     73\begin{enumerate}
     74  \item Unpack the distribution () in
     75    \begin{verbatim}
     76      C:\Program Files\anuga_viewer
     77    \end{verbatim}
     78  \item Associate .sww files with the executable
     79  \begin{verbatim}
     80    C:\Program Files\anuga_viewer\animate.exe
     81  \end{verbatim}       
     82  \item Double click on the test file
     83    \begin{verbatim}
     84      C:\Program Files\anuga_viewer\cylinders.sww
     85    \end{verbatim}       
     86\end{enumerate}
     87
     88Try the demos provided in the ANUGA root directory (also discussed in the ANUGA user manual
     89\url{http://datamining.anu.edu.au/~ole/anuga/user_manual/anuga_user_manual.pdf}) and
     90view the resulting sww files with the anuga\_viewer.
     91
     92
     93
    4894\section{Pre-requisites}
    49 
    50 The Anuga software core (pyvolution, pmesh, least\_squares, ...) depends on the following:
     95\label{sec:prerequisites}
     96
     97The Anuga software core (shallow\_water, pmesh, least\_squares, ...) depends on the following:
     98
    5199
    52100\begin{itemize}
    53   \item python 2.3 or later \url{http://www.python.org}Note, the
    54   dll python2X.dll is needed to compile ANUGA, but is not
     101  \item python 2.3 or later \url{http://www.python.org}/footnote{Note, the
     102  dll python2X.dll is needed to compile ANUGA, but is not always
    55103  automatically added for versions 2.4 and above.  Install it into the
    56   python2X directory, if you need it. 
     104  python2X directory, if you need it.}. 
    57105  \item python-numeric for Linux.  It's called Numeric in Windows. 
    58   \item python-dev (Interestingly, numeric seems to be installed as
    59   well) for Linux.  This is not necessary for Windows.
     106  %\item python-dev (Interestingly, numeric seems to be installed as
     107  %well) for Linux.  This is not necessary for Windows.
    60108  \item python-scientific (to provide python-netcdf) for Linux.  It's
    61109    called ScientificPython in Windows.
    62   \item NETCDF.  Extract the file netcdf.dll, and put in C://Windows//System32// (Windows XP) or C://WINNT//System32 (Windows NT or 2000).
    63 
     110  \item NETCDF.  Extract the file netcdf.dll, and put in C://Windows//System32// (Windows XP) or C://WINNT//System32 (Windows NT or 2000).     
    64111  \item A C compiler such as gcc (from GNU in case of Linux and MinGW
    65112  in case of Windows)
    66   \item scons for automatically compiling the distribution.
     113  %\item scons for automatically compiling the distribution.
    67114\end{itemize}
    68115
     116Note: All of these can be installed in one go on Windows platforms by using the Enthought Python
     117distribution available at \url{http://code.enthought.com/enthon/}.
    69118
    70119\section{Recommended software}
     
    72121\begin{itemize}
    73122  \item psyco \url{http://psyco.sourceforge.net/index.html}
    74   \item visual python \url{http://vpython.org}
     123  %\item visual python \url{http://vpython.org}
    75124  \item matplotlib (pylab) for quality 2d plotting (moving towards mandatory requirement)
    76125  \item VTK \url{http://mayavi.sourceforge.net/dwnld/vtk/win32/}
     
    82131
    83132
    84 The system path on Win32 architectures must contain the directories
     133The system path on Win32 architectures must contain the directories (this examples assumes the
     134Enthought Python 2.4 distribution has been installed. Path names may vary depending on the
     135exact configuration).
    85136\begin{verbatim}
    86   PATH=C:\Python23;C:\MinGW\bin;C:\Program Files\swollen
     137  PATH=C:\Python24;C:\Python24\Enthought\MingW\bin;C:\Program Files\anuga_viewer
    87138\end{verbatim}
    88 (similar for Linux....)
    89 
    90 If anuga is not installed in the python site-packages directory the root directory for all anuga/inundation modules must be on
    91 the pythonpath, e.g.\
     139The path should be analoguous for Unix operating systems.
     140
     141If anuga is not installed in the python site-packages directory the root directory for all
     142anuga/inundation modules must be on the pythonpath, e.g.\
    92143\begin{verbatim}
    93144PYTHONPATH=C:\anuga_core\source
     
    100151\section{Installation of source zip file}
    101152Get a source zip file, for example, anuga_source_3807.zip, and expand
    102 it in the python site-packages directory.
    103 
    104 In the ANUGA root directory, run the compilation script:
     153it in the python site-packages directory (C:\Python24\Lib\site-packages)
     154
     155In the ANUGA root directory (C:\Python24\Lib\site-packages\anuga), run the compilation script:
    105156{\small \begin{verbatim}
    106157  python compile_all.py
     
    118169  python test_all.py
    119170\end{verbatim}}
    120 
    121 
    122 
    123 
    124 \section{Other stuff to be included}
    125 
     171ANUGA has been succesfully installed if the tests pass as follows:
     172
     173{\tiny
    126174\begin{verbatim}
    127 Install tortoise from downloads (ITs didn't integrate wih explorer).
    128 In settings set proxy to proxy.agso.gov.au  8080
    129 
    130 
    131 Install swollen from latest distro (in subversion)
    132 
    133 
    134 \end{verbatim}
     175  ...
     176  test_data_manager.py
     177  test_interpolate_sww.py
     178  test_mesh.py
     179  test_mesh_interface.py
     180  test_triangmodule.py
     181  test_triangmoduleII.py
     182  test_advection.py
     183............................................................................................................................................
     184............................................................................................................................................
     185............................................................................................................................................
     186............................................................................................................................................
     187.................................
     188----------------------------------------------------------------------
     189Ran 593 tests in 42.712s
     190
     191OK
     192\end{verbatim} }
     193
     194
     195
     196%\section{Other stuff to be included}
     197%
     198%\begin{verbatim}
     199%Install tortoise from downloads (ITs didn't integrate wih explorer).
     200%In settings set proxy to proxy.agso.gov.au  8080
     201%%
     202%
     203%Install swollen from latest distro (in subversion)
     204%
     205%
     206%\end{verbatim}
    135207
    136208
Note: See TracChangeset for help on using the changeset viewer.