Installation¶

The SpyKING CIRCUS comes as a python package, and it at this stage, note that mostly unix systems have been tested. However, users managed to get the software running on Mac OS X, and on Windows 7,8, or 10. We are doing our best, using your feedbacks, to improve the packaging and make the whole process as smooth as possible on all platforms.

How to install¶

Note

If you are a Windows or a Mac user, we recommend using Anaconda, and:

Using with CONDA¶

Install Anaconda or miniconda, e.g. all on the terminal (but there is also a .exe installer for Windows, etc.):

As an example for linux, just type:

>> wget https://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh
>> bash Miniconda-latest-Linux-x86_64.sh


Then install the software itself:

>> conda install -c conda-forge -c spyking-circus spyking-circus


If you want to get a support for GPU, see the devoted section on CUDA.

Using pip¶

To do so, use the pip utility:

>> pip install spyking-circus


You might want to add the --user flag, to install SpyKING CIRCUS for the local user only, which means that you don’t need administrator privileges for the installation.

Using HDF5 with MPI¶

If you are planning to use large number of electrodes (> 500), then you may use the fact that the code can use parallel HDF5. This will speed everything and reduce disk usage. To know more about how to activate it, see (see Parallel HDF5).

Dependencies¶

For information, here is the list of all the dependencies required by the SpyKING CIRCUS:
1. tqdm
2. mpi4py
3. numpy
4. cython
5. scipy
6. matplotlib
7. h5py
8. colorama
9. cudamat [optional, CUDA only]
10. sklearn [optional, only for BEER estimate]
11. blosc