.. -*- rest -*-
.. vim:syntax=rest

====
NIPY
====

Neuroimaging tools for Python.

The aim of NIPY is to produce a platform-independent Python environment for the
analysis of functional brain imaging data using an open development model.

In NIPY we aim to:

1. Provide an open source, mixed language scientific programming
    environment suitable for rapid development.

2. Create sofware components in this environment to make it easy
    to develop tools for MRI, EEG, PET and other modalities.

3. Create and maintain a wide base of developers to contribute to
    this platform.

4. To maintain and develop this framework as a single, easily
    installable bundle.

NIPY is the work of many people. We list the main authors in the file ``AUTHOR``
in the NIPY distribution, and other contributions in ``THANKS``.

Website
=======

Current information can always be found at the NIPY website::

    http://nipy.org/nipy

Mailing Lists
=============

Please see the developer's list::

    http://projects.scipy.org/mailman/listinfo/nipy-devel

Code
====

You can find our sources and single-click downloads:

* `Main repository`_ on Github.
* Documentation_ for all releases and current development tree.
* Download as a tar/zip file the `current trunk`_.
* Downloads of all `available releases`_.

.. _main repository: http://github.com/nipy/nipy
.. _Documentation: http://nipy.org/nipy
.. _current trunk: http://github.com/nipy/nipy/archives/master
.. _available releases: http://pypi.python.org/pypi/nipy

Dependencies
============

To run NIPY, you will need:

* python_ >= 2.5 (tested with 2.5, 2.6, 2.7, 3.2, 3.3)
* numpy_ >= 1.2
* scipy_ >= 0.7.0
* sympy_ >= 0.6.6
* nibabel_ >= 1.2

You will probably also like to have:

* ipython_ for interactive work
* matplotlib_ for 2D plotting
* mayavi_ for 3D plotting

.. _python: http://python.org
.. _numpy: http://numpy.scipy.org
.. _scipy: http://www.scipy.org
.. _sympy: http://sympy.org
.. _nibabel: http://nipy.org/nibabel
.. _ipython: http://ipython.scipy.org
.. _matplotlib: http://matplotlib.sourceforge.net
.. _mayavi: http://code.enthought.com/projects/mayavi/

License
=======

We use the 3-clause BSD license; the full license is in the file ``LICENSE`` in
the nipy distribution.
