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

Last change on this file since 5510 was 5510, checked in by ole, 14 years ago

Added What's new document and updated other documentation slightly.

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