Metadata-Version: 1.1
Name: explorepy
Version: 0.3.0
Summary: Python API for Mentalab biosignal aquisition devices
Home-page: https://github.com/Mentalab-hub/explorepy
Author: Mohamad Atayi
Author-email: bmeatayi@gmail.com
License: MIT license
Description: =========
        explorepy
        =========
        
        .. image:: logo.png
           :scale: 100 %
           :align: center
        
        ========
        Overview
        ========
        
        
        
        
        A Python API for Mentalab biosignal aquisition devices
        
        Requirements
        ============
        * Python 3.5 or newer version
        * `numpy <https://github.com/pybluez/pybluez>`_
        * `pybluez <https://github.com/pybluez/pybluez>`_ (check their repo for the requirements of pybluez)
        * `pylsl <https://github.com/labstreaminglayer/liblsl-Python>`_
        * `scipy <https://github.com/scipy/scipy>`_
        * `bokeh <https://github.com/bokeh/bokeh>`_
        
        
        Installation
        ============
        To install ``explorepy`` from PyPI run:
        ::
        
            pip install explorepy
        
        
        To install the latest development version run:
        ::
        
            pip install git+https://github.com/Mentalab-hub/explorepy
        
        
        Example use
        ===========
        CLI command:
        ``explorepy acquire -n Explore_XXXX``
        
        Enter ``explorepy -h`` for help.
        
        
        The following code connects to the Explore device and prints the data.
        
        ::
        
            import explorepy
            explorer = explorepy.Explore()
            explorer.connect(device_name="Explore_XXXX")  # Put your device Bluetooth name
            explorer.acquire()
        
        You can also visualize signal in real-time.
        
        ::
        
            import explorepy
            explorer = explorepy.Explore()
            explorer.connect(device_name="Explore_XXXX")  # Put your device Bluetooth name
            explorer.visualize(n_chan=4)  # Give number of channels (2, 4 or 8)
        
        EEG:
        
        .. image:: images/Dashboard_EEG.jpg
          :width: 800
          :alt: EEG Dashboard
        
        ECG with heart beat detection:
        
        .. image:: images/Dashboard_ECG.jpg
          :width: 800
          :alt: ECG Dashboard
        
        Documentation
        =============
        
        To see full documentation of the API, visit: https://explorepy.readthedocs.io/
        
        
        Authors
        =======
        - `Sebastian Herberger`_
        - `Mohamad Atayi`_
        - `Philipp Jakovleski`_
        - `Andreas Gutsche`_
        
        .. _Sebastian Herberger: https://github.com/SHerberger
        .. _Mohamad Atayi: https://github.com/bmeatayi
        .. _Philipp Jakovleski: https://github.com/philippjak
        .. _Andreas Gutsche: https://github.com/andyman410
        
        
        
        
        
        
        
        
        Changelog
        =========
        
        0.3.0 (10-05-2019)
        ------------------
        * Explore dashboard
        * Real-time visualization of ExG and orientation signal
        * Device information in Dashboard
        * Environmental data (battery, temperature and light)
        * Real-time bandpass filter
        * New packet structures (ADS1294R & ADS1298R)
        * Heart rate estimation and R-peaks detector in dashboard
        
        
        0.2.0 (2019-03-08)
        ------------------
        
        * Added real-time recording feature
        * Added Command Line Interface
        * Added lsl integration
        * Added new packet classes
        * Fixed reconnect issues
        * Removed input requests inside functions
        
        
        0.1.0 (2019-01-18)
        ------------------
        
        * First release on PyPI.
        
Keywords: Mentalab,Explorepy,EEG signal
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Scientific/Engineering :: Visualization
