Changeset 5772


Ignore:
Timestamp:
Sep 19, 2008, 10:55:01 AM (16 years ago)
Author:
rwilson
Message:

Finally figured out how to display '\' in Win paths!

File:
1 edited

Legend:

Unmodified
Added
Removed

  • anuga_core/documentation/user_manual/anuga_installation_guide.tex

    r5771 r5772  
    7474  These packages are available from:
    7575  \begin{itemize}
    76     \item The supplied ANUGA distribution folder: \code{pre_requisites\textbackslash 2.5} .
     76    \item The supplied ANUGA distribution folder: \code{pre_requisites$\backslash$2.5} .
    7777      Install in the order
    7878      \begin{verbatim}
    … …  
    8282MinGW-5.1.4.exe
    8383      \end{verbatim}
    84       and then unpack \code{netcdf-3.6.1-win32.zip} into \code{C:\\bin} as suggested below.
     84      and then unpack \code{netcdf-3.6.1-win32.zip} into \code{C:$\backslash$bin} as suggested below.
    8585    \item The WEB:
    8686        \begin{itemize} 
    … …  
    9090            \item MinGW: (MinGW-5.X.X.exe) \url{http://sourceforge.net/project/showfiles.php?group_id=2435}
    9191            \item NETCDF: Go to \url{http://www.unidata.ucar.edu/software/netcdf/binaries.html} and click on the
    92               \code{Windows DLL} link in the NetCDF 3.6.1 section.  This will download the file
     92              "\code{Windows DLL}" link in the NetCDF 3.6.1 section.  This will download the file
    9393              \code{netcdf-3.6.1-win32.zip} .
    9494              Unpack this in a folder that is available on the system path.
    95               We suggest unpacking it into \code{C:\textbackslash bin} .
     95              We suggest unpacking it into \code{C:$\backslash$bin} .
    9696        \end{itemize}   
    9797  \end{itemize}   
    … …  
    106106  These are available from either
    107107  \begin{itemize}
    108     \item The supplied ANUGA distribution as under the folder pre_requisites
    109     (Install in the order \code{enthon-python2.4-1.0.0.exe},
    110     \code{ScientificPython-2.4.9.win32-py2.4.exe} and the unpack
    111     \code{netcdf-3.6.1-beta1-win32dll.zip} into \code{C:\textbackslash bin} as
    112     suggested below.
     108    \item The supplied ANUGA distribution as under the folder \code{pre_requisites} .
     109      Install in the order
     110      \begin{verbatim}
     111enthon-python2.4-1.0.0.exe
     112ScientificPython-2.4.9.win32-py2.4.exe
     113      \end{verbatim}
     114      and then unpack \code{netcdf-3.6.1-beta1-win32dll.zip} into \code{C:$\backslash$bin} as
     115      suggested below.
    113116    \item The WEB:
    114117    \begin{itemize} 
    115       \item Enthought version of Python2.4:
    116       \url{http://code.enthought.com/projects/}.
    117       \item Scientific Python:\\
    118        \url{http://sourceforge.net/project/showfiles.php?group_id=172848}
    119       \item NETCDF: download the file netcdf-3.6.1-beta1-win32dll.zip from
    120       \url{http://www.unidata.ucar.edu/software/netcdf/binaries.html}
    121       (\url{ftp://ftp.unidata.ucar.edu/pub/netcdf/contrib/win32/netcdf-3.6.1-beta1-win32dll.zip}).
    122       Unpack this in a folder that is available on the system path.
    123       We suggest unpacking it into
    124       \begin{verbatim}
    125       C:\bin
    126       \end{verbatim} 
     118      \item Enthought version of Python2.4: \url{http://code.enthought.com/projects/}
     119      \item Scientific Python: \url{http://sourceforge.net/project/showfiles.php?group_id=172848}
     120%      \item NETCDF: download the file netcdf-3.6.1-beta1-win32dll.zip from
     121%      \url{http://www.unidata.ucar.edu/software/netcdf/binaries.html}
     122%      (\url{ftp://ftp.unidata.ucar.edu/pub/netcdf/contrib/win32/netcdf-3.6.1-beta1-win32dll.zip}).
     123%      Unpack this in a folder that is available on the system path.
     124%      We suggest unpacking it into
     125%      \begin{verbatim}
     126%      C:\bin
     127%      \end{verbatim} 
     128     \item NETCDF: Go to \url{http://www.unidata.ucar.edu/software/netcdf/binaries.html} and click on the
     129        "\code{Windows DLL}" link in the NetCDF 3.6.1 section.  This will download the file
     130        \code{netcdf-3.6.1-win32.zip} .
     131        Unpack this in a folder that is available on the system path.
     132        We suggest unpacking it into \code{C:$\backslash$bin} .
    127133    \end{itemize}   
    128134  \end{itemize}   
    … …  
    130136  \item Add the following to the PATH environment variable
    131137    \begin{verbatim}
    132       PATH=C:\Python24;C:\Python24\Enthought\MingW\bin;C:\bin
     138PATH=C:\Python24;C:\Python24\Enthought\MingW\bin;C:\bin
    133139    \end{verbatim}   %C:\Program Files\anuga_viewer;
    134140  \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.}
    … …  
    138144  destination directory.
    139145  \item In the ANUGA root directory (\code{C:$\backslash$Python24$\backslash$Lib$\backslash$site-packages$\backslash$anuga}),
    140   run the compilation script (either from the commandline or by clicking on it):
    141     {\small \begin{verbatim}
    142         python compile_all.py
    143     \end{verbatim}}
     146  run the compilation script (either from the commandline or by running it in IDLE):
     147    \begin{verbatim}
     148python compile_all.py
     149    \end{verbatim}
    144150  \item In the ANUGA root directory, run the test suite
    145   (e.g. by opening it with IDLE and running the file):
    146     {\small \begin{verbatim}
    147         python test_all.py
    148     \end{verbatim}}
     151  (either from the commandline or by running it in IDLE):
     152    \begin{verbatim}
     153python test_all.py
     154    \end{verbatim}
    149155    ANUGA has been succesfully installed if the tests pass.
    150   \item To verify that ANUGA succesfully reproduces a series of validation
    151   examples, go
    152   to the directory \code{anuga_validation\\automated_validation_tests} in
     156  \item To verify that ANUGA succesfully reproduces a series of validation examples, go
     157    to the directory \code{anuga_validation$\backslash$automated_validation_tests} in
    153158  which you can run
    154   {\small \begin{verbatim}
    155       python validate_all.py
    156   \end{verbatim}}   
     159  \begin{verbatim}
     160python validate_all.py
     161  \end{verbatim}
    157162\end{enumerate}   
    158163
    159164
    160 
    161 
    162 To install the anuga\_viewer
     165To install the anuga_viewer:
    163166\begin{enumerate}
    164   \item Unpack the distribution (\code{anuga_viewer_1.0.tgz}) in 
    165     \begin{verbatim} 
    166       C:\Program Files
     167  \item Unpack the distribution (\code{anuga_viewer_1.0.tgz}) into
     168    \begin{verbatim}
     169 C:\Program Files
    167170    \end{verbatim}
    168171  \item Double click on the test file
    169172    \begin{verbatim}
    170       C:\Program Files\anuga_viewer\cylinders.sww
     173C:\Program Files\anuga_viewer\cylinders.sww
    171174    \end{verbatim}       
    172   \item and associate .sww files with the executable
     175  \item Associate .sww files with the executable
    173176  \begin{verbatim}
    174     C:\Program Files\anuga_viewer\animate.exe
     177C:\Program Files\anuga_viewer\animate.exe
    175178  \end{verbatim}       
    176179\end{enumerate}
    … …  
    179182(also discussed in the ANUGA user manual available with the distribution
    180183and also at
    181 \url{http://datamining.anu.edu.au/\~ole/anuga/user_manual/anuga_user_manual.pdf})and view the resulting .sww files with the anuga\_viewer.
     184\url{http://datamining.anu.edu.au/\~{}ole/anuga/user_manual/anuga_user_manual.pdf})
     185and view the resulting .sww files with the anuga_viewer.
    182186
    183187%To run the ANUGA against the Okushiri Island wave tank validation dataset
    … …  
    201205\begin{itemize}
    202206  \item python 2.3 or later\footnote{Problems have been observed with
    203   Python 2.5 and Numeric on 64 bit platforms. See
    204   \url{https://datamining.anu.edu.au/anuga/ticket/221}}
    205   \url{http://www.python.org}
     207    Python 2.5 and Numeric on 64 bit platforms. See
     208    \url{https://datamining.anu.edu.au/anuga/ticket/221}}
     209    \url{http://www.python.org}
    206210  %\footnote{Note, the
    207211  %dll python2X.dll is needed to compile ANUGA, but is not always
    … …  
    221225Note: All of these can be installed in one go on Windows platforms by
    222226using the Enthought Python
    223 distribution available at \url{http://code.enthought.com/projects/}.
     227distribution available at \url{http://code.enthought.com/projects/} .
    224228
    225229\section{Recommended software}
    226230
    227231\begin{itemize}
    228   \item psyco \url{http://psyco.sourceforge.net/index.html}: Speeds up anuga by about 30\%.
     232  \item psyco: \url{http://psyco.sourceforge.net/index.html} . Speeds up anuga by about 30\%.
    229233  %\item visual python \url{http://vpython.org}
    230   \item matplotlib (pylab) for quality 2d plotting (moving towards mandatory requirement and now part of Enthought.)
    231   \item VTK \url{http://mayavi.sourceforge.net/dwnld/vtk/win32/} - also now part of Enthought.
     234  \item matplotlib: (pylab) for quality 2d plotting (moving towards mandatory requirement and now part of Enthought).
     235  \item VTK: \url{http://mayavi.sourceforge.net/dwnld/vtk/win32/} - also now part of Enthought.
    232236\end{itemize}
    233237
    … …  
    242246exact configuration).
    243247\begin{verbatim}
    244   PATH=C:\Python24;C:\Python24\Enthought\MingW\bin;C:\Program Files\anuga_viewer
     248PATH=C:\Python24;C:\Python24\Enthought\MingW\bin;C:\Program Files\anuga_viewer
    245249\end{verbatim}
    246250The path should be analoguous for Unix operating systems.
    … …  
    259263\section{Installation of source zip file}
    260264Get a source zip file, for example, anuga_source_3807.zip, and expand
    261 it in the python site-packages directory (\code{C:\\Python24\\Lib\\site-packages})
    262 
    263 In the ANUGA root directory (\code{C:\\Python24\\Lib\\site-packages\\anuga}),
     265it in the python site-packages directory (\code{C:$\backslash$Python24$\backslash$Lib$\backslash$site-packages})
     266
     267In the ANUGA root directory (\code{C:$\backslash$Python24$\backslash$Lib$\backslash$site-packages$\backslash$anuga}),
    264268run the compilation script:
    265 {\small \begin{verbatim}
    266   python compile_all.py
    267 \end{verbatim}}
     269\begin{verbatim}
     270python compile_all.py
     271\end{verbatim}
    268272
    269273%or (in anuga_core)
    … …  
    275279
    276280In the ANUGA root directory, run the test suite:
    277 {\small \begin{verbatim}
    278   python test_all.py
    279 \end{verbatim}}
     281\begin{verbatim}
     282python test_all.py
     283\end{verbatim}
    280284ANUGA has been succesfully installed if the tests pass as follows:
    281 
    282 {\tiny
    283285\begin{verbatim}
    284286  ...
    … …  
    299301
    300302OK
    301 \end{verbatim} }
     303\end{verbatim}
    302304
    303305
Note: See TracChangeset for help on using the changeset viewer.