install.rst 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. ************
  2. Installation
  3. ************
  4. Neo is a pure Python package, so it should be easy to get it running on any
  5. system.
  6. Dependencies
  7. ============
  8. * Python_ >= 2.7
  9. * numpy_ >= 1.7.1
  10. * quantities_ >= 0.9.0
  11. For Debian/Ubuntu, you can install these using::
  12. $ apt-get install python-numpy python-pip
  13. $ pip install quantities
  14. You may need to run these as root. For other operating systems, you can
  15. download installers from the links above, or use a scientific Python distribution
  16. such as Anaconda_.
  17. Certain IO modules have additional dependencies. If these are not satisfied,
  18. Neo will still install but the IO module that uses them will fail on loading:
  19. * scipy >= 0.12.0 for NeoMatlabIO
  20. * h5py >= 2.5 for Hdf5IO, KwikIO
  21. * klusta for KwikIO
  22. * igor >= 0.2 for IgorIO
  23. * nixio >= 1.2 for NixIO
  24. * stfio for StimfitIO
  25. Installing from the Python Package Index
  26. ========================================
  27. .. warning:: alpha and beta releases cannot be installed from PyPI.
  28. If you have pip_ installed::
  29. $ pip install neo
  30. This will automatically download and install the latest release (again
  31. you may need to have administrator privileges on the machine you are installing
  32. on).
  33. To download and install manually, download:
  34. https://github.com/NeuralEnsemble/python-neo/archive/neo-0.5.2.zip
  35. Then::
  36. $ unzip neo-0.5.2.zip
  37. $ cd neo-0.5.2
  38. $ python setup.py install
  39. or::
  40. $ python3 setup.py install
  41. depending on which version of Python you are using.
  42. Installing from source
  43. ======================
  44. To install the latest version of Neo from the Git repository::
  45. $ git clone git://github.com/NeuralEnsemble/python-neo.git
  46. $ cd python-neo
  47. $ python setup.py install
  48. .. _`Python`: http://python.org/
  49. .. _`numpy`: http://numpy.scipy.org/
  50. .. _`quantities`: http://pypi.python.org/pypi/quantities
  51. .. _`pip`: http://pypi.python.org/pypi/pip
  52. .. _`setuptools`: http://pypi.python.org/pypi/setuptools
  53. .. _Anaconda: https://www.continuum.io/downloads