Release 3.0.0

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 1.8.2
+current_version = 2.0.0
 commit = False
 tag = False
 

.readthedocs.yaml

@@ -11,12 +11,9 @@ version: 2
 # Set the OS, Python version and other tools you might need
 
 build:
-
-  os: ubuntu-22.04
-
-  tools:
-
-    python: "3.11"
+    os: ubuntu-22.04
+    tools:
+        python: "3.11"
 
     # You can also specify other tool versions:
 
@@ -30,8 +27,7 @@ build:
 # Build documentation in the "docs/" directory with Sphinx
 
 sphinx:
-
-  configuration: docs/conf.py
+    configuration: docs/conf.py
 
   # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
 
@@ -58,7 +54,5 @@ sphinx:
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 
 python:
-
-   install:
-
-   - requirements: docs/requirements.txt
+    install:
+        - requirements: docs/requirements.txt

AUTHORS.rst

@@ -2,8 +2,10 @@
 Authors
 =======
 
-* Mohamad Atayi - mentalab.com
-* Masooma Fazelian - mentalab.com
+
 * Salman Rahman - mentalab.com
 * Andrea Escartin - mentalab.com
+* Sonja Stefani - mentalab.com
+* Mohamad Atayi - mentalab.com
+* Masoome Fazelian - mentalab.com
 * Alex Platt - mentalab.com

CHANGELOG.rst

@@ -2,6 +2,19 @@
 Changelog
 =========
 
+3.0.0 (7.6.2024)
+------------------
+* Improve Mac OSX support
+* Add Support for Explore Pro
+* Robust data parsing
+
+2.0.0 (5.1.2024)
+------------------
+* Add Mac OSX support
+* Remove browser based visualization support
+* Update build script for docs
+
+
 1.8.2 (28.8.2023)
 ------------------
 * Improve explore mock device

README.rst

@@ -17,9 +17,9 @@
     :target: https://pypi.org/project/explorepy
 
 
-.. |commits-since| image:: https://img.shields.io/github/commits-since/Mentalab-hub/explorepy/v1.8.2.svg
+.. |commits-since| image:: https://img.shields.io/github/commits-since/Mentalab-hub/explorepy/v2.0.0.svg
     :alt: Commits since latest release
-    :target: https://github.com/Mentalab-hub/explorepy/compare/v1.8.2...master
+    :target: https://github.com/Mentalab-hub/explorepy/compare/v2.0.0...master
 
 
 .. |wheel| image:: https://img.shields.io/pypi/wheel/explorepy.svg
@@ -54,13 +54,13 @@ 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. MAC OSX is currently not supported. 
+For other operating systems, or to build the package manually on Windows, please refer to the information below.
 
 
 Requirements
 ------------
 
-* Python 3.7 to Python 3.11.
+* 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``).
 

docs/conf.py

@@ -26,10 +26,10 @@
 source_suffix = '.rst'
 master_doc = 'index'
 project = 'explorepy'
-year = '2018-2022'
+year = '2018-2024'
 author = 'Mentalab GmbH.'
 copyright = '{0}, {1}'.format(year, author)
-version = release = '1.8.2'
+version = release = '2.0.0'
 
 pygments_style = 'trac'
 templates_path = ['.']
@@ -38,10 +38,10 @@
     'pr': ('https://github.com/Mentalab-hub/explorepy/pull/%s', 'PR #'),
 }
 # on_rtd is whether we are on readthedocs.org
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+#on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
-if not on_rtd:  # only set the theme if we're building docs locally
-    html_theme = 'sphinx_rtd_theme'
+#if not on_rtd:  # only set the theme if we're building docs locally
+html_theme = 'sphinx_rtd_theme'
 
 html_use_smartypants = True
 html_last_updated_fmt = '%b %d, %Y'

docs/installation.rst

@@ -4,14 +4,14 @@ Installation
 
 Minimal Requirements
 ------------
-* Python 3.7 to Python 3.11
+* Python 3.10 to Python 3.12
 * Microsoft Build Tools for Visual Studio 2019 (only Windows)
 * 6GB RAM (minimum 1GB *free* RAM during the session)
 * Intel i5 or higher (2x2.5GHz) CPU
 
 Recommended Requirements
 ------------
-* Python 3.7 to Python 3.11
+* Python 3.10 to Python 3.12
 * Microsoft Build Tools for Visual Studio 2019 (only Windows)
 * 8GB RAM
 * Intel i7 or higher CPU
@@ -25,16 +25,19 @@ Windows
 Option 1: Installing .exe file (basic)
 """"""""
 
-*This option is best for users who only intend to use* ``explorepy`` *from a command-line prompt.*
+*This option is best for users who only intend to use* ``explorepy`` *via graphical user interface*
 
 For example, if you want to quickly visualize and record data, use Option 1.
 If you intend to add ``explorepy`` commands to a Python script
 (e.g. an experiment script), install ``explorepy`` via Anaconda instead.
 
 For an overview of ``explorepy`` commands, click `here <https://explorepy.readthedocs.io/en/latest/usage.html#command-line-interface>`_.
 
-On a Windows machine, ``explorepy`` can be installed using the .exe installable file uploaded to
-``explorepy``'s `release page <https://github.com/Mentalab-hub/explorepy/releases/download/v1.5.0/MentaLab_ExplorePy_1.5.0.exe>`_. Please note that the dependencies will be installed automatically.
+On a Windows machine, standalone desktop software ``explorepy-desktop`` can be installed using the .exe installable file uploaded to
+`release page <https://github.com/Mentalab-hub/explore-desktop-release/releases/latest/Explore_Desktop_Pro_Win64.exe>`_. Please note that the dependencies will be installed automatically.
+
+A standalone Mac installer is also available in ` release page <https://github.com/Mentalab-hub/explore-desktop-release/releases/latest/Explore_Desktop_Pro_Mac_Apple_m.zip>`_
+
 
 Option 2: Installing from Python Package Index (PyPI) and pip (advanced)
 """"""""
@@ -48,37 +51,38 @@ To install the ``explorepy`` API and all its dependencies using pip on Windows:
 3. Open the Conda command prompt.
 4. We recommend using a virtual environment. To do this:
 
-   a. In Conda command prompt: ``conda create -n myenv python=3.8``
+   a. In Conda command prompt: ``conda create -n myenv python=3.10``
    b. Activate the virtual environment: ``conda activate myenv``
 
 5. Upgrade your pip: ``python -m pip install --upgrade pip``
 6. Run: ``pip install explorepy``, to install ``explorepy`` from PyPI.
 
 Ubuntu
 ^^^^^^
-1. Install Bluetooth header files using ``sudo apt-get install libbluetooth-dev``
-2. We recommend installing Anaconda. Download and install the `Anaconda Python 3.7 Ubuntu installer <https://www.anaconda.com/distribution/#download-section>`_.
+1. From Linux Terminal, run these commands one by one: ``sudo apt-get install libbluetooth-dev`` and ``sudo apt-get install build-essential`` and ``conda install -c conda-forge liblsl``.
+2. We recommend installing Anaconda. Download and install the `Anaconda Python 3.10 Ubuntu installer <https://www.anaconda.com/distribution/#download-section>`_.
 3. We recommend using a virtual environment in Conda. To do this:
 
-   a. In Conda command prompt: ``conda create -n myenv python=3.8``
+   a. In Conda command prompt: ``conda create -n myenv python=3.10``
    b. Activate the virtual environment: ``conda activate myenv``
 
 4. Upgrade your pip: ``python -m pip install --upgrade pip``
 5. Run: ``pip install explorepy``, to install ``explorepy`` from PyPI.
+6. From Linux Terminal, run: ``sudo apt install libxcb-cursor0``
 
 Mac
 ^^^
-Please note that Mac OSX is not supported at the moment due to some bluetooth bug from Apple OS updates.
 1. Install ``XCode`` from the Mac App store. For this, you may need to upgrade to the latest version of MacOS. For older versions of MacOS, find compatible versions of ``XCode`` `here <https://en.wikipedia.org/wiki/Xcode>`_. All old ``XCode`` versions are available `here <https://developer.apple.com/download/more/>`_.
 2. Accept the license agreement: ``sudo xcodebuild -license``
-3. It is best to install Anaconda. Download  and install the `Anaconda Python 3.7 Mac installer <https://www.anaconda.com/distribution/#download-section>`_. For older versions of MacOS, compatible version of Anaconda can be found in `this table <https://docs.continuum.io/anaconda/install/#old-os>`_ and downloaded `here <https://repo.anaconda.com/archive/index.html>`_.
+3. It is best to install Anaconda. Download  and install the `Anaconda Python 3.10 Mac installer <https://www.anaconda.com/distribution/#download-section>`_. For older versions of MacOS, compatible version of Anaconda can be found in `this table <https://docs.continuum.io/anaconda/install/#old-os>`_ and downloaded `here <https://repo.anaconda.com/archive/index.html>`_.
 4. We recommend using a virtual environment in Conda.
 
-   a. In Conda command prompt: ``conda create -n myenv python=3.8``
+   a. In Conda command prompt: ``conda create -n myenv python=3.10``
    b. Activate the virtual environment: ``conda activate myenv``
 
 5. Upgrade your pip: ``python -m pip install --upgrade pip``
 6. Run: ``pip install explorepy``, to install ``explorepy`` from PyPI.
+7. Connect your Explore device from Mac Bluetooth menu and run your Python script.
 
 Quick test
 ----------
@@ -91,75 +95,19 @@ Quick test
 Troubleshooting
 ---------------
 
-**1. Pylsl import issue**
-
-::
-
-        self._handle = _dlopen(self._name, mode)
-    OSError: [WinError 126] The specified module could not be found
-
-
-Solution: Install an older version of Pylsl. To do this, run: ::
-
-    pip install pylsl==1.13.1
-
-Alternatively, install `MS Visual C++ redistributable (vc_redist) <https://support.microsoft.com/en-ca/help/2977003/the-latest-supported-visual-c-downloads>`_.
-
---------------------
-
-
-**2. Anaconda asyncio events library raises "NotImplementedError" error in Windows**
-
-::
-
-    File "c:\users\jose\anaconda3\lib\site-packages\bokeh\server\server.py", line 407, in __init__
-        http_server.add_sockets(sockets)
-    File "c:\users\jose\anaconda3\lib\site-packages\tornado\tcpserver.py", line 165, in add_sockets
-        self._handlers[sock.fileno()] = add_accept_handler(
-    File "c:\users\jose\anaconda3\lib\site-packages\tornado\netutil.py", line 279, in add_accept_handler
-        io_loop.add_handler(sock, accept_handler, IOLoop.READ)
-    File "c:\users\jose\anaconda3\lib\site-packages\tornado\platform\asyncio.py", line 100, in add_handler
-        self.asyncio_loop.add_reader(fd, self._handle_events, fd, IOLoop.READ)
-    File "c:\users\jose\anaconda3\lib\asyncio\events.py", line 501, in add_reader
-        raise NotImplementedError
-
-Solution: Downgrade your Anaconda distribution to version 3.6 or 3.7.
-
----------------------
-
-**3. No module named 'numpy'**
-
-::
-
-    ERROR: Command errored out with exit status 4294967295:
-     command: 'C:\Users\mh\Anaconda3\envs\test130_38\python.exe' -c 'import sys, setuptools, tokenize; sys.argv[0] = '"'"'C:\\Users\\mh_at\\AppData\\Local\\Temp\\pip-install-6fpsl7b1\\pyedflib_e1c2dcc3a4dc46af9468c24083cbda2b\\setup.py'"'"'; __file__='"'"'C:\\Users\\mh_at\\AppData\\Local\\Temp\\pip-install-6fpsl7b1\\pyedflib_e1c2dcc3a4dc46af9468c24083cbda2b\\setup.py'"'"';f=getattr(tokenize, '"'"'open'"'"', open)(__file__);code=f.read().replace('"'"'\r\n'"'"', '"'"'\n'"'"');f.close();exec(compile(code, __file__, '"'"'exec'"'"'))' egg_info --egg-base 'C:\Users\mh_at\AppData\Local\Temp\pip-pip-egg-info-48yn2fu3'
-         cwd: C:\Users\mh\AppData\Local\Temp\pip-install-6fpsl7b1\pyedflib_e1c2dcc3a4dc46af9468c24083cbda2b\
-    Complete output (4 lines):
-    No module named 'numpy'
-    *** package "numpy" not found ***
-    pyEDFlib requires a version of NumPy, even for setup.
-    Please get it from http://numpy.scipy.org/ or install it through your package manager.
-    ----------------------------------------
-    ERROR: Command errored out with exit status 4294967295: python setup.py egg_info Check the logs for full command output.
-
-
-Solution: Install numpy separately using ``pip install numpy`` and then install ``explorepy``.
-
----------------------
-
-**4. OSError: A socket operation was attempted to an unreachable network.**
+**1. OSError: A socket operation was attempted to an unreachable network.**
 
 Solution: Ensure that your Explore device is paired with your computer and try again.
 
 ---------------------
 
-**5. ValueError: Error opening socket.**
+**2. ValueError: Error opening socket.**
 
 Solution: Ensure the Bluetooth module of your computer's operating system is on and working.
 
 ---------------------
 
-**6. OSError: The handle is invalid.**
+**3. OSError: The handle is invalid.**
 
 Solution: Ensure the Bluetooth module of your computer's operating system is on and working.
 

docs/requirements.txt

@@ -12,3 +12,5 @@ PyYAML==6.0.1
 scipy==1.11.1
 sentry_sdk==1.19.1
 tornado==6.3.2
+sphinx-rtd-theme==1.3.0
+sphinx==7.2.4

examples/p300_demo/analysis_csv_4_channel.py

@@ -67,8 +67,8 @@ def main():
     lf = .5
     hf = 40
 
-    label_target = 11
-    label_nontarget = 10
+    label_target = 'sw_11'
+    label_nontarget = 'sw_10'
 
     t_min = -.3
     t_max = 1.

examples/p300_demo/analysis_csv_8_channel.py

@@ -67,8 +67,8 @@ def main():
     lf = .5
     hf = 40
 
-    label_target = 11
-    label_nontarget = 10
+    label_target = 'sw_11'
+    label_nontarget = 'sw_10'
 
     t_min = -.3
     t_max = 1.

examples/ssvep_demo/ssvep.py

@@ -4,6 +4,7 @@
 """
 import time
 from threading import Lock
+from psychopy_visionscience.radial import RadialStim
 from psychopy import visual, event
 import numpy as np
 from analysis import CCAAnalysis
@@ -29,9 +30,9 @@ def __init__(self, window, size, position, n_frame, log_time=False):
         pattern = np.ones((4, 4))
         pattern[::2, ::2] *= -1
         pattern[1::2, 1::2] *= -1
-        self._stim1 = visual.RadialStim(win=self._window, tex=pattern, pos=position,
+        self._stim1 = RadialStim(win=self._window, tex=pattern, pos=position,
                                         size=size, radialCycles=1, texRes=256, opacity=1)
-        self._stim2 = visual.RadialStim(win=self._window, tex=pattern*-1, pos=position,
+        self._stim2 = RadialStim(win=self._window, tex=pattern*-1, pos=position,
                                         size=size, radialCycles=1, texRes=256, opacity=1)
         self._toggle_flag = False
         self.log_time = log_time

installer/windows/README.md

@@ -26,7 +26,7 @@ Tested versions in (brackets).
 
   - [NSIS - the Nullsoft Scriptable Install System](https://nsis.sourceforge.io/) (3.06.1)
   - [Microsoft Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=BuildTools&rel=16)
-  - A local python installation with virtual env support (3.7.7)
+  - A local python installation with virtual env support (3.10)
 
 
 #### Python wheels

installer/windows/installer.cfg

@@ -1,6 +1,6 @@
 [Application]
 name=MentaLab ExplorePy
-version=1.8.2
+version=2.0.0
 entry_point=explorepy.cli:cli
 console=true
 icon=mentalab.ico
@@ -26,6 +26,7 @@ pypi_wheels =
     decorator==5.1.1
     distlib==0.3.7
     eeglabio==0.0.2.post4
+    explorepy==2.0.0
     fonttools==4.42.1
     idna==3.4
     importlib-resources==6.0.1

lib/linux/ExploreException.h

@@ -83,3 +83,22 @@ class ExploreIOException : std::exception
 	}
 
 };
+
+// class to throw exception when no BT service is available
+class ExploreNoBluetoothException : std::exception
+{
+private:
+	std::string message;
+public:
+	ExploreNoBluetoothException(std::string message) NOEXCEPT
+	{
+		this->message = message;
+
+	}
+
+	virtual const char* what() const NOEXCEPT
+	{
+		return message.c_str();
+	}
+
+};