what's new

git-svn-id: svn+ssh://code.matforge.org/fipy/branches/documentation@5295 d80e17d7-ff13-0410-a124-85740d801063

INSTALLATION.txt

@@ -168,10 +168,8 @@ If necessary, you can download_ and install it for your platform
 .. note::
 
    :term:`FiPy` requires at least version 2.4.x of :term:`Python`. See
-   :ref:`RunningUnderPython3` for instructions on how to run
-   :term:`FiPy` with `Python 3.x`_.
+   the specialized instructions if you wish to :ref:`RunUnderPython3`.
 
-.. _Python 3.x:   http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://docs.python.org/py3k/
 .. _download: http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://www.python.org/download/
 
 :term:`Python` along with many of :term:`FiPy`'s required and optional

README.txt

@@ -54,12 +54,24 @@ necessary.
 
 The significant changes since version 2.1 are:
 
-- Tests can now be run on a full install using `fipy.test()`.
-- Grid classes now take an `Lx` argument. 
+- :ref:`CoupledEquations` are now supported.
+- A more robust mechanism for specifying :ref:`BoundaryConditions` is now 
+  used.
+- Most :class:`~fipy.meshes.mesh.Mesh`\es can be partitioned by 
+  :ref:`MeshingWithGmsh`.
+- "getter" and "setter" methods have been pervasively changed to Python 
+  properties.
+- :ref:`PYAMG` and :ref:`SCIPY` have been added to the :ref:`SOLVERS`.
+- FiPy can :ref:`RunUnderPython3`.
 - The functions of the :mod:`~fipy.tools.numerix` module are no longer 
   included in the :mod:`fipy` namespace. See :mod:`examples.updating.update2_0to3_0` 
   for details.
-- Support for Python 3. Please see :ref:`RunningUnderPython3` for details.
+- The test suite now runs much faster.
+- Tests can now be run on a full install using `fipy.test()`.
+- Grid classes now take an `Lx` argument. 
+- Equations containing a :class:`~fipy.terms.transientTerm.TransientTerm`,
+  must specify the timestep by passing a ``dt=`` argument when calling
+  :meth:`~fipy.terms.term.Term.solve` or :meth:`~fipy.terms.term.Term.sweep`.
 
 Tickets fixed in this release::
 

documentation/USAGE.txt

@@ -324,6 +324,8 @@ you need to do something with the entire solution, you can use
         Different solvers, different preconditioners, or a less restrictive
         tolerance may help.
 
+.. _MeshingWithGmsh:
+
 -----------------
 Meshing with Gmsh
 -----------------
@@ -600,11 +602,11 @@ although the left cell has the expected value as it is constrained.
 
    %    \subsection{Internal boundary conditions}
 
-.. _RunningUnderPython3:
+.. _RunUnderPython3:
 
-----------------------
-Running under Python 3     
-----------------------
+------------------
+Run under Python 3     
+------------------
 
 It is possible to run :term:`FiPy` scripts under :term:`Python 3`, but
 there is admittedly little advantage in doing so at this time. We still

examples/updating/update2_0to3_0.py

@@ -90,7 +90,7 @@
    :meth:`~fipy.variables.cellVariable.CellVariable.constrain` method than with
    the old :class:`~fipy.boundaryConditions.fixedValue.FixedValue` and
    :class:`~fipy.boundaryConditions.fixedFlux.FixedFlux` classes. See
-   :ref:`_BoundaryConditions`.
+   :ref:`BoundaryConditions`.
   
  * Individual :class:`~fipy.meshes.mesh.Mesh` classes should be imported
    directly from :mod:`fipy.meshes` and not :mod:`fipy.meshes.numMesh`.