source: trunk/anuga_core/documentation/user_manual/anuga_whats_new.tex @ 7867

Last change on this file since 7867 was 7867, checked in by hudson, 12 years ago

User manual improvements.

File size: 10.0 KB
Line 
1\documentclass{manual}
2
3
4\title{ANUGA What's New}
5
6\author{Ole Nielsen}
7
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               
22\input{version} % Get version info - this file may be modified by
23                % update_anuga_user_manual.py - if not a dummy
24                % will be used.
25                               
26
27\makeindex          % tell \index to actually write the .idx file
28%\makemodindex          % If this contains a lot of module sections.
29
30
31
32\begin{document}
33\maketitle
34
35
36
37% This makes the contents more accessible from the front page of the HTML.
38\ifhtml
39\chapter*{Front Matter\label{front}}
40\fi
41
42
43
44
45\chapter{ANUGA release information}
46
47This document outlines major bug fixes and new functionality added to ANUGA between releases.
48These lists are not comprehensive and we refer to the TRAC system for a complete audit trail of changes made to ANUGA.
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:
53    \begin{itemize} 
54      \item \url{https://datamining.anu.edu.au/anuga/changeset/4669} through to
55      \item \url{https://datamining.anu.edu.au/anuga/changeset/4733}
56    \end{itemize}   
57\end{itemize}     
58
59The release names take the form
60\begin{verbatim}
61  XX-YY_ZZ.EXT
62\end{verbatim}
63where
64\begin{itemize}
65  \item \code{XX} is the name of the anuga component, e.g.
66  \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.
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\end{itemize}
71
72
73
74
75\chapter{Release notes}
76
77This chapter list main developments between releases. Small bug fixes,
78refactoring, documentation updates, style fixes are generally not reported
79here. Refer to the Subversion
80log (https://datamining.anu.edu.au/anuga/timeline) and closed tickets
81https://datamining.anu.edu.au/anuga/report/17) for all changes in ANUGA.
82
83\section{Bleeding Edge}
84
85Work on parallel ANUGA, Kinematic Viscosity, 1-D pipeflows and wind/pressure
86forcing terms. There is also activity in the area of viewers and installers.
87
88\section{Release Name: anuga-1.2beta, Date: June 2010}
89Breaks code compatibility with older ANUGA versions. Please see the ANUGA wiki for migration instructions.
90Simplified API, with more logical module locations and names.
91Support for internal boundaries and holes in meshes.
92Support for user-specified breaklines.
93Speed optimisations - fitting is around 25 percent faster.
94Various bug fixes - see trac.
95
96
97\section{Release Name: anuga-1.1beta\_7607, Date: 12 January 2010}
98Discarded obsolete variable 'z' in sww files. This commits ANUGA to the
99new viewer: \url{http://www.ausposdevelop.com.au/trac/anuga_viewer}.
100Small optimisations and cleaning
101Intoduced one-click Windows installer
102Updates on the parallel code.
103
104\section{Release Name: anuga-1.1beta\_7472, Date: 3 September 2009}
105
106Ability to store any quantity in the sww file either as static or
107time dependent. This allows for example storage of variable bed elevation
108and/or friction. See manual for details on set\_quantities\_to\_be\_stored.
109
110
111\section{Release Name: anuga-1.1beta\_7315, Date: 20 July 2009}
112
113ANUGA updated to work with Python 2.6
114Reference to new viewer in manual.
115
116
117
118\section{Release Name: anuga-1.1beta\_7302, Date: 6 July 2009}
119This is the first release of ANUGA based on the package Python-numpy.
120The reason for this upgrade is that the old package Numeric is
121no longer supported and doesn't work for some systems.
122See the installation guide for details regarding the new dependencies.
123
124
125\section{Release Name: anuga-1.0beta\_7163, Date: 9 June 2009}
126
127THIS IS THE LAST OFFICIAL RELEASE OF ANUGA BASED ON THE PYTHON NUMERIC PACKAGE.
128
129\begin{itemize}
130  \item Several optimisations. ANUGA now runs at least 10-15\% faster overall. See changesets 7143, 7136, 7105, 7034, 6840, 6737, 6703.
131  \item Culverts based on the Boyd method have been refactored and test suite added thanks to Rudy van Drie and Petar Milevski.
132  \item Added a special purpose boundary (AWI boundary) provide by Nils Goseberg.
133  \item Cleanup Cairns demo and introduced example of new method add\_quantity.
134\end{itemize}
135
136
137
138\section{Release Name: anuga-1.0beta\_6838, Date: 19 April 2009}
139\begin{itemize}
140  \item Implemented availability of average energy as well as flow
141  through cross-section at run-time (ticket:295)
142  \item Stored permutation from urs2sts in STS file (ticket:298)
143  \item Equipped File\_boundary and Field\_boundary with default boundary
144  conditions to allow modelling beyond time interval (ticket:293)
145  \item Allowed fitting to reuse ANUGA mesh saving memory and time.
146  \item Started new module anuga.interface containing common functions. In particular the new function create\_domain\_from\_regions (ticket:308 and changeset:6190) which can replace the old call to create\_mesh\_from\_regions followed by Domain. This not only simplifies domain creation, it also makes caching of this process water proof. This function has not yet been documented in the user manual.
147  \item Made evolve loop about 5\% faster due to optimisations in
148  changeset:6703 and changeset:6737.
149  \item Fixed tests that only failed on Windows.
150\end{itemize} 
151
152
153\section{Release Name: anuga-1.0beta\_5638, Date: 11 August 2008}
154
155\begin{itemize}
156  \item Better diagnostics for timestepping.
157  \item Implemented tracking of IP for data files bundled with ANUGA to ensure that all are legally OK to distribute.
158  \item Improved logging of model runs (screen_catcher and copy_code_files).
159  \item Refactored graphing of timeseries into extraction and plotting (see sww2timeseries and sww2cvs\_gauges).
160  \item Improved performance and memory management in generate mesh and  least squares fitting.
161  \item Simplified Quantity data structure.
162  \item Added more validation examples.
163  \item Function for automatically determining optimal smoothing parameter through cross validation (\code{get\_flow\_through\_cross\_section}, p 57 in the user manual)
164  \item Implemented better second order approximation through the option to use edge limiters along with second order Runge-Kutta timestepping.
165        This provides better accuracy in some cases (e.g. waves in deep water over long distances)
166  \item Made tight\_slope\_limiters the default.
167  \item Retired obsolete parameter beta_h
168  \item Added the Okada tsunami source model as an optional initial condition in ANUGA
169  \item Upgraded ANUGA to work with Python 2.5
170  \item New fileboundary (using NetCDF format with extension .sts) coupling for timeseries on a list of points.
171  \item Added new forcing terms for flood modelling capability: Rainfall, Inflow, Culverts, ... (See p 51-53)
172\end{itemize}   
173 
174 
175\section{Release Name: anuga-1.0beta\_4824, Date: 15 Nov 2007}
176
177\begin{itemize} 
178  \item Removal of obsolete Python code where (faster) C code exists.
179  \item Several updates in the documentation in response to postings.
180  \item Improved installation and compilation procedure.
181  \item Addressed excessive memory use in fitting (currently optional as it appears somewhat slower)
182\end{itemize} 
183
184
185\section{Release Name: anuga-1.0beta_4733, Date 12 Sep 2007}
186
187\begin{itemize} 
188  \item A number of optimisations making the evolution part of ANUGA about 40\% faster. See \url{https://datamining.anu.edu.au/anuga/ticket/135} for details.
189  The optimisations are
190  \begin{itemize} 
191     \item Dry cell exclusion from flux calculations and linear reconstruction of triangles.
192     This optimisation will be most effective in domains with large dry areas. 
193     \item Separation of functions into gateways and computational routines
194     \item Utilisation of static work arrays
195     \item A large number of minor optimisations
196  \end{itemize} 
197 
198  \item Obsolete code was cleared out.
199\end{itemize}   
200
201
202\section{Release Name: anuga-1.0beta_4669, Date 17 Aug 2007}
203\begin{itemize} 
204  \item Improved speed in set\_quantity
205  \item deprecated xya file format
206  \item general maintenance
207\end{itemize}   
208 
209\section{Release Name: anuga-1.0beta_4530, 4 June 2007}
210
211\section{Release Name: anuga-1.0beta_4492, 25 May 2007}
212
213\section{Release Name: anuga_1.0beta_4106, 20 Dec 2006}
214
215\begin{itemize} 
216  \item First public release of ANUGA - Hydrodynamic Modelling.
217\end{itemize} 
218Version 1.0beta is the first version for general use. It is considered as a beta release as we expect feedback and suggestions for improvement by the community.
219
220The minor release number (4106) is the revision number from Subversion and uniquely defines the exact version of ANUGA.
221
222
223\end{document}
Note: See TracBrowser for help on using the repository browser.