root/trunk/WINDOWS-INSTALLATION.txt

===========================
Simple Windows Installation
===========================

.. contents::
   :local:
   :depth: 2

These instructions are for the `Windows XP`_ and `Windows 2000`_
platforms. Please see the more general |INSTALLATION-txt| for detailed
installation instructions.  These instructions are not the only way to
set up |FiPy| on a Windows_ OS but represent the most expedient way from
our experience to have a usable installation up and running.

.. include:: utils/include.txt

.. |INSTALLATION-txt| replace:: |htmlINSTALL| |latexINSTALL|
.. _Windows: http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://www.microsoft.com/windows/
.. _Windows XP: http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://www.microsoft.com/windowsxp/
.. _Windows 2000: http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://www.microsoft.com/windows2000/


Required Packages
=================

Python
------

http://www.pythonxy.com

http://www.enthought.com

We recommend the use of either `Enthought Python`_ or
`Python(x,y)`_. These versions of Python_ have some of the prerequisite
packages for |FiPy| already included. Download and install the latest
version.

.. _Python(x,y): http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://www.pythonxy.com
.. _Python: http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://www.python.org/
.. _Enthought Python: http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://www.enthought.com

PySparse
--------

http://sourceforge.net/project/showfiles.php?group_id=101403

Download and install the latest version of PySparse for Windows_
(pysparse-x.y.z.win32-py2.X.exe). Be sure to select the version compiled
with the correct version of Python_ to match the `Python`_ installation.


|FiPy|
------

http://www.ctcms.nist.gov/fipy/download/

Download and unpack the zip file (``FiPy-x.y.win32.zip``).  Run the
|FiPy| installer ``FiPy-x.y.win32.exe``, which is in the base
``FiPy-x.y`` directory.

Optional Packages
=================

Gmsh
----

http://www.geuz.org/gmsh

If you wish to run examples that have unstructured meshes, it is
necessary to install Gmsh. Download and unpack the latest version of
Gmsh for Windows. Open the unpacked folder with a browser and make sure
that ``gmsh.exe`` is placed somewhere on the execution path.

PyVTK
-----

http://www.ctcms.nist.gov/fipy/download/

If you wish to use `MayaVi 1`_, PyVTK is a requirement.  Download and
install the latest version from the |FiPy| `downloads page`_
(``PyVTK-x.y.z.win32.exe``).

.. _downloads page: http://www.ctcms.nist.gov/fipy/download

MayaVi
------

.. raw:: latex

   \IndexSoftware{MayaVi}

http://mayavi.sourceforge.net

`MayaVi 1`_ is a requirement if you wish to view 3D problems or improve
the viewing capabilities of the superfill examples.  Download the source
code and run ``python setup.py install`` to install from the python
source in order for ``import mayavi`` to work at the command line.

.. warning::

   At the time of writing the ``import mayavi`` command is not working
   with the `python(x,y)`_ version of `python`_.

.. note::

   `MayaVi 1`_ is outdated and we hope to have compatilibiltiy with
   `MayaVi 2`_ as soon as possible.

.. _MayaVi 1: http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://mayavi.sourceforge.net
.. _MayaVi 2: http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://code.enthought.com/projects/mayavi

Using |FiPy| on Windows
=======================

A number of interactive python environments are available such as the
IDLE_ and Ipython_ environments. The following videos may be useful for
explaining the use of Ipython_ on Windows:

http://showmedo.com/videos/series?name=PythonIPythonSeries

Testing
-------

If you have a working copy of the source, not an installed version of
|FiPy|, you can run the tests using Ipython_ from the base |FiPy|
directory, by typing

    >>> run setup.py test 

in the Ipython_ shell.

Running Examples
----------------

To run the |FiPy| examples in Ipython_ simply use the `run` command:

    >>> run examples/diffusion/mesh20x20.py

.. _IDLE: http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://www.python.org/idle/doc/idlemain.html
.. |FiPy| replace:: |htmlFiPy| |latexFiPy|
.. _Ipython: http://www.nist.gov/cgi-bin/exit_nist.cgi?url=http://ipython.scipy.org