.. _install:

============
Installation
============

Pylon is a package of Python modules that need to be placed on the
``PYTHON_PATH``.

Dependencies
------------

  Python_ 2.5 or 2.6

  NumPy_ 1.2 or later
    NumPy provides additional support for multi-dimentional arrays and
    matrices.

  SciPy_ 0.7 or later
    Packages for mathematics, science, and engineering

  Pyparsing_
    Pyparsing is a versatile Python module for recursive descent parsing.

Recommended
-----------

  `scikits.umfpack <http://scikits.appspot.com/umfpack>`_
    Wrappers of UMFPACK sparse direct solver to SciPy.

Setuptools
----------

With Python_ and setuptools_ installed, simply::

  $ easy_install pylon

Users without root access may use Virtualenv_ to build a virtual Python
environment::

  $ virtualenv python26
  $ ./python26/bin/easy_install pylon

To upgrade to a newer version::

  $ easy_install -U pylon

Installation from source
------------------------

Run the ``setup.py`` script::

  $ python setup.py install

or::

  $ python setup.py develop

Working directory
-----------------

Change in to the source directory and run IPython_::

  $ cd ~/path/to/pylon-0.4.1
  $ ipython

Access the ``pylon`` application programming inteface.

.. sourcecode:: ipython

  In [1]: from pylon import Case, OPF

.. include:: ../links_names.txt