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
classifierwhich decodes brain data into some kind of 'brain-state' - An
actionwhich provides feedback depending on the decoded 'brain-state' - An optional
calibratorwhich runs at startup and modifies the operation of the BCI - An optional
transformerwhich transforms the currentbufferof data into the form expected by theclassifier
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
Metadata
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)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| neurol-0.0.5.tar.gz | 16.3 MB | Without provenance | Details for neurol-0.0.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| neurol-0.0.5-py3-none-any.whl | Python 3 | none | any | Details for neurol-0.0.5-py3-none-any.whl |
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
|
Security for neurol 0.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.