README.rst 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  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
  14. SpykeViewer_ (data analysis and visualization), Elephant_ (data analysis),
  15. the G-node_ suite (databasing), PyNN_ (simulations), tridesclous_ (spike sorting)
  16. and ephyviewer_ (data visualization).
  17. OpenElectrophy_ (data analysis and visualization) uses an older version of neo.
  18. Neo implements a hierarchical data model well adapted to intracellular and
  19. extracellular electrophysiology and EEG data with support for multi-electrodes
  20. (for example tetrodes). Neo's data objects build on the quantities package,
  21. which in turn builds on NumPy by adding support for physical dimensions. Thus
  22. Neo objects behave just like normal NumPy arrays, but with additional metadata,
  23. checks for dimensional consistency and automatic unit conversion.
  24. A project with similar aims but for neuroimaging file formats is `NiBabel`_.
  25. Code status
  26. -----------
  27. .. image:: https://travis-ci.org/NeuralEnsemble/python-neo.png?branch=master
  28. :target: https://travis-ci.org/NeuralEnsemble/python-neo
  29. :alt: Unit Test Status (TravisCI)
  30. .. image:: https://circleci.com/gh/NeuralEnsemble/python-neo.svg?style=svg
  31. :target: https://circleci.com/gh/NeuralEnsemble/python-neo
  32. :alt: Unit Test Status (CircleCI)
  33. .. image:: https://coveralls.io/repos/NeuralEnsemble/python-neo/badge.png
  34. :target: https://coveralls.io/r/NeuralEnsemble/python-neo
  35. :alt: Unit Test Coverage
  36. .. image:: https://requires.io/github/NeuralEnsemble/python-neo/requirements.png?branch=master
  37. :target: https://requires.io/github/NeuralEnsemble/python-neo/requirements/?branch=master
  38. :alt: Requirements Status
  39. More information
  40. ----------------
  41. - Home page: http://neuralensemble.org/neo
  42. - Mailing list: https://groups.google.com/forum/?fromgroups#!forum/neuralensemble
  43. - Documentation: http://neo.readthedocs.io/
  44. - Bug reports: https://github.com/NeuralEnsemble/python-neo/issues
  45. For installation instructions, see doc/source/install.rst
  46. To cite Neo in publications, see CITATION.txt
  47. :copyright: Copyright 2010-2018 by the Neo team, see doc/source/authors.rst.
  48. :license: 3-Clause Revised BSD License, see LICENSE.txt for details.
  49. .. _OpenElectrophy: https://github.com/OpenElectrophy/OpenElectrophy
  50. .. _Elephant: http://neuralensemble.org/elephant
  51. .. _G-node: http://www.g-node.org/
  52. .. _Neuroshare: http://neuroshare.org/
  53. .. _SpykeViewer: https://spyke-viewer.readthedocs.org/en/latest/
  54. .. _NiBabel: http://nipy.sourceforge.net/nibabel/
  55. .. _PyNN: http://neuralensemble.org/PyNN
  56. .. _quantities: http://pypi.python.org/pypi/quantities
  57. .. _`NeuralEnsemble mailing list`: http://groups.google.com/group/neuralensemble
  58. .. _`issue tracker`: https://github.c
  59. .. _tridesclous: https://github.com/tridesclous/tridesclous
  60. .. _ephyviewer: https://github.com/NeuralEnsemble/ephyviewer