Probeinterface: a unified framework for probe handling in neuroscience
======================================================================

:code:`probeinterface` is a Python package to handle probe layout, geometry and wiring to a device for neuroscience experiments.


The package handles the following items:

  * probe geometry (2D or 3D  layout)
  * probe shape (contours of the probe)
  * shape and size of the shank
  * probe wiring to the recording device
  * combination of several probes: global geometry + global wiring

The :code:`probeinterface` package also provides:

  * basic plotting functions with matplotlib
  * input/output functions to several formats (PRB, NWB, CSV, MEArec, SpikeGLX, ...)

Here is a schema for the naming used in the package:

.. image:: img/probeinterface_naming.png
    :width: 400 px



.. include:: examples/index.rst

.. toctree::
   :caption: Contents:
   :maxdepth: 1

   overview
   examples/index.rst
   format_spec
   library
   neuropixels_readers
   api
   release_notes