ExplorePy overview
ExplorePy is an open-source Python API designed to collect and process ExG data using Mentalab’s Explore device. Amongst other things, ExplorePy provides the following features:
Real-time streaming of ExG, orientation and environmental data.
Data recording in CSV and BDF+ formats.
Integration with LabStreaming Layer.
Electrode impedance measurements.
Explore device configuration.
Requirements
Python 3.10 to Python 3.12.
Visual Studio 2015 community edition (Windows only. For package building).
Bluetooth header files (Linux only. Use: sudo apt-get install libbluetooth-dev).
Detailed installation instructions can be found on the installation page.
To install ExplorePy from PyPI run:
pip install explorepy
To install the latest development version (git must be installed before running this command):
pip install git+https://github.com/Mentalab-hub/explorepy.git@develop
Get started
CLI command
To check ExplorePy is running use:
explorepy acquire -n Explore_XXXX
For help, use:
explorepy -h
Python code
In Python you can connect to the Explore device and print data using:
import explorepy explorer = explorepy.Explore() explorer.connect(device_name="Explore_XXXX") # Use correct device ID here explorer.acquire()
Documentation
For full API documentation, visit: https://explorepy.readthedocs.io/.
Troubleshooting
If you are having problems, please check the troubleshooting section of the documentation.
If you are still having problems, send us your error log via Sentry (note: Explorepy will send the log automatically once you have provided permission), or send us the log file via email to support@mentalab.com. The log file is usually found under:
Windows: <Windows Drive>:\Users\<USER_NAME>\AppData\Local\mentalab\explorepy\Logs\explorepy.log
Ubuntu: /home/<USER_NAME>/.cache/explorepy/log/explorepy.log
Mac OS: /Users/<USER_NAME>/Library/Logs/explorepy/explorepy.log
You can also create a new issue in the GitHub repository.
License
This project is licensed under the MIT license. You can reach us at contact@mentalab.com.
1 maintainer
Metadata
1 maintainer
Release files for explorepy 4.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| explorepy-4.5.1.tar.gz | 113.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| explorepy-4.5.1-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 200.5 kB
Release files / explorepy-4.5.1.tar.gz
| Download URL | explorepy-4.5.1.tar.gz |
|---|---|
| Size | 113.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6c4d3be0f483ee1d674b60b84aee97de2bebb2002bf755510bd9e27951a634e5
|
|
BLAKE2b-256 checksum How to use checksums |
b5be9f1232c64809be03913cb2d34841dbe6622cb396e303bf5a7b7433f7c271
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|
Release files / explorepy-4.5.1-py2.py3-none-any.whl
| Download URL | explorepy-4.5.1-py2.py3-none-any.whl |
|---|---|
| Size | 86.9 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
8850374f551b20da7a14c1128505df6907dfcb203a2aeb9dbda9ed0bc50f46f0
|
|
BLAKE2b-256 checksum How to use checksums |
a7f1819768e7db50add40ae0d715bf2a08e5edd87604333c3f5103840ddcb3e1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|
