| Name | explorepy JSON |
| Version |
4.2.0
JSON |
| download |
| home_page | None |
| Summary | None |
| upload_time | 2025-07-15 15:20:34 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
.. image:: https://raw.githubusercontent.com/Mentalab-hub/explorepy/master/docs/logo.jpg
: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.2.0.svg
:alt: Commits since latest release
:target: https://github.com/Mentalab-hub/explorepy/compare/v4.2.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.
* 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 <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.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 <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`_
- `Masoome 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
.. _Masoome 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "explorepy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "MentaLab Hub <support@mentab.org>",
"download_url": "https://files.pythonhosted.org/packages/8c/75/e4a05576a8334fce7cee4ef15d228d8bbad0ab4098a27fad049083f5a8e2/explorepy-4.2.0.tar.gz",
"platform": null,
"description": ".. image:: https://raw.githubusercontent.com/Mentalab-hub/explorepy/master/docs/logo.jpg\r\n :scale: 100 %\r\n :align: left\r\n\r\n\r\n.. start-badges\r\n\r\n|docs| |version| |wheel| |supported-versions| |commits-since|\r\n\r\n.. |docs| image:: https://readthedocs.org/projects/explorepy/badge/?style=flat\r\n :target: https://readthedocs.org/projects/explorepy\r\n :alt: Documentation Status\r\n\r\n\r\n.. |version| image:: https://img.shields.io/pypi/v/explorepy.svg\r\n :alt: PyPI Package latest release\r\n :target: https://pypi.org/project/explorepy\r\n\r\n\r\n.. |commits-since| image:: https://img.shields.io/github/commits-since/Mentalab-hub/explorepy/v4.2.0.svg\r\n :alt: Commits since latest release\r\n :target: https://github.com/Mentalab-hub/explorepy/compare/v4.2.0...master\r\n\r\n\r\n.. |wheel| image:: https://img.shields.io/pypi/wheel/explorepy.svg\r\n :alt: PyPI Wheel\r\n :target: https://pypi.org/project/explorepy\r\n\r\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/explorepy.svg\r\n :alt: Supported versions\r\n :target: https://pypi.org/project/explorepy\r\n\r\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/explorepy.svg\r\n :alt: Supported implementations\r\n :target: https://pypi.org/project/explorepy\r\n\r\n\r\n.. end-badges\r\n\r\n\r\n=========================\r\n``explorepy`` overview\r\n=========================\r\n\r\n``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:\r\n\r\n* Real-time streaming of ExG, orientation and environmental data.\r\n* Data recording in CSV and BDF+ formats.\r\n* Integration with LabStreaming Layer.\r\n* Electrode impedance measurements.\r\n* Explore device configuration.\r\n\r\n\r\nRequirements\r\n------------\r\n\r\n* Python 3.10 to Python 3.12.\r\n* Visual Studio 2015 community edition (Windows only. For package building).\r\n* Bluetooth header files (Linux only. Use: ``sudo apt-get install libbluetooth-dev``).\r\n\r\n\r\nDetailed installation instructions can be found on the `installation page <https://explorepy.readthedocs.io/en/latest/installation.html>`_.\r\n\r\nTo install ``explorepy`` from PyPI run:\r\n::\r\n\r\n pip install explorepy\r\n\r\n\r\nTo install the latest development version (git must be installed before running this command):\r\n::\r\n\r\n pip install git+https://github.com/Mentalab-hub/explorepy.git@develop\r\n\r\n\r\nGet started\r\n===========\r\n\r\nCLI command\r\n-----------\r\nTo check ``explorepy`` is running use:\r\n::\r\n explorepy acquire -n Explore_XXXX\r\n\r\nFor help, use:\r\n::\r\n explorepy -h\r\n\r\n\r\nPython code\r\n-----------\r\n\r\nIn Python you can connect to the Explore device and print data using:\r\n\r\n::\r\n\r\n import explorepy\r\n explorer = explorepy.Explore()\r\n explorer.connect(device_name=\"Explore_XXXX\") # Use correct device ID here\r\n explorer.acquire()\r\n\r\nDocumentation\r\n=============\r\n\r\nFor full API documentation, visit: https://explorepy.readthedocs.io/.\r\n\r\nTroubleshooting\r\n===============\r\nIf you are having problems, please check the `troubleshooting <https://explorepy.readthedocs.io/en/latest/installation.html#troubleshooting>`_\r\nsection of the documentation.\r\n\r\nIf you are still having problems, send us your error log via Sentry (note: Explorepy will send the log\r\nautomatically once you have provided permission), or send us the log file via email to support@mentalab.com. The log file is usually found under:\r\n\r\n* Windows: ``<Windows Drive>:\\Users\\<USER_NAME>\\AppData\\Local\\mentalab\\explorepy\\Logs\\explorepy.log``\r\n* Ubuntu: ``/home/<USER_NAME>/.cache/explorepy/log/explorepy.log``\r\n* Mac OS: ``/Users/<USER_NAME>/Library/Logs/explorepy/explorepy.log``\r\n\r\nYou can also create a new issue in the GitHub repository.\r\n\r\nAuthors\r\n=======\r\n- `Mohamad Atayi`_\r\n- `Salman Rahman`_\r\n- `Andrea Escartin`_\r\n- `Sonja Stefani`_\r\n- `Alex Platt`_\r\n- `Andreas Gutsche`_\r\n- `Masoome Fazelian`_\r\n- `Philipp Jakovleski`_\r\n- `Florian Sesser`_\r\n- `Sebastian Herberger`_\r\n\r\n\r\n.. _Mohamad Atayi: https://github.com/bmeatayi\r\n.. _Salman Rahman: https://github.com/salman2135\r\n.. _Andrea Escartin: https://github.com/andrea-escartin\r\n.. _Sonja Stefani: https://github.com/SonjaSt\r\n.. _Alex Platt: https://github.com/Nujanauss\r\n.. _Andreas Gutsche: https://github.com/andyman410\r\n.. _Masoome Fazelian: https://github.com/fazelian\r\n.. _Philipp Jakovleski: https://github.com/philippjak\r\n.. _Florian Sesser : https://github.com/hacklschorsch\r\n.. _Sebastian Herberger: https://github.com/SHerberger\r\n\r\nLicense\r\n=======\r\nThis project is licensed under the `MIT <https://github.com/Mentalab-hub/explorepy/blob/master/LICENSE>`_ license. You can reach us at contact@mentalab.com.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": null,
"version": "4.2.0",
"project_urls": {
"Homepage": "https://github.com/Mentalab-hub/explorepy"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7397d51ed1a7e891778897ddc5d374a9e89c5af273e90e1aa3c4100546617775",
"md5": "be8093a53a877b3ade24bde898d6a3db",
"sha256": "8b0bbf67f8a568b8ef5d13d0311b2919482974d783ae44df0e2252040d706231"
},
"downloads": -1,
"filename": "explorepy-4.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "be8093a53a877b3ade24bde898d6a3db",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 59878,
"upload_time": "2025-07-15T15:20:33",
"upload_time_iso_8601": "2025-07-15T15:20:33.554025Z",
"url": "https://files.pythonhosted.org/packages/73/97/d51ed1a7e891778897ddc5d374a9e89c5af273e90e1aa3c4100546617775/explorepy-4.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8c75e4a05576a8334fce7cee4ef15d228d8bbad0ab4098a27fad049083f5a8e2",
"md5": "1a558614d43e595ba680d6973412356d",
"sha256": "7db09e62fa5c00ba66d6949ea5f47101f0e9df10ade630896636d85b5618e8c7"
},
"downloads": -1,
"filename": "explorepy-4.2.0.tar.gz",
"has_sig": false,
"md5_digest": "1a558614d43e595ba680d6973412356d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 84136,
"upload_time": "2025-07-15T15:20:34",
"upload_time_iso_8601": "2025-07-15T15:20:34.995544Z",
"url": "https://files.pythonhosted.org/packages/8c/75/e4a05576a8334fce7cee4ef15d228d8bbad0ab4098a27fad049083f5a8e2/explorepy-4.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-15 15:20:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Mentalab-hub",
"github_project": "explorepy",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "explorepy"
}
