Ignore:
Timestamp:
Feb 13, 2006, 11:02:36 AM (19 years ago)
Author:
ole
Message:

Doc formatting

Location:
documentation/user_manual
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • TabularUnified documentation/user_manual/anuga_installation_guide.tex

    r2363 r2377  
    1 \documentclass{report}
    2 %\usepackage{url}
     1\documentclass{manual}
    32
    4 \newcommand{\url}{\texttt}  %Hack until \url is installed
    53
    6 \title{AnuGA Installation Guide}
     4\title{ANUGA Installation Guide}
     5
    76\author{Howard Silcock, Ole Nielsen, Duncan Gray, Jane Sexton}
    87
    9 \setlength{\parindent}{0mm} %\setlength{\parskip}{3pt}
    10 \setlength{\oddsidemargin}{0.6in}\setlength{\evensidemargin}{0.6in}
    11 \addtolength{\textheight}{1in} \addtolength{\textwidth}{0.5in}
    12 \setlength{\marginparwidth}{0in}
    13 \setlength{\topmargin}{0mm}\setlength{\headheight}{0in}
     8% Please at least include a long-lived email address;
     9% the rest is at your discretion.
     10\authoraddress{Geoscience Australia \\
     11  Email: \email{ole.nielsen@ga.gov.au}
     12}
     13
     14%Draft date
     15\date{\today}                   % update before release!
     16                                % Use an explicit date so that reformatting
     17                                % doesn't cause a new date to be used.  Setting
     18                                % the date to \today can be used during draft
     19                                % stages to make it easier to handle versions.
     20
     21\release{1.0}                   % release version; this is used to define the
     22                                % \version macro
     23
     24\makeindex                      % tell \index to actually write the .idx file
     25%\makemodindex                  % If this contains a lot of module sections.
     26
     27
    1428
    1529\begin{document}
    … …  
    1731
    1832
    19 %Subversion keywords:
    20 %
    21 %$LastChangedDate: 2006-01-13 16:43:01 +1100 (Fri, 13 Jan 2006) $
    22 %$LastChangedRevision: 2206 $
    23 %$LastChangedBy: steve $
    2433
    25 \section*{Introduction}
     34% This makes the contents more accessible from the front page of the HTML.
     35\ifhtml
     36\chapter*{Front Matter\label{front}}
     37\fi
     38
     39
     40
     41
     42\chapter{Introduction}
    2643
    2744This document outlines the required software for installing the Anuga toolbox.
    2845All components are licensed as open source and readily available from the net.
    29 
    30 
    31 
    32 \subsection{Pre-requisites}
     46       
     47       
     48\section{Pre-requisites}
    3349
    3450The Anuga software core (pyvolution, pmesh, least\_squares, ...) depends on the following:
    … …  
    3854  \item python-numeric
    3955  \item python-dev (Interestingly, numeric seems to be installed as well)
    40   \item python-scientific (to provide python-netcdf) \url{http://www-md.fsl.noaa.gov/eft/developer/netCDFPythonInterface.html}
    41     (The file netcdf.dll shipped with python-scientific must be copied to a location somewhere on the system PATH - e.g.\ in C:\\bin)
     56  \item python-scientific (to provide python-netcdf)
     57    \url{http://www-md.fsl.noaa.gov/eft/developer/netCDFPythonInterface.html}
     58    (The file netcdf.dll shipped with python-scientific must be copied to a
     59    location somewhere on the system PATH - e.g.\ in C:\\bin)
    4260  \item A C compiler such as gcc (from GNU in case of Linux and MinGW in case of Windows)
    4361\end{itemize}
    44 
    45 
    46 \subsection{Recommended software}
     62       
     63       
     64\section{Recommended software}
    4765
    4866\begin{itemize}
    … …  
    5472
    5573
    56 \subsection*{Systom configuration}
     74\section{System configuration}
    5775
    5876
    … …  
    6381(similar for Linux....)
    6482
    65 In addition the root directory for all anuga/inundation modules must be on the pythonpath, e.g.\
     83In addition the root directory for all anuga/inundation modules must be on
     84the pythonpath, e.g.\
    6685\begin{verbatim}
    6786PYTHONPATH=V:\1\cit\risk_assessment_methods_project\inundation\sandpits\onielsen\anuga\inundation
    6887\end{verbatim}   
    69 
    70  
     88 
    7189 
    7290
    7391
    7492
    75 \subsection*{Installation}
     93\section{Installation}
    7694
    7795(Explain how to check out from svn or obtain from elsewhere)
    7896
    7997
    80 In directory inundation, run the compilation script:
     98In the ANUGA root directory, run the compilation script:
    8199{\small \begin{verbatim}
    82100  python compile_all.py
    … …  
    87105\subsection{Testing}
    88106
    89 
    90 In directory inundation, run the test suite:
     107In the ANUGA root directory, run the test suite:
    91108{\small \begin{verbatim}
    92109  python test_all.py
    … …  
    99116
    100117\begin{verbatim}
    101 Install tortoise from downloads (IT`s didnt integrate wih explorer).
     118Install tortoise from downloads (ITs didn't integrate wih explorer).
    102119In settings set proxy to proxy.agso.gov.au  8080
    103120
    … …  
    111128
    112129
     130
    113131\end{document}

  • TabularUnified documentation/user_manual/anuga_user_manual.tex

    r2374 r2377  
    2121}
    2222
    23 \date{2 February, 2006}         % update before release!
     23%Draft date
     24\date{\today}                   % update before release!
    2425                                % Use an explicit date so that reformatting
    2526                                % doesn't cause a new date to be used.  Setting
Note: See TracChangeset for help on using the changeset viewer.