Changeset 2329
- Timestamp:
- Feb 2, 2006, 6:32:07 PM (18 years ago)
- 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 1 9 %\newcommand{\code}[1]{{\small \tt #1}} %For use with one-line code snippets 2 10 3 \documentclass{report} 4 11 \documentclass{manual} 5 12 6 13 \title{AnuGA User Manual} 7 14 \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 8 36 9 37 % Can we get rid of indenting and put a blank line before each para? … … 11 39 % Relabel sections, subsections 12 40 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} 18 46 19 47 \begin{document} 20 48 \maketitle 21 49 50 % This makes the contents more accessible from the front page of the HTML. 51 \ifhtml 52 \chapter*{Front Matter\label{front}} 53 \fi 22 54 23 55 %Subversion keywords: … … 27 59 %$LastChangedBy: steve $ 28 60 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 32 66 allows users to model realistic flow problems in complex geometries. Examples include dam breaks or 33 67 the effects of natural hazards such as riverine flooding, storm surges and tsunami. … … 35 69 The user must specify a study area represented by a mesh of triangular 36 70 cells, the topography and bathymetry, frictional resistance, initial 37 values for water level (called {\emph{stage} within Anuga), boundary 71 values for water level (called \emph{stage}\index{stage} within Anuga), 72 boundary 38 73 conditions and forces such as windstress or pressure gradients if 39 74 applicable. … … 60 95 61 96 62 63 64 \subsection*{Purpose} 97 \end{abstract} 98 99 \tableofcontents 100 101 102 \chapter{Introduction} 103 104 105 \section{Purpose} 65 106 66 107 The purpose of this user manual is to introduce the new user to … … 68 109 instructions for setting up, configuring and running the software. 69 110 70 \s ubsection*{Scope}111 \section{Scope} 71 112 72 113 This manual covers only what is needed to operate the software … … 75 116 which will be covered in separate publications. 76 117 77 \s ubsection*{Audience}118 \section{Audience} 78 119 79 120 Readers are assumed to be familiar with the operating environment … … 83 124 understand the basic terminology of object-oriented programming. 84 125 85 \s ubsection*{Structure of This Manual}126 \section{Structure of This Manual} 86 127 87 128 This manual is structured as follows: … … 95 136 96 137 97 \pagebreak\section*{Getting Started} 138 \pagebreak 139 \chapter{Getting Started} 98 140 99 141 This section is designed to assist the reader to get started with … … 104 146 one it depicts. 105 147 106 \s ubsection*{Overview}148 \section{Overview} 107 149 108 150 This example carries out the solution of the shallow-water wave … … 125 167 present problem are: 126 168 \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} 131 173 \end{itemize} 132 174 133 175 %\emph{[More details of the problem background]} 134 176 135 \s ubsection*{Outline of the Program}177 \section{Outline of the Program} 136 178 137 179 In outline, \texttt{bedslope.py} performs the following steps: … … 156 198 \end{enumerate} 157 199 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 160 203 For 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' 162 205 that describes each step of the program and explains it significance. 163 206 … … 217 260 218 261 219 \s ubsection*{Establishing the Mesh}262 \section{Establishing the Mesh} 220 263 221 264 The first task is to set up the triangular mesh to be used for the … … 257 300 258 301 259 \s ubsection*{Initialising the domain}302 \section{Initialising the domain} 260 303 261 304 These variables are then used to set up a data structure … … 278 321 279 322 280 \s ubsection*{Specifying the Quantities}323 \section{Specifying the Quantities} 281 324 282 325 The next task is to specify a number of quantities that we wish to set … … 295 338 296 339 297 \subs ubsection*{Elevation}340 \subsection{Elevation} 298 341 299 342 The elevation is set using a function, defined through the … … 321 364 322 365 323 \subs ubsection*{Friction}366 \subsection{Friction} 324 367 325 368 The assignment of the friction quantity demonstrates another way … … 334 377 to 0.1 at every mesh point. 335 378 336 \subs ubsection*{Depth}379 \subsection{Depth} 337 380 338 381 Assigning depth illustrates a more complex way to use … … 351 394 elevation of the bed. 352 395 353 \subs ubsection*{Boundary Conditions}396 \subsection{Boundary Conditions} 354 397 355 398 The boundary conditions are specified as follows: … … 399 442 400 443 401 \s ubsection*{Evolution}444 \section{Evolution} 402 445 403 446 The final statement \nopagebreak[3] … … 416 459 417 460 418 \s ubsection*{Output}461 \section{Output} 419 462 420 463 %Give details here of the form of the output and explain how it can … … 426 469 427 470 428 \s ubsection*{How to Run the Code}471 \section{How to Run the Code} 429 472 430 473 The code can be run in various ways: … … 443 486 444 487 445 \pagebreak\section*{Glossary} 488 \appendix 489 \chapter{Glossary} 446 490 447 491 \begin{description} … … 522 566 \end{description} 523 567 568 The \code{\e appendix} markup need not be repeated for additional 569 appendices. 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 524 593 \end{document}
Note: See TracChangeset
for help on using the changeset viewer.