Skip to main content

A package for modularly implenting Brain-Computer Interfaces

Project description

neurol logo

Python 3.6+ PyPI Documentation Status PR welcome PyPI - License

Neurol is a python package for implementing Brain-Computer Interfaces in a modular manner. With the help of tools in this package, you will be able define the behavior of your intended BCI and easily implement it. A neurol BCI is defined by a number of components:

  • A classifier which decodes brain data into some kind of 'brain-state'
  • An action which provides feedback depending on the decoded 'brain-state'
  • An optional calibrator which runs at startup and modifies the operation of the BCI
  • An optional transformer which transforms the current buffer of data into the form expected by the classifier

The neurol BCI manages an incoming stream of brain data and uses the above user-defined functions to run a brain-computer interface.

The package includes generic utility functions to aid in creating classifier's, transfromer's, and calibrator's for common BCI use-cases. It also comes prepackaged with a growing list of trained machine learning models for common BCI classification tasks.

Installation

neurol can be easily installed using pip:

$ pip install neurol

Documentation

Please find neurol's documentation here.

You can also find example notebooks in the examples directory.

Contact

If you have questions or would like to discuss this package, please don't hesitate to contact me.

Awni Altabaa - awni.altabaa@queensu.ca / awnyaltabaa@gmail.com

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

neurol-0.0.5.tar.gz (16.3 MB view details)

Uploaded Source

Built Distribution

neurol-0.0.5-py3-none-any.whl (16.3 MB view details)

Uploaded Python 3

File details

Details for the file neurol-0.0.5.tar.gz.

File metadata

  • Download URL: neurol-0.0.5.tar.gz
  • Upload date:
  • Size: 16.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for neurol-0.0.5.tar.gz
Algorithm Hash digest
SHA256 28f6800c876083f4363fc3689aaa464b78dc23a8c400749e90abde155da8f8e4
MD5 3559782a0395e00b4ba03293ea6bba4a
BLAKE2b-256 971b854fcd862a986c7606c897b3c1cc4596d5c2a7c1fec518e4c3977ee849b8

See more details on using hashes here.

File details

Details for the file neurol-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: neurol-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 16.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for neurol-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0f9103317e7ebbfe874f5482912d819fca53b54a509e3fbd98014835659143f7
MD5 6de6f155e698557d6f0fb2f425bc88eb
BLAKE2b-256 7b6f13eefe176ccdabc2d35452eb67cb3e1c36d1fd03cf5b7682c949cd9ed0dc

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