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.

Authors

License

This project is licensed under the MIT license. You can reach us at contact@mentalab.com.