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 details)

Uploaded Source

Built Distributions

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

Uploaded CPython 3.9 Windows x86-64

spike_recorder-0.3.3-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.3-cp38-cp38-win_amd64.whl (1.9 MB view details)

Uploaded CPython 3.8 Windows x86-64

spike_recorder-0.3.3-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.3-cp37-cp37m-win_amd64.whl (1.9 MB view details)

Uploaded CPython 3.7m Windows x86-64

spike_recorder-0.3.3-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.3-cp36-cp36m-win_amd64.whl (1.9 MB view details)

Uploaded CPython 3.6m Windows x86-64

spike_recorder-0.3.3-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.3.tar.gz.

File metadata

  • Download URL: spike_recorder-0.3.3.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for spike_recorder-0.3.3.tar.gz
Algorithm Hash digest
SHA256 d019519c8b8b4f6f462b9bdc39580af95a7e62a011fac0df9939c9b4b074b1fd
MD5 bdd5a7ff3b1ba0e1e4923cbdfae52cc9
BLAKE2b-256 b59ba913c4ca0a72fbb4db57ef01c2e0a90ac155091b0996649a4f4a33c3a4c2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.3-cp39-cp39-win_amd64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.9, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for spike_recorder-0.3.3-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 fd59769e4b0a78628a7b8ff7cfcae1f48e5887ae3e6d97f4cfcb254073b3b303
MD5 7c22f63fb441c41a0d95431acd6c2841
BLAKE2b-256 cf678b7cd5ea099ae3f35a4bf20628ff662a400b1bb34bb1c6564a31534fe8f6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.3-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.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for spike_recorder-0.3.3-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 e96f4fed29f1f79cfc3e4de7f7e8e33450e9e42a5938fe2428bf832242dcbca3
MD5 7f3802548d7eec363cd11aa3b9744ae3
BLAKE2b-256 b1f7bf6d467d5a13ab702a50b10da78becd2b6f1b02b66ce64e18d828269ac48

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.3-cp38-cp38-win_amd64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.8, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for spike_recorder-0.3.3-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 dfe36fd78e55e23663ebe518dda10142e3fcb955f50ec34b39d00500d9ee74ab
MD5 abbf31889f277785d3b0af4fa9cbc41f
BLAKE2b-256 46d22b8bdce33c74385d87934d777709a7ed17bd41cbf32319743966c998b516

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.3-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.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for spike_recorder-0.3.3-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 dfbe2ea7c5aadce5910677f6266253f63f783cf05125e1206af94ab00ad7373b
MD5 beb41661b69cd4e63d2a710ce647d6cb
BLAKE2b-256 e4fb5c692223a1c6290217a8def92c8d7b19ed842de29a65eedade26fb80a6d2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.3-cp37-cp37m-win_amd64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.7m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for spike_recorder-0.3.3-cp37-cp37m-win_amd64.whl
Algorithm Hash digest
SHA256 cdd1f6a4633f08138801afeca6d6451d294ed9b65faa906f070c1dd349eacbbc
MD5 c7659de865d721436f80d9cf470ce829
BLAKE2b-256 f0bafa129635e121db6ce53c9da907fba8ed0d2e4806c9badf280bb3fb8742f0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.3-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.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for spike_recorder-0.3.3-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 a9aa153fe5e00737dfaeceba3847f74cd9ea4159054cc26c828d72341319eae8
MD5 10c66b5d4d36d5b170611b72488205f7
BLAKE2b-256 322401eca072d2594242f16abc4507871c6875c7a0173ddd387b6c94c958f5d1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.3-cp36-cp36m-win_amd64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: CPython 3.6m, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for spike_recorder-0.3.3-cp36-cp36m-win_amd64.whl
Algorithm Hash digest
SHA256 e6b43bf77079c697b42e4908b184faad6dfb26c0cb8cfc8f8211d63307274468
MD5 748df06bd99210ffe105a690315424f9
BLAKE2b-256 b2c1f64122928faf8e1a12076982deb79ef3efe648cef1aca6ba47b10b625a28

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spike_recorder-0.3.3-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.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.8

File hashes

Hashes for spike_recorder-0.3.3-cp36-cp36m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 c95c0663e0efccce60413c2a8f6e48a1f03a49993268e38f22e566af72dba54b
MD5 23c6072abf57f66db9ca9fd370d1c7cc
BLAKE2b-256 57f7d9f547afa0f60ddaa63aafa483743836e24c38c0a2b051af65a51254da17

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