Skip to main content

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

Release files for neurol 0.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for neurol 0.0.5
File Size Uploaded
neurol-0.0.5.tar.gz 16.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for neurol 0.0.5
File Interpreter ABI Platform
neurol-0.0.5-py3-none-any.whl Python 3 none any Details

Total release size: 32.7 MB

Release files / neurol-0.0.5.tar.gz

Download URL neurol-0.0.5.tar.gz
Size 16.3 MB
Tags Source
SHA-256 checksum
How to use checksums
28f6800c876083f4363fc3689aaa464b78dc23a8c400749e90abde155da8f8e4
BLAKE2b-256 checksum
How to use checksums
971b854fcd862a986c7606c897b3c1cc4596d5c2a7c1fec518e4c3977ee849b8
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / neurol-0.0.5-py3-none-any.whl

Download URL neurol-0.0.5-py3-none-any.whl
Size 16.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
0f9103317e7ebbfe874f5482912d819fca53b54a509e3fbd98014835659143f7
BLAKE2b-256 checksum
How to use checksums
7b6f13eefe176ccdabc2d35452eb67cb3e1c36d1fd03cf5b7682c949cd9ed0dc
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

This release

0.0.5 This release

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page