tagging version 1.1

git-svn-id: svn+ssh://code.matforge.org/fipy/tags/version-1_1@1850 d80e17d7-ff13-0410-a124-85740d801063

INSTALLATION.txt

@@ -2,6 +2,14 @@
 Installation
 ============
 
+.. contents::
+   :local:
+   :depth: 2
+
+.. raw:: latex
+
+   \minitoc[e]
+
 The |FiPy| finite volume PDE solver relies on several third-party packages.
 It is *best to obtain and install those first*, before attempting to install
 |FiPy|.
@@ -306,7 +314,7 @@ common platforms.
 .. warning:: 
 
    The facility to produce hard copies in Pygist_ does not work very well and
-   may crash the |FiPy| run. "``.eps''" and "``.cgm''" export seem to work.
+   may crash the |FiPy| run. "``.eps``" and "``.cgm``" export seem to work.
 
 .. attention::
 
@@ -392,11 +400,20 @@ judicious use of C language inlining, via the weave_ module of the
 SciPy_ package. `SciPy installers for specific platforms`_ 
 |citeSciPyDownload| are available.
 
-In addition, a handful of test cases use functions from the SciPy_ library.
+.. attention::
+
+   SciPy_ is undergoing a lot of development lately but, as yet, |FiPy| still
+   requires "old SciPy". Be sure to install version 0.3.x of
+   ``SciPy_complete``.
+
+.. note:: 
+
+   A handful of test cases use functions from the SciPy_ library and will
+   throw errors if it is missing.
 
 .. _weave: http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://www.scipy.org/documentation/weave/
 .. _SciPy: http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://www.scipy.org/
-.. _SciPy installers for specific platforms:   http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://www.scipy.org/download/
+.. _SciPy installers for specific platforms:   http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://sourceforge.net/project/showfiles.php?group_id=27747&package_id=19531&release_id=389739
 .. |citeSciPyDownload| raw:: latex
 
    \cite{SciPyDownload}

README.txt

@@ -89,6 +89,10 @@ The significant changes since version 1.0 are:
 - Added a `MultiViewer` class that automatically groups several viewers 
   together if the variables couldn't be displayed by a single viewer.
 
+- The abbreviated syntax ``from fipy import Class`` or ``from fipy import *``
+  promised in version 1.0 actually works now. The examples all still use the
+  fully qualified names.
+
 - The repository has been converted from a CVS to a Subversion_
   repository. Details on how to check out the new repository are given
   in the |INSTALLATION-txt|.

WINDOWS-INSTALLATION.txt

@@ -25,13 +25,18 @@ experience to have a usable installation up and running.
 Step 1: Install Python
 ----------------------
 
-http://code.enthought.com/enthon/
+http://download.enthought.com/enthought_python-2.3.5-1076-wx26-n238.exe
 
-Download version 1.0.0 and run the installer. Open the
+Download and run the Enthought Edition installer. Open the
 ``C:\Python23\Lib\site-packages\vtk_python\`` directory in a browser
 and move ``vtkRenderingPythonTkWidgets.dll`` to the ``C:\Python23\``
 directory.
 
+.. warning:
+
+    Don't download later versions of Enthought Python, they may
+    be missing ``vtkRenderingPythonTkWidgets.dll``.
+
 Step 2: Install PyVTK
 ---------------------
 
@@ -55,15 +60,22 @@ Download and unpack the zip file. Run the |FiPy| installer
 ``FiPy-1.1.win32.exe``, which should be in the base FiPy-1.1
 directory.
 
-Step 5: Install Gmsh
+Step 5: Install Matplotlib
+--------------------------
+
+http://prdownloads.sourceforge.net/matplotlib/matplotlib-0.87.2.win32-py2.3.exe?download
+
+Download and run the Matplotlib installer.
+
+Step 6: Install Gmsh
 --------------------
 
 http://www.geuz.org/gmsh/bin/Windows/gmsh-1.65.0-Windows.zip
 
 Download and unpack Gmsh for Windows. Open the unpacked folder with a
 browser and copy the ``gmsh.exe`` file to ``C:\Python23``.
 
-Step 6: Run IDLE_
+Step 7: Run IDLE_
 -----------------
 
 The IDLE_ environment is recommended for running |FiPy|. In order to
@@ -80,7 +92,7 @@ instructions:
    - Add the ``-n`` option to ``Target`` being sure to leave a space after the last quote and before ``-n``
    - Drag and drop ``IDLE (Python GUI)(2)`` to the desktop to create an icon.
 
-Step 7: Import a module and view the results
+Step 8: Import a module and view the results
 --------------------------------------------
 
 You can use the IDLE_ file browser to open the examples and run the

documentation/ADMINISTRATA.txt

@@ -68,9 +68,9 @@ At point of version release x.y, *on main trunk*::
 
     $ svn copy $FIPYROOT/trunk $FIPYROOT/tags/version-x_y -m "tagging version x.y"
     $ svn delete $FIPYROOT/tags/STABLE -m "moving STABLE to new version"
-    $ svn copy $FIPYROOT/tags/version-x_y $FIPYROOT/tags/STABLE -m "tagging STABLE"
+    $ svn copy $FIPYROOT/tags/version-x_y $FIPYROOT/tags/STABLE -m "version x.y is STABLE"
     $ svn delete $FIPYROOT/tags/CURRENT -m "moving CURRENT to new version"
-    $ svn copy $FIPYROOT/tags/version-x_y $FIPYROOT/tags/CURRENT -m "tagging CURRENT"	
+    $ svn copy $FIPYROOT/tags/version-x_y $FIPYROOT/tags/CURRENT -m "version x.y is CURRENT"	
 
 ---------
 Bug fixes

documentation/CREDITS.txt

@@ -1,5 +1,5 @@
 ============
-CONTRIBUTORS
+Contributors
 ============
 
 `Jon Guyer`_ 

documentation/manual/refs.bib

@@ -259,41 +259,53 @@ @manual{FiPyGuide
 }
 
 @misc{FiPyMailingList,
+   note = {\FiPy{} mailing list},
    url = {http://www.ctcms.nist.gov/fipy/mail.html}
 }
 
 @misc{FiPyBugTracker,
+   note = {\FiPy{} bug tracker},
    url = {http://matdl-osi.org/fipy/report}
 }
 
 @misc{FiPyDownload,
+   note = {\FiPy{} download page}, 
    url = {http://www.ctcms.nist.gov/fipy/download/}
 }
 
 @misc{EnthonWindows,
+   note = {Enthought Edition of Python for Windows and Linux},
    url = {https://www.enthought.com/python/}
 }
 
 @misc{EnthonMacOSX,
-   url = {http://www.scipy.org/wikis/featurerequests/MacEnthon}
+   note = {Enthought Edition of Python for Mac OS X},
+   url = {http://old.scipy.org/wikis/featurerequests/MacEnthon}
 }
 
 @misc{PythonDownload,
+   note = {Python download page},
    url = {http://www.python.org/download/}
 }
 
 @misc{MatplotlibDownload,
+   note = {Matplotlib download page},
    url = {http://sourceforge.net/project/showfiles.php?group_id=80706&package_id=82474}
 }
 
 @misc{SciPyDownload,
-   url = {http://www.scipy.org/download/}
+   note = {SciPy download page},
+   url = {http://sourceforge.net/project/showfiles.php?group_id=27747&package_id=19531&release_id=389739}
 }
+%    url = {http://www.scipy.org/download/}
 
-@misc{SubversionRedBean,
+@book{SubversionRedBean,
+   author =    {Ben Collins-Sussman and Brian W. Fitzpatrick and C. Michael Pilato},
+   title =     {Version Control with Subversion},
+   publisher = {O'Reilly Media},
+   year =      2004,
    url = {http://svnbook.red-bean.com}
 }
-
 @misc{SourceForgeCVS,
    url = {http://sourceforge.net/cvs/?group_id=118428}
 }

documentation/www/menu.html

@@ -10,6 +10,10 @@
         <li><a href="download/fipy.pdf">Manual (PDF)</a></li>
         <li><a href="download/reference.pdf">Reference (PDF)</a></li>
         <li><a
+        href="http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://matdl-osi.org/fipy/wiki">Wiki</a></li>
+        <li><a
+        href="http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://matdl-osi.org/fipy/browser">Source code</a></li>
+        <li><a
         href="http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://matdl-osi.org/fipy/report">Bugs,
         etc.</a></li>
         <li><a href="electrochem.html">Superconformal electrodeposition</a></li>

examples/diffusion/circle.py

@@ -260,7 +260,7 @@
     ...     print "The SciPy library is not available to test the solution to \
     ... the transient diffusion equation"
 
-    >>> print phi.allclose(phiAnalytical, atol = 6e-2)
+    >>> print phi.allclose(phiAnalytical, atol = 7e-2)
     1
 
     >>> if __name__ == '__main__':

fipy/tools/numerix.py

@@ -242,7 +242,7 @@ def arccos(arr):
     
         >>> try: 
         ...     print str(arccos(2.0)) == "nan"
-        ... except OverflowError:
+        ... except (OverflowError, ValueError):
         ...     print 1
         1
 
@@ -287,7 +287,7 @@ def arccosh(arr):
     
         >>> try: 
         ...     print str(arccosh(0.0)) == "nan"
-        ... except OverflowError:
+        ... except (OverflowError, ValueError):
         ...     print 1
         1
 
@@ -324,7 +324,7 @@ def arcsin(arr):
     
         >>> try: 
         ...     print str(arcsin(2.0)) == "nan"
-        ... except OverflowError:
+        ... except (OverflowError, ValueError):
         ...     print 1
         1