Changeset 2422 for documentation


Ignore:
Timestamp:
Feb 16, 2006, 8:29:56 PM (19 years ago)
Author:
steve
Message:

Picked a few typos in user_manual

Location:
documentation/user_manual
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • documentation/user_manual/anuga_installation_guide.tex

    r2387 r2422  
    1414%Draft date
    1515\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.
     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.
    2020
    21 \release{1.0}                   % release version; this is used to define the
    22                                 % \version macro
     21\release{1.0}           % release version; this is used to define the
     22                % \version macro
    2323
    24 \makeindex                      % tell \index to actually write the .idx file
    25 %\makemodindex                  % If this contains a lot of module sections.
     24\makeindex          % tell \index to actually write the .idx file
     25%\makemodindex          % If this contains a lot of module sections.
    2626
    2727
    … …  
    4444This document outlines the required software for installing the Anuga toolbox.
    4545All components are licensed as open source and readily available from the net.
    46        
    47        
     46
     47
    4848\section{Pre-requisites}
    4949
    5050The Anuga software core (pyvolution, pmesh, least\_squares, ...) depends on the following:
    5151
    52 \begin{itemize} 
     52\begin{itemize}
    5353  \item python 2.3 or later \url{http://www.python.org}
    5454  \item python-numeric
    5555  \item python-dev (Interestingly, numeric seems to be installed as well)
    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 
     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
    5959    location somewhere on the system PATH - e.g.\ in C:\\bin)
    6060  \item A C compiler such as gcc (from GNU in case of Linux and MinGW in case of Windows)
    61 \end{itemize} 
    62        
    63        
     61\end{itemize}
     62
     63
    6464\section{Recommended software}
    6565
    66 \begin{itemize} 
     66\begin{itemize}
    6767  \item psyco \url{http://psyco.sourceforge.net/index.html}
    6868  \item visual python \url{http://vpython.org}
    6969  \item matplotlib (pylab) for quality 2d plotting
    70 \end{itemize} 
     70\end{itemize}
    7171
    7272
    … …  
    7575
    7676
    77 The system path on Win32 architectures must contain the directories 
    78 \begin{verbatim} 
    79   PATH=C:\Python24;C:\MinGW\bin;C:\Program Files\swollen
    80 \end{verbatim}   
     77The system path on Win32 architectures must contain the directories
     78\begin{verbatim}
     79  PATH=C:\Python23;C:\MinGW\bin;C:\Program Files\swollen
     80\end{verbatim}
    8181(similar for Linux....)
    8282
    83 In addition the root directory for all anuga/inundation modules must be on 
     83In addition the root directory for all anuga/inundation modules must be on
    8484the pythonpath, e.g.\
    85 \begin{verbatim} 
     85\begin{verbatim}
    8686PYTHONPATH=V:\1\cit\risk_assessment_methods_project\inundation\sandpits\onielsen\anuga\inundation
    87 \end{verbatim}   
    88  
    89  
     87\end{verbatim}
     88
     89
    9090
    9191
    … …  
    115115\section{Other stuff to be included}
    116116
    117 \begin{verbatim} 
     117\begin{verbatim}
    118118Install tortoise from downloads (ITs didn't integrate wih explorer).
    119119In settings set proxy to proxy.agso.gov.au  8080
    … …  
    123123
    124124
    125 \end{verbatim} 
    126  
     125\end{verbatim}
     126
    127127
    128128

  • documentation/user_manual/anuga_user_manual.tex

    r2413 r2422  
    99\input{definitions}
    1010
    11        
     11
    1212\documentclass{manual}
    1313
    … …  
    2323%Draft date
    2424\date{\today}                   % update before release!
    25                                 % Use an explicit date so that reformatting
    26                                 % doesn't cause a new date to be used.  Setting
    27                                 % the date to \today can be used during draft
    28                                 % stages to make it easier to handle versions.
    29 
    30 \release{1.0}                   % release version; this is used to define the
    31                                 % \version macro
    32 
    33 \makeindex                      % tell \index to actually write the .idx file
    34 %\makemodindex                  % If this contains a lot of module sections.
     25                % Use an explicit date so that reformatting
     26                % doesn't cause a new date to be used.  Setting
     27                % the date to \today can be used during draft
     28                % stages to make it easier to handle versions.
     29
     30\release{1.0}           % release version; this is used to define the
     31                % \version macro
     32
     33\makeindex          % tell \index to actually write the .idx file
     34%\makemodindex          % If this contains a lot of module sections.
    3535
    3636
    … …  
    6363The user must specify a study area represented by a mesh of triangular
    6464cells, the topography and bathymetry, frictional resistance, initial
    65 values for water level (called \emph{stage}\index{stage} within \anuga), 
     65values for water level (called \emph{stage}\index{stage} within \anuga),
    6666boundary
    6767conditions and forces such as windstress or pressure gradients if
    … …  
    194194\section{The Code}
    195195
    196 %FIXME: we are using the \code function here. 
     196%FIXME: we are using the \code function here.
    197197%This should be used whereever possible
    198198For reference we include below the complete code listing for
    … …  
    229229from math import sin, pi
    230230Br = Reflective_boundary(domain)
    231 Bt = Transmissive_boundary(domain) 
     231Bt = Transmissive_boundary(domain)
    232232Bd = Dirichlet_boundary([0.2,0.,0.])
    233233
    … …  
    257257
    258258{\small \begin{verbatim}
    259     points, vertices, boundary = rectangular(10, 10) 
     259    points, vertices, boundary = rectangular(10, 10)
    260260\end{verbatim}}
    261261
    … …  
    304304class of the same name in the module \code{domain}, and inherits
    305305some methods from the generic class but has others specific to the
    306 shallow-water scenarios in which it is used. Specific options for domain 
     306shallow-water scenarios in which it is used. Specific options for domain
    307307are set at this point. One of them are to set the basename for the output file
    308308
    … …  
    350350
    351351{\small \begin{verbatim}
    352 \begin{verbatim}
    353352    domain.set_quantity('elevation', f)
    354353\end{verbatim}}
    … …  
    482481
    483482The chief difference is in the method used to create the mesh. Instead of imposing a mesh
    484 structure on a rectangular grid, the technique used for this example involves building 
    485 mesh structures inside polygons. 
     483structure on a rectangular grid, the technique used for this example involves building
     484mesh structures inside polygons.
    486485
    487486In its simplest form, the mesh is created within a single polygon
    … …  
    512511
    513512
    514 \begin{itemize} 
    515 
    516   \item \indexedcode{create_mesh_from_region}: Create mesh based on a bounding polygon and a number of internal polygons. Each polygon has a maximal area of triangles associated with it - the resolution. The bounding polygon also has symbolic \code{tags} associated with it.   
    517   Arguments are: 
     513\begin{itemize}
     514
     515  \item \indexedcode{create_mesh_from_region}: Create mesh based on a bounding polygon and a number of internal polygons. Each polygon has a maximal area of triangles associated with it - the resolution. The bounding polygon also has symbolic \code{tags} associated with it.
     516  Arguments are:
    518517  \item \indexedcode{pmesh_to_domain_instance}: Convert generated mesh file to domain object. Arguments are: Mesh file name and class specifying which domain class to instantiate. (Simpler)
    519  
    520   \item \indexedcode{file_function} %in util.py "High priority" 
    521   \item \indexedcode{Interpolation_function} %In least_squares.py ("High priority") 
    522 
    523   \item \indexedcode{set_region} ``Low priority. Will be merged into set\_quantity'' 
     518
     519  \item \indexedcode{file_function} %in util.py "High priority"
     520  \item \indexedcode{Interpolation_function} %In least_squares.py ("High priority")
     521
     522  \item \indexedcode{set_region} ``Low priority. Will be merged into set\_quantity''
    524523  \item \indexedcode{set_quantity} ``Pretty mature''
    525524  \item \indexedcode{set_boundary} ``Pretty mature''
    526  
    527 \end{itemize} 
     525
     526\end{itemize}
    528527
    529528
    530529Diagnostics
    531 \begin{itemize} 
     530\begin{itemize}
    532531  \item \indexedcode{write_time}
    533532  \item \indexedcode{write_boundary_statistics}
    534  
    535 
    536 \end{itemize} 
     533
     534
     535\end{itemize}
    537536
    538537
    539538\subsection{Boundary conditions}
    540539
    541 ANUGA provides a large number of predefined boundary conditions to be used with 
     540ANUGA provides a large number of predefined boundary conditions to be used with
    542541\code{set_boundary}
    543542
    … …  
    545544How are they used
    546545
    547 \begin{itemize} 
     546\begin{itemize}
    548547  \item \indexedcode{Reflective_boundary}
    549548  function, arguments
    550  
     549
    551550  \item \indexedcode{Transmissive_boundary}
    552   function, arguments, CAVEATS 
    553  
     551  function, arguments, CAVEATS
     552
    554553  \item \indexedcode{Dirichlet_boundary}
    555  
    556   \item \indexedcode{Time_boundary} 
    557  
    558   \item \indexedcode{File_boundary}   
     554
     555  \item \indexedcode{Time_boundary}
     556
     557  \item \indexedcode{File_boundary}
    559558  Based on File\_function
    560  
    561   \item \indexedcode{}     
    562  
    563   \item \indexedcode{}       
    564  
    565  
     559
     560  \item \indexedcode{}
     561
     562  \item \indexedcode{}
     563
     564
    566565  \item \indexedcode{User defined boundary conditions.}
    567   How to roll your own     
    568  
    569  
    570 
    571 \end{itemize} 
     566  How to roll your own
     567
     568
     569
     570\end{itemize}
    572571
    573572
    … …  
    575574\subsection{Initial conditions}
    576575
    577 ANUGA provides a number of predefined initial conditions to be used with 
     576ANUGA provides a number of predefined initial conditions to be used with
    578577\code{set_quantity}.
    579578
    580 \begin{itemize} 
     579\begin{itemize}
    581580
    582581
    583582  \item \indexedcode{tsunami_slump}
    584583  function, arguments
    585  
     584
    586585  \item \indexedcode{}
    587586
    588 \end{itemize} 
     587\end{itemize}
    589588
    590589
    … …  
    593592ANUGA provides a number of predefined forcing functions to be used with .....
    594593
    595 \begin{itemize} 
     594\begin{itemize}
    596595
    597596
    598597  \item \indexedcode{}
    599598  function, arguments
    600  
     599
    601600  \item \indexedcode{}
    602601
    603 \end{itemize} 
     602\end{itemize}
    604603
    605604
    … …  
    629628
    630629DEMs, meshes and boundary conditions can have different origins within
    631 one UTM zone. However, the computation will use that of the mesh for 
     630one UTM zone. However, the computation will use that of the mesh for
    632631numerical stability.
    633632
    … …  
    683682\section{utilities/polygons} Could do now.
    684683
    685 \begin{itemize} 
    686   \item \indexedcode{polygon_function} 
    687   \item \indexedcode{read_polygon} 
    688   \item \indexedcode{populate_polygon} 
    689   \item \indexedcode{point_in_polygon} 
    690   \item \indexedcode{inside_polygon} 
    691   \item \indexedcode{outside_polygon} 
    692   \item \indexedcode{point_on_line} 
    693   \item \indexedcode{separate_points_by_polygon} 
    694 \end{itemize}   
    695  
     684\begin{itemize}
     685  \item \indexedcode{polygon_function}
     686  \item \indexedcode{read_polygon}
     687  \item \indexedcode{populate_polygon}
     688  \item \indexedcode{point_in_polygon}
     689  \item \indexedcode{inside_polygon}
     690  \item \indexedcode{outside_polygon}
     691  \item \indexedcode{point_on_line}
     692  \item \indexedcode{separate_points_by_polygon}
     693\end{itemize}
     694
    696695
    697696
    … …  
    709708\section{utilities/numerical_tools} Could do now.
    710709
    711 \begin{itemize} 
     710\begin{itemize}
    712711  \item \indexedcode{ensure_numeric}
    713712  \item \indexedcode{mean}
    714   \item 
    715 \end{itemize} 
     713  \item
     714\end{itemize}
    716715
    717716\chapter{Glossary}
    … …  
    719718\begin{itemize}
    720719    \item \indexedbold{ANUGA} name of software (joint development between ANU and GA)
    721    
    722     \item \indexedbold{Conserved quantity}   
     720
     721    \item \indexedbold{Conserved quantity}
    723722
    724723    \item \indexedbold{Default order} is this really needed?
    … …  
    741740
    742741    \item \indexedbold{Manning friction coefficient}
    743    
     742
    744743    \item \indexedbold{Mesh}    triangulation of domain
    745744
    … …  
    767766
    768767    \item \indexedbold{xmomentum} conserved quantity (note, two-dimensional SWW equations say only x and y and NOT z)
    769    
    770     \item \indexedbold{ymomentum}  conserved quantity 
     768
     769    \item \indexedbold{ymomentum}  conserved quantity
    771770
    772771    \item \indexedbold{resolution}   refers to the maximal area of each triangular cell in the mesh
    773    
     772
    774773    \item \indexedbold{polygon} A sequence of points in the plane. (Arbitrary polygons can be created in this way )
    775     ANUGA represents polygons as either a list of 2-tuples, where the latter are either Python tuples or Python lists of length 2. The unit square, for example, would be represented by the polygon [ [0,0], [1,0], [1,1], [0,1] ]. Alternatively, polygons can be represented as $N \times 2$ Numeric arrays, where $N$ is the number of points.       
    776    
     774    ANUGA represents polygons as either a list of 2-tuples, where the latter are either Python tuples or Python lists of length 2. The unit square, for example, would be represented by the polygon [ [0,0], [1,0], [1,1], [0,1] ]. Alternatively, polygons can be represented as $N \times 2$ Numeric arrays, where $N$ is the number of points.
     775
    777776    NOTE: More can be read in the module utilities/polygon.py ....
    778777
    779     \item \indexedbold{easting}   
    780 
    781     \item \indexedbold{northing}   
    782 
    783     \item \indexedbold{latitude}   
    784 
    785     \item \indexedbold{longitude}   
    786 
    787     \item \indexedbold{edge}   
    788 
    789     \item \indexedbold{vertex} 
    790  
    791     \item \indexedbold{finite volume} 
    792 
    793     \item \indexedbold{flux} 
    794 
    795     \item \indexedbold{Digital Elevation Model (DEM)}   
     778    \item \indexedbold{easting}
     779
     780    \item \indexedbold{northing}
     781
     782    \item \indexedbold{latitude}
     783
     784    \item \indexedbold{longitude}
     785
     786    \item \indexedbold{edge}
     787
     788    \item \indexedbold{vertex}
     789
     790    \item \indexedbold{finite volume}
     791
     792    \item \indexedbold{flux}
     793
     794    \item \indexedbold{Digital Elevation Model (DEM)}
    796795
    797796
    … …  
    814813%\renewcommand{\indexname}{Module Index}
    815814%end{latexonly}
    816 %\input{mod\jobname.ind}                % Module Index
     815%\input{mod\jobname.ind}        % Module Index
    817816
    818817%begin{latexonly}
    819818\renewcommand{\indexname}{Index}
    820819%end{latexonly}
    821 \input{\jobname.ind}                    % Index
     820\input{\jobname.ind}            % Index
    822821
    823822

  • documentation/user_manual/copyright.tex

    r2384 r2422  
    11%*************************************************
    2 %     LaTeX document 
    3 % 
     2%     LaTeX document
     3%
    44%  This is the ANUGA User Manual
    55%
    6 %  Version 1.0    February, 2006 
     6%  Version 1.0    February, 2006
    77%
    88%
    99%
    10 %  Copyright 2004, 2005, 2006 
     10%  Copyright 2004, 2005, 2006
    1111%  Stephen Roberts, Australian National University
    1212%  Ole Nielsen, Duncan Gray, Jane Sexton, Nick Bartzis, Geoscience Australia
    13 % 
     13%
    1414%  COPYRIGHT PAGE
    1515%
    … …  
    4444
    4545This work was produced at Geoscience Australia and the Australian
    46 National University funded by the Commonwealth of Australia.  Neither
     46National University funded by the Commonwealth of Australia. Neither
    4747the Australian Government, the Australian National University,
    48 Geoscience Australiaifornia nor any of their employees, makes any
    49 warranty, express or implied, or assumes any liability or
    50 responsibility for the accuracy, completeness, or usefulness of any
    51 information, apparatus, product, or process disclosed, or represents
    52 that its use would not infringe privately-owned rights. Reference
    53 herein to any specific commercial products, process, or service by
    54 trade name, trademark, manufacturer, or otherwise, does not
    55 necessarily constitute or imply its endorsement, recommendation, or
    56 favoring by the Australian Government, Geoscience Australia or the
    57 Australian National University.  The views and opinions of authors
    58 expressed herein do not necessarily state or reflect those of the
    59 Australian Government, Geoscience Australia or the
    60 Australian National University, and shall
    61 not be used for advertising or product endorsement purposes.
     48Geoscience Australia nor any of their employees, makes any warranty,
     49express or implied, or assumes any liability or responsibility for
     50the accuracy, completeness, or usefulness of any information,
     51apparatus, product, or process disclosed, or represents that its use
     52would not infringe privately-owned rights. Reference herein to any
     53specific commercial products, process, or service by trade name,
     54trademark, manufacturer, or otherwise, does not necessarily
     55constitute or imply its endorsement, recommendation, or favoring by
     56the Australian Government, Geoscience Australia or the Australian
     57National University.  The views and opinions of authors expressed
     58herein do not necessarily state or reflect those of the Australian
     59Government, Geoscience Australia or the Australian National
     60University, and shall not be used for advertising or product
     61endorsement purposes.
    6262
    6363
    64 This document does not convey a warranty, express or implied, 
    65 of merchantability or fitness for a particular purpose. 
     64This document does not convey a warranty, express or implied,
     65of merchantability or fitness for a particular purpose.
    6666
    6767
    … …  
    7676
    7777  \vspace{0.5in}
    78  
     78
    7979\textbf{Credits}:
    8080\begin{itemize}
    81 \item \anuga was developed by Stephen Roberts, 
     81\item \anuga was developed by Stephen Roberts,
    8282  Ole Nielsen, Duncan Gray, .....
    8383\end{itemize}
    … …  
    9191
    9292
    93  
     93
    9494\textbf{Acknowledgments}:
    9595\begin{itemize}
    96 \item Christopher Zoppou, Linda Stals, Matt Hardy, Jack Jakeman, John .. who contributed to this project at various times.
     96\item Christopher Zoppou, Linda Stals, Matt Hardy, Jack Kelly, John Jakeman, who contributed to this project at various times.
    9797\item A stand alone visualiser (Swollen viewer) based on Open-scene-graph by Darran Edmundson.
    9898\end{itemize}
    99        
    100 
    101                
    102 
    103  
Note: See TracChangeset for help on using the changeset viewer.