/[escript]/trunk/doc/user/changes.tex
ViewVC logotype

Annotation of /trunk/doc/user/changes.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3334 - (hide annotations)
Wed Nov 3 00:46:56 2010 UTC (8 years, 9 months ago) by jfenwick
File MIME type: application/x-tex
File size: 6112 byte(s)
Added 3.2 to changes page
1 jfenwick 2463
2     %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3     %
4 jfenwick 2881 % Copyright (c) 2009-2010 by University of Queensland
5 jfenwick 2463 % Earth Systems Science Computational Center (ESSCC)
6     % http://www.uq.edu.au/esscc
7     %
8     % Primary Business: Queensland, Australia
9     % Licensed under the Open Software License version 3.0
10     % http://www.opensource.org/licenses/osl-3.0.php
11     %
12     %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13    
14     \section{Changes from previous releases}
15     \label{app:changes}
16    
17 jfenwick 3334 \subsection*{3.1 to 3.2}
18     \begin{itemize}
19     \item The deprecated name for the launcher has been removed. To run scripts use \emph{run-escript} not \emph{escript}.
20     \item \module{esys.escript} is no longer automatically imported by importing \module{esys.finley}. You will need to import escript explicitly.
21     (All of our example scripts do this anyway.)
22     \item An experimental version of the new Dudley domain is now available.
23     \item Various bug fixes and optimisations.
24     \item New algorithms for gmsh support.
25     \item Improvements to the AMG solver.
26     \item Fixed compilation issues using netcdf.
27     \item Redesigned configuration files to make it easier to compile from source without finding the locations of all your libraries.
28     \item Expanded version of the escript cookbook.
29     \item Faster rendering of documentation.
30     \item Documentation is now hyperlinked.
31     \item New data export and checkpointing with the Weipa module.
32     \end{itemize}
33 caltinay 3331
34 jfenwick 2923 \subsection*{3.0 to 3.1}
35     \begin{itemize}
36 caltinay 3331 \item The \emph{escript} launcher has been renamed to \emph{run-escript}. The
37     old name will still work in this version but will be removed in the future.
38     \item Lazy evaluation features have been improved and documented (see \Sec{sec:lazy}).
39     \item The \emph{escript} documentation now includes a new Cookbook which
40     demonstrates how to solve sample problems using escript.
41 jfenwick 2923 \item Macro elements have been introduced.
42 caltinay 3331 \item The \var{saveDataCSV} method allows one or more \Data objects to be
43     exported in CSV format (see \Sec{sec:savedatacsv}).
44     \item \Data objects can be populated by interpolating from values in a table.
45     \item The new \var{getInfLocator} and \var{getSupLocator} functions in
46     \pdetools return Locators to a minimal/maximal point over the
47     data.
48     \item There is a new class to model fault systems (\var{esys.escript.faultsystems.FaultSystem}).
49 jfenwick 2923 \item A beta version of an Algebraic Multigrid (AMG) solver is included.
50 caltinay 3331 \item Inverting square matrices larger than 3x3 is now permitted if escript is
51     compiled with Lapack support.
52     \item If escript is compiled with a modern compiler, then inf/sup/Lsup will now
53     report NaN, +/-inf as appropriate if those values appear in the data.
54 jfenwick 2923 \item Data.setTags will take tag names as well as tag numbers.
55 caltinay 3331 \item The Scalar, Vector, Tensor, Tensor3, Tensor4 factory methods can now take
56     arrays/nested sequence like objects as their initial values.
57 jfenwick 2923 \item escript.util.mkDir can now take a list of directories to create.
58 caltinay 3331 \item Behind the scenes, \PYTHON docstrings have been rewritten from epydoc to
59     restructured text.
60 jfenwick 2923 \item Various other bug fixes and performance tweaks.
61     \end{itemize}
62    
63 jfenwick 2463 \subsection*{2.0 to 3.0}
64 gross 2474 \begin{itemize}
65     \item The major change here was replacing \module{numarray} with \numpy.
66 jfenwick 2463 For general instructions on converting scripts to use numpy see \url{http://www.stsci.edu/resources/software_hardware/numarray/numarray2numpy.pdf}.
67     The specific changes to \escript are:
68 caltinay 3331 \begin{itemize}
69     \item getValueOfDataPoint() which returned a \module{numarray}.array has been
70     replaced by getTupleForDataPoint() which returns a \PYTHON tuple
71     containing the components of the data point. In the case of matrices or
72     higher ranked data, the tuples will be nested.
73     Use \numpy.array(data.getTupleForDataPoint()) if a \numpyNDA object is
74     required.
75     \item getValueOfGlobalDataPoint() has similarly been replaced by
76     getTupleForGlobalDataPoint().
77     \item \code{integrate(data)} now returns a \numpyNDA instead of a
78     \module{numarray}.array.
79     \end{itemize}
80     Any python methods which previously accepted \module{numarray} objects now
81     accept \numpy objects instead.
82 jfenwick 2463
83 caltinay 3331 \item The way to define solver options for \LinearPDE objects has changed.
84     There is now a \SolverOptions object attached to the \LinearPDE
85     object which handles the options of solvers used to solve the PDE.
86     The following changes apply:
87     \begin{itemize}
88     \item The \method{setTolerance} and \method{setAbsoluteTolerance} methods
89     have been removed. Instead use \method{setTolerance} and
90     \method{setAbsoluteTolerance} on the \SolverOptions object. For example:
91     \method{getSolverOptions().setTolerance(\ldots)}
92     \item The \method{setSolverPackage} and \method{setSolverMethod} methods have
93     been removed. Instead use the methods \method{setPackage},
94     \method{setSolverMethod} and \method{setPreconditioner}. For example:
95     getSolverOptions().setPackage(\ldots).
96     \item The static class variables defining packages, solvers and
97     preconditioners have been removed and are now accessed via the
98     corresponding static class variables in \SolverOptions.
99     For instance use \method{SolverOptions.PCG} instead of
100     \method{LinearPDE.PCG} to select the preconditioned conjugate gradient
101     method.
102     \item The \method{getSolution} now takes no argument. Use the corresponding
103     methods of the \SolverOptions object returned by
104     \method{getSolverOptions()} to set values,\\ e.g. use
105     \method{getSolverOptions().setVerbosityOn()} instead of argument
106     \code{verbose=True} and \method{getSolverOptions().setIterMax(1000)}
107     instead of argument \code{iter_max=1000}.
108     \end{itemize}
109 gross 2474
110 caltinay 3331 \item The \pyvisi module from previous releases has been deprecated and will no
111     longer be supported. It is still present in the source code and can be used
112     if you compile \escript from source. It will not be available in binary
113     releases and its use is discouraged.
114     \emph{The documentation for \pyvisi is not available in this release.}
115     % The documentation for \pyvisi can be found in Appendix~\ref{PYVISI CHAP}.
116 gross 2474 \end{itemize}
117    

  ViewVC Help
Powered by ViewVC 1.1.26