How to Install

The simplest way to install spikewrap is with pip, a package manager that is automatically included with Python.

Using pip

pip is run through the system terminal, and is best used in a virtual environment (such as virtualenv or conda). For more on getting set up with Python, see Virtual Environments, a Primer

Installation instructions

Warning

spikewrap is currently in the alpha release phase. Please get in contact if you experience any bugs or unexpected behaviour.

Pip

spikewrap can be installed with the pip command:

pip install spikewrap

This will install spikewrap and all dependencies, including SpikeInterface.

spikewrap will be linked to a specific SpikeInterface version, so it is not recommended to install SpikeInterface separately.

Developers

pip can also be used to install developer dependencies.

Clone the spikewrap GitHub repository to get the latest development version.

To install spikewrap and its developer dependencies, run the follow command from inside the repository:

pip install -e .[dev]  # works on most shells
pip install -e '.[dev]'  # works on zsh (the default shell on macOS)

This will install an ‘editable’ version of spikewrap, meaning any changes you make to the cloned code will be immediately reflected in the installed package.

TODO: link the contributing guide

Check the installation

Check the spikewrap version with:

pip spikewrap --version

and the SpikeInterface version that was installed:

pip spikeinterface --version