multielectrode_grasp/code/python-neo/doc/source/install.rst

************
Installation
************

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

Dependencies
============
  
    * Python_ >= 2.7
    * numpy_ >= 1.7.1
    * quantities_ >= 0.12.1

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, or use a scientific Python distribution
such as Anaconda_.

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.12.0 for NeoMatlabIO
   * h5py >= 2.5 for Hdf5IO, KwikIO
   * klusta for KwikIO
   * igor >= 0.2 for IgorIO
   * nixio >= 1.5 for NixIO
   * stfio for StimfitIO


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

.. warning:: alpha and beta releases cannot be installed from PyPI.

If you have pip_ installed::

    $ pip install neo
    
This 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:

    |neo_github_url|
    

Then:

.. parsed-literal::
    
    $ unzip neo-|release|.zip
    $ cd neo-|release|
    $ 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`: 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
.. _Anaconda: https://www.continuum.io/downloads