README.rst 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. ===
  2. Neo
  3. ===
  4. Neo is a Python package for working with electrophysiology data in Python, together
  5. with support for reading a wide range of neurophysiology file formats, including
  6. Spike2, NeuroExplorer, AlphaOmega, Axon, Blackrock, Plexon, Tdt, and support for
  7. writing to a subset of these formats plus non-proprietary formats including HDF5.
  8. The goal of Neo is to improve interoperability between Python tools for
  9. analyzing, visualizing and generating electrophysiology data by providing a common,
  10. shared object model. In order to be as lightweight a dependency as possible,
  11. Neo is deliberately limited to represention of data, with no functions for data
  12. analysis or visualization.
  13. Neo is used by a number of other software tools, including OpenElectrophy_
  14. and SpykeViewer_ (data analysis and visualization), Elephant_ (data analysis),
  15. the G-node_ suite (databasing) and PyNN_ (simulations).
  16. Neo implements a hierarchical data model well adapted to intracellular and
  17. extracellular electrophysiology and EEG data with support for multi-electrodes
  18. (for example tetrodes). Neo's data objects build on the quantities package,
  19. which in turn builds on NumPy by adding support for physical dimensions. Thus
  20. Neo objects behave just like normal NumPy arrays, but with additional metadata,
  21. checks for dimensional consistency and automatic unit conversion.
  22. A project with similar aims but for neuroimaging file formats is `NiBabel`_.
  23. Code status
  24. -----------
  25. .. image:: https://travis-ci.org/NeuralEnsemble/python-neo.png?branch=master
  26. :target: https://travis-ci.org/NeuralEnsemble/python-neo
  27. :alt: Unit Test Status
  28. .. image:: https://coveralls.io/repos/NeuralEnsemble/python-neo/badge.png
  29. :target: https://coveralls.io/r/NeuralEnsemble/python-neo
  30. :alt: Unit Test Coverage
  31. .. image:: https://requires.io/github/NeuralEnsemble/python-neo/requirements.png?branch=master
  32. :target: https://requires.io/github/NeuralEnsemble/python-neo/requirements/?branch=master
  33. :alt: Requirements Status
  34. More information
  35. ----------------
  36. - Home page: http://neuralensemble.org/neo
  37. - Mailing list: https://groups.google.com/forum/?fromgroups#!forum/neuralensemble
  38. - Documentation: http://neo.readthedocs.io/
  39. - Bug reports: https://github.com/NeuralEnsemble/python-neo/issues
  40. For installation instructions, see doc/source/install.rst
  41. :copyright: Copyright 2010-2016 by the Neo team, see doc/source/authors.rst.
  42. :license: 3-Clause Revised BSD License, see LICENSE.txt for details.
  43. .. _OpenElectrophy: https://github.com/OpenElectrophy/OpenElectrophy
  44. .. _Elephant: http://neuralensemble.org/elephant
  45. .. _G-node: http://www.g-node.org/
  46. .. _Neuroshare: http://neuroshare.org/
  47. .. _SpykeViewer: https://spyke-viewer.readthedocs.org/en/latest/
  48. .. _NiBabel: http://nipy.sourceforge.net/nibabel/
  49. .. _PyNN: http://neuralensemble.org/PyNN
  50. .. _quantities: http://pypi.python.org/pypi/quantities
  51. .. _`NeuralEnsemble mailing list`: http://groups.google.com/group/neuralensemble
  52. .. _`issue tracker`: https://github.c