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.1.tar.gz (6.6 kB view details)

Uploaded Source

Built Distributions

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

Uploaded CPython 3.9 Windows x86-64

spike_recorder-0.3.1-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.1-cp38-cp38-win_amd64.whl (2.0 MB view details)

Uploaded CPython 3.8 Windows x86-64

spike_recorder-0.3.1-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.1-cp37-cp37m-win_amd64.whl (2.0 MB view details)

Uploaded CPython 3.7m Windows x86-64

spike_recorder-0.3.1-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.1-cp36-cp36m-win_amd64.whl (2.0 MB view details)

Uploaded CPython 3.6m Windows x86-64

spike_recorder-0.3.1-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.1.tar.gz.

File metadata

  • Download URL: spike_recorder-0.3.1.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.1.tar.gz
Algorithm Hash digest
SHA256 18f8847fed9a2fab2eb7d9987f6932ca21ceb2fb69032269d884cf4d5169eafe
MD5 df98fb0e79f9ea3757ed449ce9d66831
BLAKE2b-256 766fec8f10aaf4f8ec14c1c40f82bca950f884baf2a3c7dd019b8ffa92227068

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.1-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.1-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 9965fd8739d30ed08b73d2a519909489a51953a01152ac3b440cf439a80cb85c
MD5 8ef2f980ca7fb8e9994f4fec6793643a
BLAKE2b-256 f6ec509ce6e4978f65c2f1990605a08b5764a2f66940e161438cefb292b3710c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.1-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.1-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 71ef11ea6a270d0916ddaf11b5ab8a0fc1bec80b05d7d9f00a77bef243a7da99
MD5 16085ca66c413564c2d0be0012af3d34
BLAKE2b-256 935fae1b84fe9cee73921d30180e9d505450fe718e5d7005574e3229b967c9cf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.1-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.1-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 06398da6c0df5846868923dd88d4a44f933b832da09352e324599075bc8d4947
MD5 8651b7be76c881e4ed044baf3f2342cc
BLAKE2b-256 816267f1be8a5e6acb3db14d7107160c9c1e212a6a0854508335acdef947e8c1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.1-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.1-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 eaee862586a910e44ac8993ed0f35763361e6ae94183b78cbabdac3a54e391b1
MD5 c961583f4f929d1d6209db2bdec799ae
BLAKE2b-256 73ae8c90b609d3eb69349c57cb9a087bf79364fd45d514c6aa92802e4c12de88

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.1-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.1-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 e09017d43b031e4592e45abde5f3ca49467c92d404f708aa051bf050e7f4a32b
MD5 d1f11759180872e9af743d7a307d73eb
BLAKE2b-256 4bf394e177a40e93b7c64a88bce33ebf58784d9979cb2f300cc507696a82627c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.1-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.1-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 7e08a0fe87af773a391a5efc39f44473ce64b5ff06db2f8c0b0a2705490a2563
MD5 5d8a9713c2542d056be9588e4eba509f
BLAKE2b-256 4ab2940b53232eb9c4c6f7573abbd50bc266cc3c5473f49087d367910a41e95c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.1-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.1-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 fc7110cbcd23b26a81b950e62b10e61c4c03709d8c05fd4ff926e0095fe04d6b
MD5 c86de9152c83987f66d51cde45c0bf66
BLAKE2b-256 9d4e74c5e5f9a80311c4937541526c220c8a81150127b60d4ca09c4c7f8805d8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.1-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.1-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 ab45c83e0d62710264a991db7122d2ef741c08c9f7b4be71e0505bfc179f1a33
MD5 3ca94757b564313abf85474a028f46d6
BLAKE2b-256 673867efc617c2086e5de63990c6aa4ec787158beec16d1ba7e4539ae76a0e6c

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