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-phase1 NUM_TRIALS_PHASE1] [--num-trials-phase2 NUM_TRIALS_PHASE2] [--clock_hz CLOCK_HZ]

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-phase1 NUM_TRIALS_PHASE1
                        The number of trials to conduct for phase one. Default is 20.
  --num-trials-phase2 NUM_TRIALS_PHASE2
                        The number of trials to conduct for phase two, in which 
                        time of urge is asked. Default is 20.
  --clock_hz CLOCK_HZ   The number of full rotations the clock makes per second. 
                        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.0.tar.gz (6.6 kB view details)

Uploaded Source

Built Distributions

spike_recorder-0.3.0-cp39-cp39-win_amd64.whl (2.0 MB view details)

Uploaded CPython 3.9 Windows x86-64

spike_recorder-0.3.0-cp39-cp39-macosx_10_9_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.9 macOS 10.9+ x86-64

spike_recorder-0.3.0-cp38-cp38-win_amd64.whl (2.0 MB view details)

Uploaded CPython 3.8 Windows x86-64

spike_recorder-0.3.0-cp38-cp38-macosx_10_9_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.8 macOS 10.9+ x86-64

spike_recorder-0.3.0-cp37-cp37m-win_amd64.whl (2.0 MB view details)

Uploaded CPython 3.7m Windows x86-64

spike_recorder-0.3.0-cp37-cp37m-macosx_10_9_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.7m macOS 10.9+ x86-64

spike_recorder-0.3.0-cp36-cp36m-win_amd64.whl (2.0 MB view details)

Uploaded CPython 3.6m Windows x86-64

spike_recorder-0.3.0-cp36-cp36m-macosx_10_9_x86_64.whl (1.9 MB view details)

Uploaded CPython 3.6m macOS 10.9+ x86-64

File details

Details for the file spike_recorder-0.3.0.tar.gz.

File metadata

  • Download URL: spike_recorder-0.3.0.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for spike_recorder-0.3.0.tar.gz
Algorithm Hash digest
SHA256 434bba04363cf8216f6ccb6da16470c1c3f46174217ba37637b2a5fb0ba5e91f
MD5 d251705b2c47075d65ad4f9bd7d337f0
BLAKE2b-256 39f315777a8f140f458de5fcf0a97324f18845c68207723c2a0f2d33884bd8ef

See more details on using hashes here.

File details

Details for the file spike_recorder-0.3.0-cp39-cp39-win_amd64.whl.

File metadata

  • Download URL: spike_recorder-0.3.0-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for spike_recorder-0.3.0-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 3bbb1dc3d5404b6948c3d6002c8792635ed21c1804b24bae39780471e18a2d35
MD5 670b6ec473e13c644added9854f66b34
BLAKE2b-256 cb4523a0a87ffa10662dd742233b7c485d1ddaf19cb8ba3f7492b76701c78aec

See more details on using hashes here.

File details

Details for the file spike_recorder-0.3.0-cp39-cp39-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: spike_recorder-0.3.0-cp39-cp39-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.9, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for spike_recorder-0.3.0-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 141b9ea99507659542bef2ceae6aa7f7308247e3a7920eb146d18fe2fe4024f5
MD5 376d65f210f54753e58efa1225e8875d
BLAKE2b-256 71461fff01f3fab9d7653a0034a6ccdd9093f0370ebe1ac2e4c13c38668a58ff

See more details on using hashes here.

File details

Details for the file spike_recorder-0.3.0-cp38-cp38-win_amd64.whl.

File metadata

  • Download URL: spike_recorder-0.3.0-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for spike_recorder-0.3.0-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 6e080b660b84b4d0a6f3802e7f76295bf84155dc4007592fcb653c8d2d369c50
MD5 55d5b339c37c0c27da55faaaf0f1ea29
BLAKE2b-256 419a690b98ae308371e8e759b873df1a06e9e23ec4e922c1ce8473b0c4382abf

See more details on using hashes here.

File details

Details for the file spike_recorder-0.3.0-cp38-cp38-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: spike_recorder-0.3.0-cp38-cp38-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.8, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for spike_recorder-0.3.0-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 e3dc84dd21628823559f4359c70df1026193032d05a261e8a573bf3bded5e32e
MD5 fbdcc006b72cacaf29267ba0f156b2cc
BLAKE2b-256 8b52b55dd15f9afcaabdd09bb574c9275f0c882ebed75d3d4514a5afa50bf906

See more details on using hashes here.

File details

Details for the file spike_recorder-0.3.0-cp37-cp37m-win_amd64.whl.

File metadata

  • Download URL: spike_recorder-0.3.0-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for spike_recorder-0.3.0-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 9148ba2f881b88285ef528e7a8022e0845f2eed4e3bb2538e37dbefd3d2c6995
MD5 36bfaa745324aa2ac15f91c495292964
BLAKE2b-256 97285114b3074875b038f4d67215887d9334aaf09ffb968166174b84b80900b4

See more details on using hashes here.

File details

Details for the file spike_recorder-0.3.0-cp37-cp37m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: spike_recorder-0.3.0-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.7m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for spike_recorder-0.3.0-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 631dc05839b2aa87903c522d8cfd338ad24b2c5cfd492ef9792dc63e54679c31
MD5 f2c92b195a37e105dd13b189574e4fd0
BLAKE2b-256 cda1df159f285934d76aacee21a6dc9acb0ded3cde00b5c828e7f48c4eb87159

See more details on using hashes here.

File details

Details for the file spike_recorder-0.3.0-cp36-cp36m-win_amd64.whl.

File metadata

  • Download URL: spike_recorder-0.3.0-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: CPython 3.6m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for spike_recorder-0.3.0-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 df2e9a886281a47552fba028588b66a847547fb3c51b34f9ff18946adae836a7
MD5 a5ed99f6a0d331dea32e041904d9f4c8
BLAKE2b-256 50aee886792ef31aafc02b7e39855bb8c20a2de5dce85cdc6be8287a504ee221

See more details on using hashes here.

File details

Details for the file spike_recorder-0.3.0-cp36-cp36m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: spike_recorder-0.3.0-cp36-cp36m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.6m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7

File hashes

Hashes for spike_recorder-0.3.0-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 b047f0d9cc6de4c3a93fec97cc61a0a6fa8a3260600288ffe5ea8e459443ee03
MD5 71640e40d40cdd33eb7d7b9cc2d4ccbd
BLAKE2b-256 5788bd9f035d56e007d6e65351c7ef4050c5a0f1f1b89c320ddbefa501eb2432

See more details on using hashes here.

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