Fipy

------------------------

The significant changes since version 1.1 are:

- `--inline` automatically generates C code from `Variable` expressions.

- :term:`FiPy` has been updated to use the :term:`Python` :term:`NumPy` module.
:term:`FiPy` no longer works with the older :term:`Numeric` module.

Fixes
-----

- `98 <https://github.com/usnistgov/fipy/issues/98>`_:
Windows patch for some broken test cases
- `94 <https://github.com/usnistgov/fipy/issues/94>`_:
`--inline` error for attached code
- `90 <https://github.com/usnistgov/fipy/issues/90>`_:
bug in matplotlib 0.87.7:
`TypeError: only length-1 arrays can be converted to Python scalars`.
- `72 <https://github.com/usnistgov/fipy/issues/72>`_:
needless rebuilding of variables
- `66 <https://github.com/usnistgov/fipy/issues/66>`_:
PDF rendering issues for the guide on various platforms
- `62 <https://github.com/usnistgov/fipy/issues/62>`_:
fipy guide pdf bug: "`an unrecognized token 13c was found`"
- `55 <https://github.com/usnistgov/fipy/issues/55>`_:
Error for internal BCs
- `52 <https://github.com/usnistgov/fipy/issues/52>`_:
`FaceVariable * FaceVectorVariable` memory
- `48 <https://github.com/usnistgov/fipy/issues/48>`_:
Documentation is not inherited from &hidden& classes
- `42 <https://github.com/usnistgov/fipy/issues/42>`_:
`fipy.models.phase.phase.addOverFacesVariable` is gross
- `41 <https://github.com/usnistgov/fipy/issues/41>`_:
:file:`EFFICIENCY.txt` example fails to make viewer
- `30 <https://github.com/usnistgov/fipy/issues/30>`_:
periodic boundary condition support
- `25 <https://github.com/usnistgov/fipy/issues/25>`_:
make phase field examples more explicit
- `23 <https://github.com/usnistgov/fipy/issues/23>`_:
sweep control, iterator object, error norms
- `21 <https://github.com/usnistgov/fipy/issues/21>`_:
Update FiPy to use numpy
- `16 <https://github.com/usnistgov/fipy/issues/16>`_:
Dimensions
- `12 <https://github.com/usnistgov/fipy/issues/12>`_:
Refactor viewers
- `1 <https://github.com/usnistgov/fipy/issues/1>`_:
Gnuplot doesn't display on windows

------------------------

------------------------

The significant changes since version 1.0 are:

- Memory efficiency has been improved in a number of ways, but most
significantly by:

* not caching all intermediate ``Variable`` values.
* introducing ``UniformGrid`` classes that calculate geometric
arrays on the fly.

Details of these improvements are presented in :ref:`chap:Efficiency`.

- Installation on Windows has been made considerably easier by
constructing executable installers for :term:`FiPy` and its
dependencies.

- The arithmetic for ``Variable`` subclasses now works, and returns
sensible answers. For example, ``VectorCellVariable * CellVariable``
returns a ``VectorCellVariable``.

- ``PeriodicGrid`` meshes have been implemented. Currently, however,
there and no examples of their use in the manual.

- Many of the examples have been completely rewritten

* A basic 1D diffusion problem now serves as a general tutorial for
setting up any problem in :term:`FiPy`.
* Several more phase field examples have been added that should make it
clearer how to get from the simple 1D case to the more elaborate
multicomponent, multidimensional, and anisotropic models.
* The "Superfill" examples have been substantially improved with better
functionality and documentation.
* An example of fluid flow with the classic Stokes moving lid has been
added.

- A clear distinction has been made between solving an equation via `solve()`
and iterating an non-linear equation to solution via `sweep()`. An extensive
explanation of the concepts involved has been added to the :ref:`FAQ`.

- 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 :ref:`INSTALLATION`.

- The :term:`FiPy` repository has also been moved from Sourceforge_ to the
`Materials Digital Library Pathway`_.

.. _Subversion: https://subversion.apache.org/
.. _Sourceforge: https://sourceforge.net/
.. _Materials Digital Library Pathway: https://www.kent.edu/cmi/materials-digital-library-pathway-matdl

------------------------

------------------------

Numerous changes have been made since :term:`FiPy` 0.1 was released, but the most
significant ones are:

- ``Equation`` objects no longer exist. PDEs are constructed from ``Term``
objects. ``Term`` objects can be added, subtracted, and equated to build up
an equation.

- A true 1D grid class has been added: ``fipy.meshes.grid1D.Grid1D``.

- A generic "factory" method ``fipy.viewers.make()`` has been added that will
do a reasonable job of automatically creating a ``Viewer`` for the supplied
``Variable`` objects. The ``FIPY_VIEWER`` environment variable allows you to
specify your preferred viewer.

- A simple ``TSVViewer`` has been added to allow display or export to a file of
your solution data.

- It is no longer necessary to ``transpose()`` scalar fields in order to
multiply them with vector fields.

- Better default choice of solver when convection is present.

- Better examples.

- A number of `NoiseVariable` objects have been added.

- A new viewer based on :term:`Matplotlib` has been added.

- The `PyX` viewer has been removed.

- Considerably simplified the public interface to FiPy.

- Support for Python 2.4.

- Improved layout of the manuals.

- ``getLaplacian()`` method has been removed from ``CellVariable`` objects.
You can obtain the same effect with ``getFaceGrad().getDivergence()``,
which provides better control.

- An ``import`` shorthand has been added that allows for::

from fipy import Class

instead of::

from fipy.some.deeply.nested.module.class import Class

This system is still experimental. Please tell us if you find situations
that don't work.

The syntax of :term:`FiPy` 1.0 scripts is incompatible with earlier
releases. A tutorial for updating your existing scripts can be found in
:file:`examples/updating/update0_1to1_0.py`.

Fixes
-----

- `49 <https://github.com/usnistgov/fipy/issues/49>`_:
Documentation for many `ConvectionTerms` is wrong
- `47 <https://github.com/usnistgov/fipy/issues/47>`_:
Terms should throw an error on bad `coeff` type
- `40 <https://github.com/usnistgov/fipy/issues/40>`_:
broken levelset test case
- `38 <https://github.com/usnistgov/fipy/issues/38>`_:
multiple BCs on one face broken?
- `37 <https://github.com/usnistgov/fipy/issues/37>`_:
Better support for periodic boundary conditions
- `36 <https://github.com/usnistgov/fipy/issues/36>`_:
Gnuplot doesn't display the :file:`~examples/levelSet/electroChem`
problem on windows.
- `35 <https://github.com/usnistgov/fipy/issues/35>`_:
gmsh write problem on windows
- `33 <https://github.com/usnistgov/fipy/issues/33>`_:
`DiffusionTerm(coeff = CellVariable)` functionality
- `32 <https://github.com/usnistgov/fipy/issues/32>`_:
conflict_handler = `ignore` not valid in Python 2.4
- `31 <https://github.com/usnistgov/fipy/issues/31>`_:
Support simple import notation
- `29 <https://github.com/usnistgov/fipy/issues/29>`_:
periodic boundary conditions are broken
- `28 <https://github.com/usnistgov/fipy/issues/28>`_:
invoke the == for terms
- `26 <https://github.com/usnistgov/fipy/issues/26>`_:
doctest extraction with python 2.4
- `24 <https://github.com/usnistgov/fipy/issues/24>`_:
Pysparse windows binaries
- `22 <https://github.com/usnistgov/fipy/issues/22>`_:
automated efficiency_test problems
- `20 <https://github.com/usnistgov/fipy/issues/20>`_:
Test with Python version 2.4
- `18 <https://github.com/usnistgov/fipy/issues/18>`_:
Memory leak for the leveling problem
- `17 <https://github.com/usnistgov/fipy/issues/17>`_:
`distanceVariable` is broken
- `14 <https://github.com/usnistgov/fipy/issues/14>`_:
Testing mailing list interface
- `11 <https://github.com/usnistgov/fipy/issues/11>`_:
Reconcile versions of pysparse
- `10 <https://github.com/usnistgov/fipy/issues/10>`_:
check phase field crystal growth
- `9 <https://github.com/usnistgov/fipy/issues/9>`_:
implement levelling surfactant equation
- `8 <https://github.com/usnistgov/fipy/issues/8>`_:
merge `depositionRateVar` and `extensionVelocity`
- `7 <https://github.com/usnistgov/fipy/issues/7>`_:
Automate FiPy efficiency test
- `6 <https://github.com/usnistgov/fipy/issues/6>`_:
FiPy breaks on windows with Numeric 23.6
- `5 <https://github.com/usnistgov/fipy/issues/5>`_:
axisymmetric 2D mesh
- `4 <https://github.com/usnistgov/fipy/issues/4>`_:
Windows installation wizard
- `3 <https://github.com/usnistgov/fipy/issues/3>`_:
Windows installation instructions
- `2 <https://github.com/usnistgov/fipy/issues/2>`_:
Some tests fail on windows XP

-------------

-------------

------------------------

------------------------

Original release