Changeset 2329


Ignore:
Timestamp:
Feb 2, 2006, 6:32:07 PM (18 years ago)
Author:
ole
Message:

Made use of Python manual documentclass

File:
1 edited

Legend:

Unmodified
Added
Removed

  • documentation/AnuGA_user_manual.tex

    r2328 r2329  
     1% Complete documentation on the extended LaTeX markup used for Python
     2% documentation is available in ``Documenting Python'', which is part
     3% of the standard documentation for Python.  It may be found online
     4% at:
     5%
     6%     http://www.python.org/doc/current/doc/doc.html
     7
     8
    19%\newcommand{\code}[1]{{\small \tt #1}} %For use with one-line code snippets
    210       
    3 \documentclass{report}
    4 
     11\documentclass{manual}
    512
    613\title{AnuGA User Manual}
    714\author{Howard Silcock, Ole Nielsen, Duncan Gray, Jane Sexton}
     15
     16% Please at least include a long-lived email address;
     17% the rest is at your discretion.
     18\authoraddress{Geoscience Australia \\
     19  Email: \email{ole.nielsen@ga.gov.au}
     20}
     21
     22\date{2 February, 2006}         % update before release!
     23                                % Use an explicit date so that reformatting
     24                                % doesn't cause a new date to be used.  Setting
     25                                % the date to \today can be used during draft
     26                                % stages to make it easier to handle versions.
     27
     28\release{1.0}                   % release version; this is used to define the
     29                                % \version macro
     30
     31\makeindex                      % tell \index to actually write the .idx file
     32%\makemodindex                  % If this contains a lot of module sections.
     33
     34
     35
    836
    937% Can we get rid of indenting and put a blank line before each para?
    … …  
    1139% Relabel sections, subsections
    1240
    13 \setlength{\parindent}{0mm} %\setlength{\parskip}{3pt}
    14 \setlength{\oddsidemargin}{0.6in}\setlength{\evensidemargin}{0.6in}
    15 \addtolength{\textheight}{1in} \addtolength{\textwidth}{0.5in}
    16 \setlength{\marginparwidth}{0in}
    17 \setlength{\topmargin}{0mm}\setlength{\headheight}{0in}
     41%\setlength{\parindent}{0mm} %\setlength{\parskip}{3pt}
     42%\setlength{\oddsidemargin}{0.6in}\setlength{\evensidemargin}{0.6in}
     43%\addtolength{\textheight}{1in} \addtolength{\textwidth}{0.5in}
     44%\setlength{\marginparwidth}{0in}
     45%\setlength{\topmargin}{0mm}\setlength{\headheight}{0in}
    1846
    1947\begin{document}
    2048\maketitle
    2149
     50% This makes the contents more accessible from the front page of the HTML.
     51\ifhtml
     52\chapter*{Front Matter\label{front}}
     53\fi
    2254
    2355%Subversion keywords:
    … …  
    2759%$LastChangedBy: steve $
    2860
    29 \section*{Introduction}
    30 
    31 \textbf{AnuGA} is a hydrodynamic modelling tool that
     61
     62\begin{abstract}
     63
     64\noindent
     65\textbf{AnuGA}\index{AnuGA} is a hydrodynamic modelling tool that
    3266allows users to model realistic flow problems in complex geometries. Examples include dam breaks or   
    3367the effects of natural hazards such as riverine flooding, storm surges and tsunami.
    … …  
    3569The user must specify a study area represented by a mesh of triangular
    3670cells, the topography and bathymetry, frictional resistance, initial
    37 values for water level (called {\emph{stage} within Anuga), boundary
     71values for water level (called \emph{stage}\index{stage} within Anuga),
     72boundary
    3873conditions and forces such as windstress or pressure gradients if
    3974applicable.
    … …  
    6095
    6196
    62 
    63 
    64 \subsection*{Purpose}
     97\end{abstract}
     98
     99\tableofcontents
     100
     101
     102\chapter{Introduction}
     103
     104
     105\section{Purpose}
    65106
    66107The purpose of this user manual is to introduce the new user to
    … …  
    68109instructions for setting up, configuring and running the software.
    69110
    70 \subsection*{Scope}
     111\section{Scope}
    71112
    72113This manual covers only what is needed to operate the software
    … …  
    75116which will be covered in separate publications.
    76117
    77 \subsection*{Audience}
     118\section{Audience}
    78119
    79120Readers are assumed to be familiar with the operating environment
    … …  
    83124understand the basic terminology of object-oriented programming.
    84125
    85 \subsection*{Structure of This Manual}
     126\section{Structure of This Manual}
    86127
    87128This manual is structured as follows:
    … …  
    95136
    96137
    97 \pagebreak\section*{Getting Started}
     138\pagebreak
     139\chapter{Getting Started}
    98140
    99141This section is designed to assist the reader to get started with
    … …  
    104146one it depicts.
    105147
    106 \subsection*{Overview}
     148\section{Overview}
    107149
    108150This example carries out the solution of the shallow-water wave
    … …  
    125167present problem are:
    126168\begin{itemize}
    127    \item elevation
    128    \item friction
    129    \item depth
    130    \item stage
     169   \item elevation\index{elevation}
     170   \item friction\index{friction}
     171   \item depth\index{depth}
     172   \item stage\index{stage}
    131173\end{itemize}
    132174
    133175%\emph{[More details of the problem background]}
    134176
    135 \subsection*{Outline of the Program}
     177\section{Outline of the Program}
    136178
    137179In outline, \texttt{bedslope.py} performs the following steps:
    … …  
    156198\end{enumerate}
    157199
    158 \subsection*{The Code}
    159 
     200\section{The Code}
     201
     202%FIXME: we are using the \code function here. This should be used whereever possible
    160203For reference we include below the complete code listing for
    161 \texttt{bedslope.py}. Subsequent paragraphs provide a `commentary'
     204\code{bedslope.py}. Subsequent paragraphs provide a `commentary'
    162205that describes each step of the program and explains it significance.
    163206
    … …  
    217260
    218261
    219 \subsection*{Establishing the Mesh}
     262\section{Establishing the Mesh}
    220263
    221264The first task is to set up the triangular mesh to be used for the
    … …  
    257300
    258301
    259 \subsection*{Initialising the domain}
     302\section{Initialising the domain}
    260303
    261304These variables are then used to set up a data structure
    … …  
    278321
    279322
    280 \subsection*{Specifying the Quantities}
     323\section{Specifying the Quantities}
    281324
    282325The next task is to specify a number of quantities that we wish to set
    … …  
    295338
    296339
    297 \subsubsection*{Elevation}
     340\subsection{Elevation}
    298341
    299342The elevation is set using a function, defined through the
    … …  
    321364
    322365
    323 \subsubsection*{Friction}
     366\subsection{Friction}
    324367
    325368The assignment of the friction quantity demonstrates another way
    … …  
    334377to 0.1 at every mesh point.
    335378
    336 \subsubsection*{Depth}
     379\subsection{Depth}
    337380
    338381Assigning depth illustrates a more complex way to use
    … …  
    351394elevation of the bed.
    352395
    353 \subsubsection*{Boundary Conditions}
     396\subsection{Boundary Conditions}
    354397
    355398The boundary conditions are specified as follows:
    … …  
    399442
    400443
    401 \subsection*{Evolution}
     444\section{Evolution}
    402445
    403446The final statement \nopagebreak[3]
    … …  
    416459
    417460
    418 \subsection*{Output}
     461\section{Output}
    419462
    420463%Give details here of the form of the output and explain how it can
    … …  
    426469
    427470
    428 \subsection*{How to Run the Code}
     471\section{How to Run the Code}
    429472
    430473The code can be run in various ways:
    … …  
    443486
    444487
    445 \pagebreak\section*{Glossary}
     488\appendix
     489\chapter{Glossary}
    446490
    447491\begin{description}
    … …  
    522566\end{description}
    523567
     568The \code{\e appendix} markup need not be repeated for additional
     569appendices.
     570
     571
     572%
     573%  The ugly "%begin{latexonly}" pseudo-environments are really just to
     574%  keep LaTeX2HTML quiet during the \renewcommand{} macros; they're
     575%  not really valuable.
     576%
     577%  If you don't want the Module Index, you can remove all of this up
     578%  until the second \input line.
     579%
     580
     581%begin{latexonly}
     582%\renewcommand{\indexname}{Module Index}
     583%end{latexonly}
     584%\input{mod\jobname.ind}                % Module Index
     585
     586%begin{latexonly}
     587\renewcommand{\indexname}{Index}
     588%end{latexonly}
     589\input{\jobname.ind}                    % Index
     590
     591
     592
    524593\end{document}
Note: See TracChangeset for help on using the changeset viewer.