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

CHANGELOG.rst

@@ -2,6 +2,13 @@
 Changelog
 =========
 
+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.7 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

@@ -29,7 +29,7 @@
 year = '2018-2022'
 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.7 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.7 to Python 3.12
 * Microsoft Build Tools for Visual Studio 2019 (only Windows)
 * 8GB RAM
 * Intel i7 or higher CPU
@@ -36,6 +36,9 @@ For an overview of ``explorepy`` commands, click `here <https://explorepy.readth
 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.
 
+A standalone Mac installer is also available. Please contact Mentalab support to get Mac installer.
+
+
 Option 2: Installing from Python Package Index (PyPI) and pip (advanced)
 """"""""
 
@@ -68,17 +71,18 @@ Ubuntu
 
 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>`_.
 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. Run: ``brew install blueutil``, to install blueutil for bluetooth communication
+7. Connect your Explore device from Mac Bluetooth menu and run your Python script.
 
 Quick test
 ----------

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.

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/mac/create_shared_lib.sh

@@ -27,22 +27,23 @@
 #ln -s -f /usr/local/bin/python3.7 /usr/local/bin/python
 #python can be found at:
 #/Library/Frameworks/Python.framework/Versions/3.7/
-
+#For Sonoma OS: 
+#/Library/Developer/CommandLineTools/Library/Frameworks/Python3.framework/Versions/3.9/Headers
 swig -python -c++ -py3 -extranative -threads -debug-classes   swig_interface.i
 # for windows: use the -threads option 
 #swig -python -c++ -py3 -extranative -debug-classes swig_interface.i
-c++ -c -fpic swig_interface_wrap.cxx -I/usr/local/Cellar/python@3.7/3.7.11/Frameworks/Python.framework/Versions/3.7/include/python3.7m/ -ObjC++ -std=c++11
+c++ -c -fpic swig_interface_wrap.cxx -I/Library/Developer/CommandLineTools/Library/Frameworks/Python3.framework/Versions/3.9/Headers -ObjC++ -std=c++11
 
-c++ -c -fpic BluetoothDeviceResources.mm -I/usr/local/Cellar/python@3.7/3.7.11/Frameworks/Python.framework/Versions/3.7/include/python3.7m/ -ObjC++ -std=c++11
+c++ -c -fpic BluetoothDeviceResources.mm -I/Library/Developer/CommandLineTools/Library/Frameworks/Python3.framework/Versions/3.9/Headers -ObjC++ -std=c++11
 
-c++ -c -fpic BluetoothWorker.mm -I/usr/local/Cellar/python@3.7/3.7.11/Frameworks/Python.framework/Versions/3.7/include/python3.7m/ -ObjC++ -std=c++11
+c++ -c -fpic BluetoothWorker.mm -I/Library/Developer/CommandLineTools/Library/Frameworks/Python3.framework/Versions/3.9/Headers -ObjC++ -std=c++11
 
-c++ -c -fpic BTSerialPortBinding.mm -I/usr/local/Cellar/python@3.7/3.7.11/Frameworks/Python.framework/Versions/3.7/include/python3.7m/ -ObjC++ -std=c++11
+c++ -c -fpic BTSerialPortBinding.mm -I/Library/Developer/CommandLineTools/Library/Frameworks/Python3.framework/Versions/3.9/Headers -ObjC++ -std=c++11
 
-c++ -c -fpic -std=c++11 DeviceINQ.mm -I/usr/local/Cellar/python@3.7/3.7.11/Frameworks/Python.framework/Versions/3.7/include/python3.7m/ -ObjC++ -std=c++11
+c++ -c -fpic -std=c++11 DeviceINQ.mm -I/Library/Developer/CommandLineTools/Library/Frameworks/Python3.framework/Versions/3.9/Headers -ObjC++ -std=c++11
 
-gcc  -c -fpic pipe.c -I/usr/local/Cellar/python@3.7/3.7.11/Frameworks/Python.framework/Versions/3.7/include/python3.7m/
+gcc  -c -fpic pipe.c -I/Library/Developer/CommandLineTools/Library/Frameworks/Python3.framework/Versions/3.9/Headers
 
-c++ -shared -flat_namespace -undefined suppress BTSerialPortBinding.o DeviceINQ.o BluetoothDeviceResources.o BluetoothWorker.o pipe.o  swig_interface_wrap.o -std=c++11  -framework foundation -framework IOBluetooth -o _exploresdk.so
+c++ -shared -flat_namespace -arch arm64 -undefined suppress BTSerialPortBinding.o DeviceINQ.o BluetoothDeviceResources.o BluetoothWorker.o pipe.o  swig_interface_wrap.o -std=c++11  -framework foundation -framework IOBluetooth -o _exploresdk.so
 
 rm -rf *.o