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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 3300 by jfenwick, Mon Oct 25 00:22:14 2010 UTC revision 3331 by caltinay, Mon Nov 1 05:21:18 2010 UTC
# Line 14  Line 14 
14  \section{Changes from previous releases}  \section{Changes from previous releases}
15  \label{app:changes}  \label{app:changes}
16    
17    %\subsection*{3.1 to 3.2}
18    
19  \subsection*{3.0 to 3.1}  \subsection*{3.0 to 3.1}
20  \begin{itemize}  \begin{itemize}
21  \item{The \emph{escript} launcher has been renamed to \emph{run-escript} the old-name will still work in this version  \item The \emph{escript} launcher has been renamed to \emph{run-escript}. The
22  but will be removed in future.}      old name will still work in this version but will be removed in the future.
23  \item Lazy evaluation features have been improved and documented (See Section~\ref{sec:lazy}).  \item Lazy evaluation features have been improved and documented (see \Sec{sec:lazy}).
24   \item Escript documentation includes a new Cookbook which demonstrates how to solve sample problems using escript.  \item The \emph{escript} documentation now includes a new Cookbook which
25        demonstrates how to solve sample problems using escript.
26  \item Macro elements have been introduced.  \item Macro elements have been introduced.
27  \item The saveDataCSV method allows one or more Data objects to be exported in CSV format.  \item The \var{saveDataCSV} method allows one or more \Data objects to be
28  \item Data objects can be populated by interpolating from a values in a table.      exported in CSV format (see \Sec{sec:savedatacsv}).
29  \item The new getInfLocator and getSupLocator functions in esys.escript.pdetools return Locators to a minimal/maximal point over the data.  \item \Data objects can be populated by interpolating from values in a table.
30  \item There is a new class to model fault systems (esys.escript.faultsystems.FaultSystem).  \item The new \var{getInfLocator} and \var{getSupLocator} functions in
31        \pdetools return Locators to a minimal/maximal point over the
32        data.
33    \item There is a new class to model fault systems (\var{esys.escript.faultsystems.FaultSystem}).
34  \item A beta version of an Algebraic Multigrid (AMG) solver is included.  \item A beta version of an Algebraic Multigrid (AMG) solver is included.
35  \item Inverting square matricies larger than 3x3 is now permitted if escript is compiled with Lapack support.  \item Inverting square matrices larger than 3x3 is now permitted if escript is
36  \item If escript is compiled with a modern compiler, then inf/sup/Lsup will now report NaN, +/-inf as appropriate if those values appear in the data.      compiled with Lapack support.
37    \item If escript is compiled with a modern compiler, then inf/sup/Lsup will now
38        report NaN, +/-inf as appropriate if those values appear in the data.
39  \item Data.setTags will take tag names as well as tag numbers.  \item Data.setTags will take tag names as well as tag numbers.
40  \item The Scalar, Vector, Tensor, Tensor3, Tensor4 factory methods can now take array/nested sequence like objects as their initial values.  \item The Scalar, Vector, Tensor, Tensor3, Tensor4 factory methods can now take
41        arrays/nested sequence like objects as their initial values.
42  \item escript.util.mkDir can now take a list of directories to create.  \item escript.util.mkDir can now take a list of directories to create.
43  \item Behind the scenes, python docstrings have been rewritten from epydoc to restructured text.  \item Behind the scenes, \PYTHON docstrings have been rewritten from epydoc to
44        restructured text.
45  \item Various other bug fixes and performance tweaks.  \item Various other bug fixes and performance tweaks.
46  \end{itemize}  \end{itemize}
47    
   
48  \subsection*{2.0 to 3.0}  \subsection*{2.0 to 3.0}
49  \begin{itemize}  \begin{itemize}
50  \item The major change here was replacing \module{numarray} with \numpy.  \item The major change here was replacing \module{numarray} with \numpy.
51  For general instructions on converting scripts to use numpy see \url{http://www.stsci.edu/resources/software_hardware/numarray/numarray2numpy.pdf}.  For general instructions on converting scripts to use numpy see \url{http://www.stsci.edu/resources/software_hardware/numarray/numarray2numpy.pdf}.
52  The specific changes to \escript are:  The specific changes to \escript are:
53  \begin{itemize}   \begin{itemize}
54    \item getValueOfDataPoint() which returned a \module{numarray}.array has been replaced by    \item getValueOfDataPoint() which returned a \module{numarray}.array has been
55   getTupleForDataPoint() which returns a \PYTHON tuple containing        replaced by getTupleForDataPoint() which returns a \PYTHON tuple
56  the components of the data point. In the case of matricies or higher ranked data, the tuples will be nested. Use        containing the components of the data point. In the case of matrices or
57  \numpy.array(data.getTupleForDataPoint()) if a \numpyNDA object is required.        higher ranked data, the tuples will be nested.
58   \item getValueOfGlobalDataPoint has similarly been replaced by getTupleForGlobalDataPoint().        Use \numpy.array(data.getTupleForDataPoint()) if a \numpyNDA object is
59   \item integrate(data) now returns a \numpyNDA instead of a \module{numarray}.array.        required.
60  \end{itemize}    \item getValueOfGlobalDataPoint() has similarly been replaced by
61  Any python methods which previously accepted \module{numarray} objects will accept \numpy objects instead.        getTupleForGlobalDataPoint().
62      \item \code{integrate(data)} now returns a \numpyNDA instead of a
63  \item        \module{numarray}.array.
64  The way solver options are defined for \LinearPDE objects has been changed. There is now a \SolverOptions object attached to the \LinearPDE object which is handeling the options of solvers used to solve the PDE. The following changes apply:     \end{itemize}
65  \begin{itemize}  Any python methods which previously accepted \module{numarray} objects now
66  \item The \method{setTolerance} and \method{setAbsoluteTolerance} methods have been removed. Instead use  accept \numpy objects instead.
67  \method{setTolerance} and \method{setAbsoluteTolerance} on the \SolverOptions object.  
68  For example: \method{getSolverOptions().setTolerance(\ldots)}  \item The way to define solver options for \LinearPDE objects has changed.
69        There is now a \SolverOptions object attached to the \LinearPDE
70        object which handles the options of solvers used to solve the PDE.
71  \item The \method{setSolverPackage} and \method{setSolverMethod} methods have been removed.      The following changes apply:  
72  Instead use the methods \method{setPackage}, \method{setSolverMethod} and \method{setPreconditioner}.   \begin{itemize}
73  For example: getSolverOptions().setPackage(\ldots).    \item The \method{setTolerance} and \method{setAbsoluteTolerance} methods
74          have been removed. Instead use \method{setTolerance} and
75  \item The static class variables defining packages, solvers and preconditioners have been removed and are now accessed via the corresponding  static class variables in \SolverOptions. For instance use \method{SolverOptions.PCG} instead of        \method{setAbsoluteTolerance} on the \SolverOptions object. For example:
76  \method{LinearPDE.PCG} to select the preconditioned conjugate gradient method.        \method{getSolverOptions().setTolerance(\ldots)}
77      \item The \method{setSolverPackage} and \method{setSolverMethod} methods have
78  \item The \method{getSolution} takes now no argument. Use the corresponding        been removed. Instead use the methods \method{setPackage},
79  methods of the \SolverOptions object returned by \method{getSolverOptions()}        \method{setSolverMethod} and \method{setPreconditioner}. For example:
80  to set values,\\ e.g. use        getSolverOptions().setPackage(\ldots).
81  \method{getSolverOptions().setVerbosityOn()} instead of argument \code{verbose=True}    \item The static class variables defining packages, solvers and
82  and \method{getSolverOptions().setIterMax(1000)} instead of argument \code{iter_max=1000}        preconditioners have been removed and are now accessed via the
83  \end{itemize}        corresponding static class variables in \SolverOptions.
84          For instance use \method{SolverOptions.PCG} instead of
85  \item        \method{LinearPDE.PCG} to select the preconditioned conjugate gradient
86  The \pyvisi module from previous releases has been deprecated and will no longer be supported.        method.
87  It is still present in the source code and can still be used if you compile \escript from source.    \item The \method{getSolution} now takes no argument. Use the corresponding
88  It will not be available in binary releases.        methods of the \SolverOptions object returned by
89  Its use is discouraged.        \method{getSolverOptions()} to set values,\\ e.g. use
90  \emph{The documentation for \pyvisi is not available in this release.}        \method{getSolverOptions().setVerbosityOn()} instead of argument
91          \code{verbose=True} and \method{getSolverOptions().setIterMax(1000)}
92          instead of argument \code{iter_max=1000}.
93     \end{itemize}
94    
95    \item The \pyvisi module from previous releases has been deprecated and will no
96        longer be supported. It is still present in the source code and can be used
97        if you compile \escript from source. It will not be available in binary
98        releases and its use is discouraged.
99        \emph{The documentation for \pyvisi is not available in this release.}
100  % The documentation for \pyvisi can be found in Appendix~\ref{PYVISI CHAP}.  % The documentation for \pyvisi can be found in Appendix~\ref{PYVISI CHAP}.
   
101  \end{itemize}  \end{itemize}
102    

Legend:
Removed from v.3300  
changed lines
  Added in v.3331

  ViewVC Help
Powered by ViewVC 1.1.26