source: anuga_core/documentation/user_manual/anuga_whats_new.tex @ 5511

Last change on this file since 5511 was 5511, checked in by ole, 16 years ago

Work on What's new document

File size: 6.4 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
77\section{Recent release}
78
79\begin{itemize}
80  \item Better diagnostics for timestepping.
81  \item Implemented tracking of IP for data files bundled with ANUGA to ensure that all are legally OK to distribute.
82  \item Improved logging of model runs (screen_catcher and copy_code_files).
83  \item Refactored graphing of timeseries into extraction and plotting (see sww2timeseries and sww2cvs_gauges).
84  \item Fixed memory issues in meshing and improved performance of least squares fitting.
85  \item Simplified Quantity data structure.
86  \item Added more validation examples.
87  \item Function for automatically determining optimal smoothing parameter through cross validation (\code{get\_flow\_through\_cross\_section}, p 57 in the user manual)
88  \item Implemented better second order approximation through the option to use edge limiters along with second order Runge-Kutta timestepping.
89        This provides better accuracy in some cases (e.g. waves in deep water over long distances)
90  \item Made tight_slope_limiters the default.
91  \item Retired obsolete parameter beta_h
92  \item Added the Okada tsunami source model as an optional initial condition in ANUGA
93  \item Upgraded ANUGA to work with Python 2.5
94  \item New fileboundary (using NetCDF format with extension .sts) coupling for timeseries on a list of points. (not yet documented)
95  \item Added new forcing terms for flood modelling capability: Rainfall, Inflow, Culverts, ... (See p 51-53)
96\end{itemize}   
97 
98 
99\section{Release Name: anuga-1.0beta\_4824, Date: 15 Nov 2007}
100
101\begin{itemize} 
102  \item Removal of obsolete Python code where (faster) C code exists.
103  \item Several updates in the documentation in response to postings.
104  \item Improved installation and compilation procedure.
105  \item Addressed excessive memory use in fitting (currently optional as it appears somewhat slower)
106\end{itemize} 
107
108
109\section{Release Name: anuga-1.0beta_4733, Date 12 Sep 2007}
110
111\begin{itemize} 
112  \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.
113  The optimisations are
114  \begin{itemize} 
115     \item Dry cell exclusion from flux calculations and linear reconstruction of triangles.
116     This optimisation will be most effective in domains with large dry areas. 
117     \item Separation of functions into gateways and computational routines
118     \item Utilisation of static work arrays
119     \item A large number of minor optimisations
120  \end{itemize} 
121 
122  \item Obsolete code was cleared out.
123\end{itemize}   
124
125
126\section{Release Name: anuga-1.0beta_4669, Date 17 Aug 2007}
127\begin{itemize} 
128  \item Improved speed in set\_quantity
129  \item deprecated xya file format
130  \item general maintenance
131\end{itemize}   
132 
133\section{Release Name: anuga-1.0beta_4530, 4 June 2007}
134
135\section{Release Name: anuga-1.0beta_4492, 25 May 2007}
136
137\section{Release Name: anuga_1.0beta_4106, 20 Dec 2006}
138
139\begin{itemize} 
140  \item First public release of ANUGA - Hydrodynamic Modelling.
141\end{itemize} 
142Version 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.
143
144The minor release number (4106) is the revision number from Subversion and uniquely defines the exact version of ANUGA.
145
146
147\end{document}
Note: See TracBrowser for help on using the repository browser.