Skip to main content

No project description provided

Project description

.. image:: logo.png :scale: 100 % :align: left

.. start-badges

|docs| |version| |wheel| |supported-versions| |commits-since|

.. |docs| image:: https://readthedocs.org/projects/explorepy/badge/?style=flat :target: https://readthedocs.org/projects/explorepy :alt: Documentation Status

.. |version| image:: https://img.shields.io/pypi/v/explorepy.svg :alt: PyPI Package latest release :target: https://pypi.org/project/explorepy

.. |commits-since| image:: https://img.shields.io/github/commits-since/Mentalab-hub/explorepy/v4.1.0.svg :alt: Commits since latest release :target: https://github.com/Mentalab-hub/explorepy/compare/v4.1.0...master

.. |wheel| image:: https://img.shields.io/pypi/wheel/explorepy.svg :alt: PyPI Wheel :target: https://pypi.org/project/explorepy

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/explorepy.svg :alt: Supported versions :target: https://pypi.org/project/explorepy

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/explorepy.svg :alt: Supported implementations :target: https://pypi.org/project/explorepy

.. end-badges

========================= 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.
  • Real-time visualization of ExG, orientation and environmental data.
  • Data recording in CSV and BDF+ formats.
  • Integration with LabStreaming Layer.
  • Electrode impedance measurements.
  • Explore device configuration.

Quick installation

For Windows users, the best way to install explorepy is to download the latest explorepy version from the release page <https://github.com/Mentalab-hub/explorepy/releases>_. Please note that dependencies will install automatically from the release page.

For other operating systems, or to build the package manually on Windows, please refer to the information below.

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 <https://explorepy.readthedocs.io/en/latest/installation.html>_.

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

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")  # Put your device Bluetooth name
explorer.acquire()

You can also visualize the data in real-time.

::

import explorepy
explorer = explorepy.Explore()
explorer.connect(device_name="Explore_XXXX")  # Put your device Bluetooth name

Documentation

For full API documentation, visit: https://explorepy.readthedocs.io/.

Troubleshooting

If you are having problems, please check the troubleshooting <https://explorepy.readthedocs.io/en/latest/installation.html#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

  • Mohamad Atayi_
  • Salman Rahman_
  • Andrea Escartin_
  • Sonja Stefani_
  • Alex Platt_
  • Andreas Gutsche_
  • Masooma Fazelian_
  • Philipp Jakovleski_
  • Florian Sesser_
  • Sebastian Herberger_

.. _Mohamad Atayi: https://github.com/bmeatayi .. _Salman Rahman: https://github.com/salman2135 .. _Andrea Escartin: https://github.com/andrea-escartin .. _Sonja Stefani: https://github.com/SonjaSt .. _Alex Platt: https://github.com/Nujanauss .. _Andreas Gutsche: https://github.com/andyman410 .. _Masooma Fazelian: https://github.com/fazelian .. _Philipp Jakovleski: https://github.com/philippjak .. _Florian Sesser : https://github.com/hacklschorsch .. _Sebastian Herberger: https://github.com/SHerberger

License

This project is licensed under the MIT <https://github.com/Mentalab-hub/explorepy/blob/master/LICENSE>_ license. You can reach us at contact@mentalab.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

explorepy-4.1.0.tar.gz (87.5 kB view details)

Uploaded Source

Built Distribution

explorepy-4.1.0-py2.py3-none-any.whl (62.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file explorepy-4.1.0.tar.gz.

File metadata

  • Download URL: explorepy-4.1.0.tar.gz
  • Upload date:
  • Size: 87.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for explorepy-4.1.0.tar.gz
Algorithm Hash digest
SHA256 98980bb5be681385d27f3ab1b122944f0de18254d8dda884e2a30525950da5ac
MD5 7f149200e96fe20eb213a713791db800
BLAKE2b-256 0304607509662e1496273f6dbdf84b7969cc69ab532216e2af96c9297fd71397

See more details on using hashes here.

File details

Details for the file explorepy-4.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: explorepy-4.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 62.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for explorepy-4.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bde93b883b5275dd0e00c1f2f537df21882b6678c97449f62eb2ae1da93873a0
MD5 cdd9a53d478b90103991759748091250
BLAKE2b-256 a0491a5f608e936acb9b73a9e4ae3c38d54b13c74f4b744a00abedd9c50ae37c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page