Skip to main content

Python bindings for the Backyard Brains Spike Recorder software.

Project description

spike-recorder

Actions Status Documentation Status Code style: black

PyPI version Conda-Forge PyPI platforms

Gitter

This package implements a Python interface for the Backyard Brains Spike Recorder, a neural recording application. It is based off a fork of the original C++ code, found here. In addition, it contains two psychological experiment applications written in Python that control and record events via the SpikeRecorder.

Installation

You can install this library from PyPI with pip:

python -m pip install spike-recorder

Usage

To run the SpikeRecorder application simply invoke it on the command line

spike-recorder

If you want to launch the SpikeRecorder application alongside either of the experiments below then invoke them with the --spike-reord option.

Iowa Gambling Task

Iowa Task Screenshot

To launch the Iowa Gambling Task Experiment, run:

iowa

There are some available options and arguments:

usage: iowa [-h] [--spike-record] [--total-deck-pulls TOTAL_DECK_PULLS]

optional arguments:
  -h, --help            show this help message and exit
  --spike-record        Launch Backyard Brains Spike Recorder in background. Default is do not run.
  --total-deck-pulls TOTAL_DECK_PULLS
                        The total number of deck pulls in the experiment. Default is 100.


Libet Experiment

Libet Experiment Screenshot

To launch the Libet Task Experiment, simply run:

libet

If you wish to adjust the speed of the clock or the number of trials in either phase, see the available options:

usage: libet [-h] [--spike-record] [--num-trials-paradigm1 NUM_TRIALS_PARADIGM1] [--num-trials-paradigm2 NUM_TRIALS_PARADIGM2] [--clock-hz-paradigm1 CLOCK_HZ_PARADIGM1] [--clock-hz-paradigm2 CLOCK_HZ_PARADIGM2]

optional arguments:
  -h, --help            show this help message and exit
  --spike-record        Launch Backyard Brains Spike Recorder in background. 
                        Default is do not run.
  --num-trials-paradigm1 NUM_TRIALS_PARADIGM1
                        The number of trials to conduct for paradigm one. Default is 20.
  --num-trials-paradigm2 NUM_TRIALS_PARADIGM2
                        The number of trials to conduct for paradigm two, 
                        in which time of urge is asked. Default is 20.
  --clock-hz-paradigm1 CLOCK_HZ_PARADIGM1
                        The number of full rotations the clock makes per second in paradigm one. 
                        Default is 1 but can be set lower than 1.
  --clock-hz-paradigm2 CLOCK_HZ_PARADIGM2
                        The number of full rotations the clock makes per second in paradigm two. 
                        Default is 1 but can be set lower than 1.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spike_recorder-0.3.3.tar.gz (6.9 kB view hashes)

Uploaded Source

Built Distributions

spike_recorder-0.3.3-cp39-cp39-win_amd64.whl (1.9 MB view hashes)

Uploaded CPython 3.9 Windows x86-64

spike_recorder-0.3.3-cp39-cp39-macosx_10_9_x86_64.whl (1.9 MB view hashes)

Uploaded CPython 3.9 macOS 10.9+ x86-64

spike_recorder-0.3.3-cp38-cp38-win_amd64.whl (1.9 MB view hashes)

Uploaded CPython 3.8 Windows x86-64

spike_recorder-0.3.3-cp38-cp38-macosx_10_9_x86_64.whl (1.9 MB view hashes)

Uploaded CPython 3.8 macOS 10.9+ x86-64

spike_recorder-0.3.3-cp37-cp37m-win_amd64.whl (1.9 MB view hashes)

Uploaded CPython 3.7m Windows x86-64

spike_recorder-0.3.3-cp37-cp37m-macosx_10_9_x86_64.whl (1.9 MB view hashes)

Uploaded CPython 3.7m macOS 10.9+ x86-64

spike_recorder-0.3.3-cp36-cp36m-win_amd64.whl (1.9 MB view hashes)

Uploaded CPython 3.6m Windows x86-64

spike_recorder-0.3.3-cp36-cp36m-macosx_10_9_x86_64.whl (1.9 MB view hashes)

Uploaded CPython 3.6m macOS 10.9+ x86-64

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page