*************************
Download and Installation
*************************

Neo is a pure Python package, so it should be easy to get it running on any
system.

Dependencies
============
  
    * Python_ >= 2.6
    * numpy_ >= 1.3.0  (1.5.0 for Python 3)
    * quantities_ >= 0.9.0

For Debian/Ubuntu, you can install these using::

    $ apt-get install python-numpy python-pip
    $ pip install quantities

You may need to run these as root. For other operating systems, you can
download installers from the links above.

Certain IO modules have additional dependencies. If these are not satisfied,
Neo will still install but the IO module that uses them will fail on loading:

   * scipy >= 0.8 for NeoMatlabIO
   * pytables >= 2.2 for Hdf5IO

For SciPy  on Debian testing/Ubuntu, you can install these using::

    $ apt-get install python-scipy

For PyTables version 2.2::

    $ apt-get install libhdf5-serial-dev python-numexpr cython
    $ pip install tables


Installing from the Python Package Index
========================================

If you have pip_ installed::

    $ pip install neo
    
Alternatively, if you have setuptools_::
    
    $ easy_install neo
    
Both of these will automatically download and install the latest release (again
you may need to have administrator privileges on the machine you are installing
on).
    
To download and install manually, download:

    http://pypi.python.org/packages/source/n/neo/neo-0.3.3.tar.gz

Then::

    $ tar xzf neo-0.3.3.tar.gz
    $ cd neo-0.3.3
    $ python setup.py install
    
or::

    $ python3 setup.py install
    
depending on which version of Python you are using.


Installing from source
======================

To install the latest version of Neo from the Git repository::

    $ git clone git://github.com/NeuralEnsemble/python-neo.git
    $ cd python-neo
    $ python setup.py install


Python 3 support
================

:mod:`neo.core` is fully compatible with Python 3, but only some of the IO
modules support it, as shown in the table below:

================== ======== ========
Module             Python 2 Python 3
================== ======== ========
AlphaOmegaIO       Yes      No
AsciiSignalIO      Yes      Yes
AsciiSpikeTrainIO  Yes      Yes
AxonIO             Yes      No
BlackrockIO        Yes      No
BrainwareDamIO     Yes      Yes
BrainwareF32IO     Yes      Yes
BrainwareSrcIO     Yes      Yes
ElanIO             Yes      No
HDF5IO             Yes      No
KlustakwikIO       Yes      No
MicromedIO         Yes      No
NeoMatlabIO        Yes      Yes
NeuroExplorerIO    Yes      No
NeuroscopeIO       Yes      Yes
PickleIO           Yes      Yes
PlexonIO           Yes      No
PyNNIO             Yes      Yes
RawBinarySignalIO  Yes      Yes
Spike2IO           Yes      Yes
TdtIO              Yes      No
WinEdrIO           Yes      Yes
WinWcpIO           Yes      Yes
================== ======== ========



.. _`Python`: http://python.org/
.. _`numpy`: http://numpy.scipy.org/
.. _`quantities`: http://pypi.python.org/pypi/quantities
.. _`pip`: http://pypi.python.org/pypi/pip
.. _`setuptools`: http://pypi.python.org/pypi/setuptools