Installation

There are two ways to install Spyke Viewer on your system. The preferred way is to install the spykeviewer package in your Python environment. Depending on what already exists on your system, this might require installing Python itself and a few additional packages for scientific data processing, management and visualization.

On the other hand, there are also binary packages available for Windows and OS X. These packages do not have any additional requirements and can be started immediately (form an App in OS X or an executable file in Windows). However, as they are independent of an existing Python installation, you will not be able to use installed additional packages from your Python environment. The binary packages are especially useful if you do not normally use Python or just want to try Spyke Viewer quickly. You can switch to the source installation at any time.

Binary

If you want to install the binary version, go to the download page on GitHub and select the most recent version for your operating system. The downloaded file contains an installer (for OS X) or executable (main\spykeviewer.exe for Windows). The rest of this page deals with source installation, you can go to Usage to learn how to use Spyke Viewer.

Source

If you want to install Spyke Viewer to your Python environment, there are a few requirements that need to be fulfilled.

Dependencies

First you need at least Python 2.7. In addition, the following packages and their respective dependencies need to be installed:

Please see the respective websites for instructions on how to install them if they are not present on your computer.

Note

The current version of Neo in the Python Package Index contains some bugs that prevent it from working properly with Spyke Viewer in some situations. Please install the latest version directly from GitHub: https://github.com/rproepp/python-neo

You can download the repository from the GitHub page or clone it using git and then install from the resulting folder:

$ python setup.py install

spykeviewer

Once the requirements are fulfilled, you need to install the package spykeviewer. The easiest way to get it is from the Python Package Index. If you have pip installed:

$ pip install spykeviewer

Alternatively, if you have setuptools:

$ easy_install spykeviewer

Alternatively, you can get the latest version directly from GitHub at https://github.com/rproepp/spykeviewer.

The master branch (selected by default) always contains the current stable version. If you want the latest development version (not recommended unless you need some features that do not exist in the stable version yet), select the develop branch. You can download the repository from the GitHub page or clone it using git and then install from the resulting folder:

$ python setup.py install

Once the package is installed, you can start Spyke Viewer using:

$ spyke-viewer

Project Versions

Table Of Contents

Previous topic

Welcome to the Spyke Viewer documentation!

Next topic

Usage

This Page