Changeset 7951
- Timestamp:
- Aug 18, 2010, 1:46:51 PM (15 years ago)
- Location:
- trunk/anuga_core/documentation/user_manual
- Files:
-
- 7 edited
-
anuga_installation_guide.tex (modified) (5 diffs)
-
anuga_user_manual.pdf (modified) (previous)
-
anuga_user_manual.tex (modified) (6 diffs)
-
anuga_whats_new.tex (modified) (6 diffs)
-
copyright.tex (modified) (5 diffs)
-
update_anuga_user_manual.py (modified) (6 diffs)
-
version.tex (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
-
trunk/anuga_core/documentation/user_manual/anuga_installation_guide.tex
r7527 r7951 3 3 \title{ANUGA Installation Guide} 4 4 5 %\author{Ole Nielsen, Duncan Gray, Jane Sexton}6 7 5 \usepackage{graphicx} 8 6 \usepackage{hyperref} 9 7 10 8 % Please at least include a long-lived email address; 11 9 % the rest is at your discretion. 12 10 \authoraddress{Geoscience Australia \\ 13 Email: \email{ nariman.habili@ga.gov.au}11 Email: \email{anuga@ga.gov.au} 14 12 } 15 13 … … 56 54 \label{sec:requirements} 57 55 58 To run ANUGA you will need a Windows PC (XP or Vista) or a Linux PC with at56 To run ANUGA you will need a Windows PC (XP, Vista or 7) or a Linux PC with at 59 57 least 512MB RAM. As ANUGA is a memory-intensive numerical system, more memory is better than less. 60 58 … … 76 74 \section{Installation} 77 75 78 Below are the install procedures for Windows XP, Windows Vista (both32 bit) and Linux (32 and 64 bit).76 Below are the install procedures for Windows XP, Windows Vista, Windows 7 (all 32 bit) and Linux (32 and 64 bit). 79 77 80 78 \subsection{Quick install - Windows XP (32 bit)} … … 90 88 run the test suite (optional) and then run a series of validation examples (optional). This may take some time. 91 89 Try the demonstrations provided in the ANUGA directory \code{anuga\_demos} (discussed in the ANUGA user manual at 92 \url{http ://datamining.anu.edu.au/\%7Eole/anuga/user\%5Fmanual/anuga\%5Fuser\%5Fmanual.pdf})90 \url{https://datamining.anu.edu.au/anuga/attachment/wiki/WikiStart/anuga_user_manual-1.2.0.pdf}) 93 91 and view the resulting \code{.sww} files with the ANUGA viewer. 94 92 95 %This procedure assumes that you do not have python installed on the target machine.96 %If you do have a python installed already then skip the installation of python as97 %long as you have version 2.5 or later installed.98 %99 %\begin{itemize}100 % \item Install the support software, in order.101 % \begin{enumerate}102 % \item Execute \code{python-2.5.4.msi} to install python.103 %104 % \item Install MinGW from \code{MinGW-5.1.4.exe}. Install components:105 % \begin{enumerate}106 % \item MinGW base tools107 % \item g++ compiler108 % \item MinGW Make109 % \end{enumerate}110 % Note that you will need an internet connection for the above install.111 %112 % \item Execute \code{numpy-1.3.0-win32-superpack-python2.5.exe} to install numpy.113 %114 % \item Execute \code{netCDF_binary_4.0.exe} to install NetCDF.115 %116 % \item Execute \code{ScientificPython-2.9.0.win32-py2.5.exe} to install Scientific Python.117 %118 % \item Execute \code{matplotlib-0.98.5.2.win32-py2.5.exe} to install matplotlib.119 % \end{enumerate}120 %121 % \item Add the following to the end of the PATH environment variable:122 % \begin{verbatim};C:\Python25;C:\MingW\bin;C:\netcdf4\bin\end{verbatim}123 % For details on how to do this under Windows please refer to Appendix \ref{sec:setwindowspath}.124 %\end{itemize}125 %126 %\subsubsection{ANUGA Installation}127 %\label{sec:ANUGA}128 %129 %\begin{itemize}130 % \item Unpack the ANUGA source code (\code{anuga-1.0_xxxx.tgz})\footnote{Internet Explorer has the habit of renaming the .tgz files to .gz -131 % the remedy is to rename them back or use another browser such as Firefox.}132 % in the python site-packages directory \code{C:$\backslash$Python25$\backslash$Lib$\backslash$site-packages}.133 % This is often done in Windows by double clicking on the \code{.tgz} file and then 'browse to' the destination directory.134 %135 % \item In the ANUGA root directory (\code{C:$\backslash$Python25$\backslash$Lib$\backslash$site-packages$\backslash$anuga}),136 % run the compilation script (either from the commandline or by running it in IDLE):137 % \begin{verbatim}python compile_all.py\end{verbatim}138 %139 % \item In the ANUGA root directory (\code{C:$\backslash$Python25$\backslash$Lib$\backslash$site-packages$\backslash$anuga}),140 % run the test suite (either from the commandline or by running it in IDLE):141 % \begin{verbatim}python test_all.py\end{verbatim} ANUGA has been succesfully installed if the tests pass.142 %143 % \item To verify that ANUGA succesfully reproduces a series of validation examples, go144 % to the directory145 % \linebreak146 % \code{anuga_validation$\backslash$automated_validation_tests} under the ANUGA root directory where you can run:147 % \begin{verbatim}python validate_all.py\end{verbatim}148 % This may take some time.149 %150 % \item To install the ANUGA viewer:151 % \begin{enumerate}152 % \item Unpack the distribution (\code{anuga_viewer_1.0.tgz}) into:153 % \begin{verbatim}C:\Program Files\end{verbatim}154 %155 % \item Double click on the test file:156 % \begin{verbatim}C:\Program Files\anuga_viewer\cylinders.sww\end{verbatim}157 %158 % \item Associate \code{.sww} files with the executable:159 % \begin{verbatim}C:\Program Files\anuga_viewer\animate.exe\end{verbatim}160 % For details on how to do this under Windows please refer to Appendix \ref{sec:assocanimatesww}.161 % \end{enumerate}162 %163 % Try the demonstrations provided in the ANUGA directory \code{anuga\_demos}164 % (discussed in the ANUGA user manual at165 % \url{http://datamining.anu.edu.au/\%7Eole/anuga/user\%5Fmanual/anuga\%5Fuser\%5Fmanual.pdf})166 % and view the resulting \code{.sww} files with the ANUGA viewer.167 %\end{itemize}168 93 169 94 … … 177 102 %details. 178 103 179 \subsection{Quick install - Windows Vista }104 \subsection{Quick install - Windows Vista and 7} 180 105 \label{sec:winvista} 181 106 182 107 The installation of the support software and the ANUGA software should be the same as for Windows XP above. 183 The installation and use of ANUGA under Windows Vista hasnot been heavily tested. Feedback on any aspect184 of using ANUGA under Vista is welcomed.108 The installation and use of ANUGA under Windows Vista and 7 have not been heavily tested. Feedback on any aspect 109 of using ANUGA under Vista or 7 is welcomed. 185 110 186 111 \subsection{Quick install - Linux} 187 112 \label{sec:linux} 188 113 189 The procedure to install onto a Linux platform is targetted at a Debian-like Linux, such as Ubuntu. 190 If you use another Linux the overall procedure should be followed, although the details will vary. 191 192 The steps below assume that you do not have python installed on the target machine. 193 If you do have a python installed already then skip the installation of python as 194 long as you have version 2.5 or later. 195 196 Note that even if you already have python installed you should still check if things like 197 \code{python-dev} and \code{python-profiler} need to be installed. 198 199 \subsubsection{Support Software - Linux 32 bit} 200 \label{sec:linux32bit} 201 202 Install support software (in order): 203 \begin{enumerate} 204 \item Install the python development environment, either through Synaptic or by: 205 \begin{verbatim}sudo apt-get install python python-dev python-profiler\end{verbatim} 206 If you already have python 2.5 or later installed, don't include \code{python} above. 207 208 \item Install g++, either through Synaptic or by: 209 \begin{verbatim}sudo apt-get install g++\end{verbatim} 210 211 \item Install the numpy package, either through Synaptic or by: 212 \begin{verbatim}sudo apt-get install python-numpy\end{verbatim} 213 214 \item Install the NetCDF package from the .tar.gz file: 215 \begin{verbatim}tar xzf netcdf.tar.gz 216 cd netcdf-4.0.1 217 ./configure 218 make check 219 sudo make install 220 cd\end{verbatim} 221 222 \item Install the ScientificPython package from the .tar.gz file: 223 \begin{verbatim}tar xzf ScientificPython-2.9.0.tar.gz 224 cd ScientificPython-2.9.0 225 python setup.py build --numpy 226 sudo python setup.py install 227 cd\end{verbatim} 228 229 \item Install matplotlib, either through Synaptic or by: 230 \begin{verbatim}sudo apt-get install python-matplotlib\end{verbatim} 231 \end{enumerate} 232 233 \subsubsection{Support Software - Linux 64 bit} 234 \label{sec:linux64bit} 235 236 Install support software (in order): 237 \begin{enumerate} 238 \item Install the python development environment, either through Synaptic or by: 239 \begin{verbatim}sudo apt-get install python python-dev python-profiler\end{verbatim} 240 If you already have python 2.5 or later installed, don't include \code{python} above. 241 242 \item Install g++, either through Synaptic or by: 243 \begin{verbatim}sudo apt-get install g++\end{verbatim} 244 245 \item Define a CFLAGS value: 246 \begin{verbatim}export CFLAGS=-fPIC\end{verbatim} 247 248 \item Install the numpy package, either through Synaptic or by: 249 \begin{verbatim}sudo apt-get install python-numpy\end{verbatim} 250 251 \item Install the NetCDF package from the .tar.gz file: 252 \begin{verbatim}tar xzf netcdf.tar.gz 253 cd netcdf-4.0.1 254 ./configure 255 make check 256 sudo make install 257 cd\end{verbatim} 258 259 \item Install the ScientificPython package from the .tar.gz file: 260 \begin{verbatim}tar xzf ScientificPython-2.9.0.tar.gz 261 cd ScientificPython-2.9.0 262 python setup.py build --numpy 263 sudo python setup.py install 264 cd\end{verbatim} 265 266 \item Install matplotlib, either through Synaptic or by: 267 \begin{verbatim}sudo apt-get install python-matplotlib\end{verbatim} 268 \end{enumerate} 269 270 \subsubsection{ANUGA Installation - 32 or 64 bit} 271 \label{sec:ANUGA32-64bit} 272 273 \begin{enumerate} 274 \item Get the ANUGA source from \url{http://sourceforge.net/projects/anuga} (\code{anuga-1.0_5789.tgz} say), 275 and expand it into the python site-packages directory \code{/usr/lib/python2.5/site-packages}. 276 In the unpacked ANUGA directory \code{/usr/lib/python2.5/site-packages/anuga} run the command: 277 \begin{verbatim}sudo python compile_all.py\end{verbatim} 278 279 \item In the ANUGA root directory (\code{/usr/lib/python2.5/site-packages/anuga}) 280 run the test suite: 281 \begin{verbatim}python test_all.py\end{verbatim} ANUGA has been succesfully installed if the tests pass. 282 283 \item To verify that ANUGA succesfully reproduces a series of validation examples, go 284 to the directory 285 \linebreak 286 \code{/usr/lib/python2.5/site-packages/anuga_validation/automated_validation_tests} 287 where you can run validation tests to ensure the correct running of ANUGA: 288 \begin{verbatim}python validate_all.py\end{verbatim} 289 This may take some time. 290 \end{enumerate} 114 Please note that the following applies only to Ubuntu 10.04 (\"Lucid Lynx\"). We currently do not 115 support any other Linux distributions. 116 117 \subsubsection{Method 1} 118 119 Choose the appropriate deb package for your architecture, download and use the package installer to install. 120 121 i386: \url{https://sourceforge.net/projects/anuga/files/anuga_ubuntu_package/python-anuga_1.2.0-0ubuntu3_i386.deb/download}\\ 122 AMD64: \url{https://sourceforge.net/projects/anuga/files/anuga_ubuntu_package/python-anuga_1.2.0-0ubuntu3_amd64.deb/download} 123 124 \subsubsection{Method 2} 125 126 Open a terminal and enter: 127 \begin{verbatim} 128 sudo add-apt-repository ppa:anuga/ppa 129 sudo apt-get update 130 sudo apt-get install python-anuga 131 \end{verbatim} 132 133 \subsubsection{Method 3} 134 135 Add the following lines to your \code{/etc/apt/sources.list}: 136 \begin{verbatim} 137 deb http://ppa.launchpad.net/anuga/ppa/ubuntu lucid main 138 deb-src http://ppa.launchpad.net/anuga/ppa/ubuntu lucid main 139 \end{verbatim} 140 Download the ANUGA key from \url{https://datamining.anu.edu.au/anuga/raw-attachment/wiki/WikiStart/anuga.key}. You can add this key with: 141 \begin{verbatim} 142 sudo apt-key add anuga.key 143 \end{verbatim} 144 or go to System -$>$ Administration -$>$ Software Sources -$>$ Authentication -$>$ Import Key File 145 146 Open a terminal and enter: 147 \begin{verbatim} 148 sudo apt-get update 149 sudo apt-get install python-anuga 150 \end{verbatim} 151 152 153 291 154 292 155 \section{Optional but recommended software} -
trunk/anuga_core/documentation/user_manual/anuga_user_manual.tex
r7848 r7951 28 28 29 29 \usepackage{graphicx} 30 \usepackage{hyperref} 30 31 \usepackage[english]{babel} 31 32 \usepackage{datetime} … … 49 50 % the rest is at your discretion. 50 51 \authoraddress{Geoscience Australia \\ 51 Email: \email{ nariman.habili@ga.gov.au}52 Email: \email{anuga@ga.gov.au} 52 53 } 53 54 … … 140 141 inundation software system, describe what it can do and give step-by-step 141 142 instructions for setting up and running hydrodynamic simulations. 142 The stable release of \anuga and this manual are available on sourceforge at i143 The stable release of \anuga and this manual are available on sourceforge at 143 144 \url{http://sourceforge.net/projects/anuga}. A snapshot of work in progress is 144 145 available through the \anuga software repository at 145 \url{https://datamining.anu.edu.au/svn/ ga/anuga_core}146 \url{https://datamining.anu.edu.au/svn/anuga/trunk/anuga_core/source/anuga} 146 147 where the more adventurous reader might like to go. 147 148 … … 158 159 159 160 The latest installation instructions may be found at: 160 \url{http ://datamining.anu.edu.au/\~{}ole/anuga/user_manual/anuga_installation_guide.pdf}.161 \url{https://datamining.anu.edu.au/anuga/attachment/wiki/WikiStart/anuga_installation_guide-1.2.0.pdf}. 161 162 162 163 \section{Audience} … … 165 166 its object oriented approach. 166 167 Python tutorials include 167 \url{http://docs.python.org/tut}, 168 \url{http://www.sthurlow.com/python}, and 169 %\url{http://datamining.anu.edu.au/\%7e ole/work/teaching/ctac2006/exercise1.pdf}. 170 \url{http://datamining.anu.edu.au/\~{}ole/work/teaching/ctac2006/exercise1.pdf}. 168 \url{http://docs.python.org/tut} and \url{http://www.sthurlow.com/python}. 171 169 172 170 Readers also need to have a general understanding of scientific modelling, … … 5092 5090 338:43--68, 1992. 5093 5091 5094 \bibitem {KurNP2001}5092 \bibitem[KurNP2001]{KurNP2001} 5095 5093 \newblock Semidiscrete central-upwind schemes for hyperbolic conservation laws 5096 5094 and hamilton-jacobi equations. -
trunk/anuga_core/documentation/user_manual/anuga_whats_new.tex
r7867 r7951 1 1 \documentclass{manual} 2 2 \usepackage{hyperref} 3 3 4 4 \title{ANUGA What's New} 5 5 6 \author{ Ole Nielsen}6 \author{Nariman Habili} 7 7 8 8 % Please at least include a long-lived email address; 9 9 % the rest is at your discretion. 10 10 \authoraddress{Geoscience Australia \\ 11 Email: \email{ ole.nielsen@ga.gov.au}11 Email: \email{anuga@ga.gov.au} 12 12 } 13 13 … … 48 48 These lists are not comprehensive and we refer to the TRAC system for a complete audit trail of changes made to ANUGA. 49 49 \begin{itemize} 50 \item Timeline of all changes to the code base: \url{https://datamining.anu.edu.au/anuga/timeline} 51 \item List of completed tasks ordered by last modification time\footnote{Last time a closed ticket was modified will normally correspond to the time it was resolved. However, it is possible that it could be modified after being closed. Refer to the ticket change history if in doubt.}: \url{https://datamining.anu.edu.au/anuga/report/17} 52 \item Changesets between two releases: To see all changes between version 4669 and 4733, for example, visit: 50 \item Timeline of all changes to the code base: https://datamining.anu.edu.au/anuga/timeline 51 \item Changesets between two releases: To see all changes between subversion versions 4669 and 4733, for example, visit: 53 52 \begin{itemize} 54 53 \item \url{https://datamining.anu.edu.au/anuga/changeset/4669} through to … … 59 58 The release names take the form 60 59 \begin{verbatim} 61 XX-YY_ZZ.EXT60 AA-BB.CC.DD.EXT 62 61 \end{verbatim} 63 62 where 64 63 \begin{itemize} 65 \item \code{ XX} is the name of the anuga component, e.g.64 \item \code{AA} is the name of the anuga component, e.g. 66 65 \code{anuga}, \code{anuga\_viewer}, \code{anuga\_installation\_guide} or \code{anuga\_user\_manual} 67 \item \code{YY} is the name of the major revision, e.g. 1.0beta, which is unlikely to change very often unless the code has undergone a major change. 68 \item \code{ZZ} is the Subversion revision number of this release. Every change to ANUGA causes the revision number to increment so this number uniquely identifies the version of ANUA. This is also known as the changeset number. 66 \item \code{BB} is the major revision number. The major revision number is unlikely to change very often unless the code has undergone a major change. 67 \item \code{CC} is the minor revision number. This number will increase when the code undergoes major bug fixes, changes to the interface, optimisation and the addition of minor features. 68 \item \code{DD} is the minor revision number. This number will increase when the code undergoes minor bug fixes. 69 69 \item \code{EXT} is the file name extension \code{tgz}\footnote{Internet explorer has the habit of renaming the .tgz files to .gz - the remedy is to rename them back or use another browser such as Firefox.} used for source code or \code{pdf} used for documentation. 70 70 \end{itemize} … … 79 79 here. Refer to the Subversion 80 80 log (https://datamining.anu.edu.au/anuga/timeline) and closed tickets 81 https://datamining.anu.edu.au/anuga/report/1 7) for all changes in ANUGA.81 https://datamining.anu.edu.au/anuga/report/10) for all changes in ANUGA. 82 82 83 83 \section{Bleeding Edge} … … 86 86 forcing terms. There is also activity in the area of viewers and installers. 87 87 88 \section{Release Name: anuga-1.2 beta, Date: June2010}88 \section{Release Name: anuga-1.2.0, Date: July 2010} 89 89 Breaks code compatibility with older ANUGA versions. Please see the ANUGA wiki for migration instructions. 90 90 Simplified API, with more logical module locations and names. … … 92 92 Support for user-specified breaklines. 93 93 Speed optimisations - fitting is around 25 percent faster. 94 Various bug fixes - see trac. 94 Various bug fixes - see trac. Note the new versioning system. 95 95 96 96 -
trunk/anuga_core/documentation/user_manual/copyright.tex
r7828 r7951 4 4 % This is the ANUGA User Manual 5 5 % 6 % Version 1.2 Ju ne, 20106 % Version 1.2 July, 2010 7 7 % 8 8 % 9 9 % 10 % Copyright 2004, 2005, 2010 11 % Stephen Roberts, Australian National University 12 % Ole Nielsen, Duncan Gray, Jane Sexton, Nick Bartzis, Geoscience Australia 10 % Copyright Commonwealth of Australia (Geoscience Australia) and the Australian 11 % National University 2004-2010. 13 12 % 14 13 % COPYRIGHT PAGE … … 19 18 \vspace*{0.5in} 20 19 21 Copyright \copyright 2004, 2005, 2006, 2010 Australian National University and Geoscience Australia. All rights reserved. 20 \copyright Commonwealth of Australia (Geoscience Australia) and the Australian 21 National University 2004-2010. 22 22 23 23 Permission to use, copy, modify, and distribute this software for any … … 29 29 software and in all copies of the supporting documentation for such 30 30 software. 31 This program is distributed in the hope that it will be useful, 31 32 32 This program is distributed in the hope that it will be useful,33 33 but WITHOUT ANY WARRANTY; without even the implied warranty of 34 34 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the … … 72 72 \textbf{Credits}: 73 73 \begin{itemize} 74 \item \anuga was developed and is maintained by Stephen Roberts,75 Ole Nielsen, Duncan Gray and Jane Sexton.74 \item \anuga was developed by Stephen Roberts, Ole Nielsen, Duncan Gray and Jane Sexton. It is currently being developed and 75 maintained by Nariman Habili and Stephen Roberts. 76 76 \index{ANUGA!credits|textit} 77 77 \end{itemize} … … 85 85 \textbf{Acknowledgments}: 86 86 \begin{itemize} 87 \item John Jakeman, Rudy van Drie, Ted Rigby, Petar Milevski, Joaquim Luis, Nils Goseberg, William Power, 87 \item Ole Nielsen, James Hudson, John Jakeman, Rudy van Drie, Ted Rigby, 88 Petar Milevski, Joaquim Luis, Nils Goseberg, William Power, 88 89 Trevor Dhu, Linda Stals, Matt Hardy, Jack Kelly and Christopher 89 90 Zoppou who contributed to this project at various times. 90 \item A stand alone visualiser (anuga\_viewer) based on Open-scene-graph was developed by Darran Edmundson .91 \item A stand alone visualiser (anuga\_viewer) based on Open-scene-graph was developed by Darran Edmundson and James Hudson. 91 92 \item The mesh generator engine was written by Jonathan Richard Shewchuk and made freely 92 93 available under the following license. See source code \code{triangle.c} for more -
trunk/anuga_core/documentation/user_manual/update_anuga_user_manual.py
r7189 r7951 41 41 from os.path import expanduser, split, join 42 42 from anuga.utilities.system_tools import get_revision_number, get_pathname_from_package 43 from anuga.config import major_revision43 from anuga.config import anuga_version 44 44 from sys import argv 45 45 … … 47 47 48 48 # Path for ANUGA 49 anugapath = get_pathname_from_package('anuga')49 #anugapath = get_pathname_from_package('anuga') 50 50 51 51 # Strip trailing source/anuga of path 52 basepath = split(split(anugapath)[0])[0]52 #basepath = split(split(anugapath)[0])[0] 53 53 54 54 # Add local path to user_manual 55 docpath = join(join(basepath, 'documentation'), 'user_manual')55 #docpath = join(join(basepath, 'documentation'), 'user_manual') 56 56 texfiles = ['anuga_user_manual', 57 57 'anuga_installation_guide', … … 59 59 'anuga_internal_tools'] 60 60 61 print 'Moving to', docpath62 chdir(docpath) # Move to location of LaTeX files61 #print 'Moving to', docpath 62 #chdir(docpath) # Move to location of LaTeX files 63 63 system('svn update') # Update from svn 64 64 … … 77 77 for line in fid.readlines(): 78 78 if line.startswith('\\release'): 79 try: 80 line = '\\release{%s\\_%d}\n' %(major_revision, 81 get_revision_number()) 82 except: 83 line = '\\release{%s}\n' %(major_revision) 79 line = '\\release{%s}\n' %(anuga_version) 84 80 85 81 lines.append(line) … … 115 111 116 112 # Clean-up 117 system('/bin/rm version.tex')113 #system('/bin/rm version.tex') 118 114 system('svn update') # Restore version file 119 115 … … 122 118 print 'User manual compiled' 123 119 124 print ' Major revision:', major_revision120 print 'Anuga version:', anuga_version 125 121 print 'Build:', get_revision_number() 126 122 system('date') -
trunk/anuga_core/documentation/user_manual/version.tex
r7804 r7951 7 7 % release version; this is used to define the 8 8 % \version macro 9 \release{1.2 beta\_6051}9 \release{1.2.0}
Note: See TracChangeset
for help on using the changeset viewer.
