Changeset 3921


Ignore:
Timestamp:
Nov 6, 2006, 5:39:10 PM (16 years ago)
Author:
ole
Message:

Updated installation guide

Location:
anuga_core/documentation/user_manual
Files:
3 edited

Legend:

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

    r3898 r3921  
    5252
    5353\begin{enumerate} 
    54   \item Download and install the Enthought version of Python2.4 from \url{http://code.enthought.com/enthon/}.
    55   \item Download and install Scientific Python: \url{http://sourcesup.cru.fr/frs/download.php/745/ScientificPython-2.4.9.win32-py2.4.exe}\footnote{This step will become unneccesary once Enthought sorts out netcdf support (see https://svn.enthought.com/enthought/ticket/917)}.
    56  
    57   %NETCDF ftp://ftp.unidata.ucar.edu/pub/netcdf/contrib/win32/netcdf-3.6.1-beta1-win32dll.zip
    58   %Separate Scientific Python: http://sourcesup.cru.fr/frs/download.php/745/ScientificPython-2.4.9.win32-py2.4.exe
     54 
     55  \item Install Python pre-requisites: The Enthought version of Python2.4, Scientific Python
     56  and the NetCDF library\footnote{Separate installation of Scientific Python and NetCDF
     57  will become unneccesary once Enthought sorts out netcdf support
     58  (see \url{https://svn.enthought.com/enthought/ticket/917})}. These are available from either
     59  \begin{itemize}
     60    \item The supplied ANUGA distribution as under the folder pre_requisites
     61    \item The WEB:
     62    \begin{itemize} 
     63      \item Enthought version of Python2.4: \url{http://code.enthought.com/enthon/}.
     64      \item Scientific Python: \url{http://sourcesup.cru.fr/frs/download.php/745/ScientificPython-2.4.9.win32-py2.4.exe}
     65      \item NETCDF \url{ftp://ftp.unidata.ucar.edu/pub/netcdf/contrib/win32/netcdf-3.6.1-beta1-win32dll.zip}
     66    \end{itemize}   
     67  \end{itemize}   
    5968 
    6069  \item Add the following to the PATH environment variable
     
    6271      PATH=C:\Python24;C:\Python24\Enthought\MingW\bin;C:\Program Files\anuga_viewer
    6372    \end{verbatim}
    64   \item Unpack the ANUGA source code (anuga.tgz) in the python site-packages
    65   directory (C:\Python24\Lib\site-packages)
    66   \item In the ANUGA root directory (C:\Python24\Lib\site-packages\anuga), run the compilation script:
     73  \item Unpack the ANUGA source code (\code{anuga-1.0_xxxx.tgz})
     74  in the python site-packages
     75  directory \code{C:\\Python24\\Lib\\site-packages}
     76  \item In the ANUGA root directory (\code{C:\\Python24\\Lib\\site-packages\\anuga}),
     77  run the compilation script (either from the commandline or by clicking on it):
    6778    {\small \begin{verbatim}
    6879        python compile_all.py
     
    7788To install the anuga\_viewer
    7889\begin{enumerate}
    79   \item Unpack the distribution () in
     90  \item Unpack the distribution (\code{anuga_viewer_1.0.tgz}) in
    8091    \begin{verbatim}
    81       C:\Program Files\anuga_viewer
     92      C:\Program Files
    8293    \end{verbatim}
    8394  \item Associate .sww files with the executable
     
    91102\end{enumerate}
    92103
    93 Try the demos provided in the ANUGA root directory (also discussed in the ANUGA user manual
     104Try the demos provided in the ANUGA root directory
     105(also discussed in the ANUGA user manual available with the distribution and also at
    94106\url{http://datamining.anu.edu.au/~ole/anuga/user_manual/anuga_user_manual.pdf}) and
    95107view the resulting sww files with the anuga\_viewer.
    96108
    97 
    98 
     109To verify that the installed version of ANUGA validates satisfactorily
     110against the Okushiri Island wave tank validation dataset
     111(\url{http://www.cee.cornell.edu/longwave/index.cfm?page=benchmark&problem=2})
     112unpack the distribution (\code{anuga_validation_1.0_xxxx.tgz}) into
     113any directory and run the scripts \code{create_okushiri.py},
     114\code{run_okushiri.py} and \code{compare_timeseries.py}.  See also the
     115\code{README.txt} file that comes with the validation scripts for more
     116details.
     117
     118
     119
     120\clearpage
    99121\section{Pre-requisites}
    100122\label{sec:prerequisites}
    101123
    102 The Anuga software core (shallow\_water, pmesh, least\_squares, ...) depends on the following:
     124This and the following sections is for custom installations and installations using Linux.
     125
     126The ANUGA software core (shallow\_water, pmesh, least\_squares, ...) depends on the following:
    103127
    104128
     
    156180\section{Installation of source zip file}
    157181Get a source zip file, for example, anuga_source_3807.zip, and expand
    158 it in the python site-packages directory (C:\Python24\Lib\site-packages)
    159 
    160 In the ANUGA root directory (C:\Python24\Lib\site-packages\anuga), run the compilation script:
     182it in the python site-packages directory (\code{C:\\Python24\\Lib\\site-packages})
     183
     184In the ANUGA root directory (\code{C:\\Python24\\Lib\\site-packages\\anuga}),
     185run the compilation script:
    161186{\small \begin{verbatim}
    162187  python compile_all.py
  • anuga_core/documentation/user_manual/anuga_user_manual.tex

    r3829 r3921  
    300300significance.
    301301
    302 \verbatiminput{examples/runup.py}
    303 %\verbatiminput{examples/bedslope.py}
     302%\verbatiminput{examples/runup.py}
     303\verbatiminput{../../demos/runup.py}
     304
    304305
    305306\subsection{Establishing the Mesh}\index{mesh, establishing}
  • anuga_core/documentation/user_manual/update_anuga_user_manual.py

    r3575 r3921  
    33"""Update, compile and create PDF and HTML from LaTeX file
    44
    5 This can for example be run from a cronjob:
     5Usage:
     6    python update_anuga_user_manual.py <options>
     7   
     8Options:
     9    --no_html: Skip automatic generation of html version
     10   
     11
     12
     13This script can for example be run from a cronjob:
    614
    715  crontab -e
     
    2129"""
    2230
     31from os import system, chdir
     32from os.path import expanduser
    2333
    24 import os
     34from sys import argv
    2535
    2636
    27 anugapath = os.path.expanduser('~/inundation/anuga_core/documentation/user_manual')
     37anugapath = expanduser('~/inundation/anuga_core/documentation/user_manual')
    2838texfiles = ['anuga_user_manual', 'anuga_installation_guide']
    2939
    30 os.chdir(anugapath) # Move to location of LaTeX files
    31 os.system('svn up') # Update from svn
     40chdir(anugapath) # Move to location of LaTeX files
     41system('svn update') # Update from svn
    3242
    3343
     44do_html = True       
     45if len(argv) > 1:
     46    if argv[1] == '--no_html':
     47        do_html = False
     48    else:
     49        msg = 'Unknown option: %s' %argv[1]
     50        raise Exception(msg)
     51   
    3452for texfile in texfiles:
    3553    print 'Processing %s' %texfile
    3654    # Compile with LaTeX, makeindex etc
    3755    for i in range(3):
    38         os.system('latex --interaction=nonstopmode %s.tex' %texfile)
    39         os.system('makeindex %s.idx' %texfile)
    40         os.system('makeindex mod%s.idx' %texfile)
    41         os.system('bibtex %s' %texfile)   
     56        system('latex --interaction=nonstopmode %s.tex' %texfile)
     57        system('makeindex %s.idx' %texfile)
     58        system('makeindex mod%s.idx' %texfile)
     59        system('bibtex %s' %texfile)   
    4260
    4361    # Create pdf file
    44     os.system('dvips %s -o %s.ps' %((texfile,)*2))   
    45     os.system('ps2pdf %s.ps' %texfile)   
     62    system('dvips %s -o %s.ps' %((texfile,)*2))   
     63    system('ps2pdf %s.ps' %texfile)   
    4664     
    47     # Create html pages     
    48     os.system('latex2html %s' %texfile)
     65    # Create html pages
     66    if do_html is True:
     67        system('latex2html %s' %texfile)
     68    else:
     69        print 'Skipping html version for %s as requested' %texfile
    4970
Note: See TracChangeset for help on using the changeset viewer.