Merge pull request #34 from SoftcodingForYou/devel

V2.91.4

Author: SoftcodingForYou

README.md

@@ -16,13 +16,28 @@ Watch the introduction on Youtube:
 ## Compatible devices
 
 - BioAmp EXG Pill by Upside Down Labs
-- Muse S by InteraXon Inc.
+- Muse S 2nd Gen by InteraXon Inc. (see statement below)
 - Neuri 1.x by Helment
 - Neuri-Lolin S3-PRO by Helment
 
+
+> ⚠️ **Warning:** Muse devices are best to be used with InteraXon Inc.'s own software packages such as Muse Lab, Muse Direct and the Muse mobile app. They have been refined and optimized over years and you will have a better time using those over the NeuriGUI!
+
 ## Setup
 
-The GUI is distributed as a Python program. The GUI should work with **Python versions 3.9 or higher**.
+The GUI is distributed as a Python module and works with **Python versions 3.9 or higher**.
+
+### Installing and running
+
+The easiest way of setting up your environment is to install NeuriGUI via PiPy: `pip install neurigui`. You can then run it as follows:
+```
+import neuri.gui as ng
+ng.Run()
+```
+
+The GUI can be run directly from an IDE by calling the `Run()` function found in "./neuri/gui.py".
+
+> **ℹ️ Info:** Note that your settings are stored in a "settings.cfg" file inside the current workspace directory of the IDE or terminal.
 
 ### Preparing Python libraries
 
@@ -51,17 +66,6 @@ The GUI is packageable into a **Python module**. For this, run inside the root f
 - Windows: `python -m build`
 - GNU/Linux: `python3 -m build`
 
-### Installing and running
-
-The GUI can be run directly from an IDE by calling the `Run()` function found in "./neuri/gui.py".
-You can also **install it as a Python module** pointing pip to the root folder of the project (NeuriGUI): `pip install ./path/to/NeuriGUI`. This will install the module found in "NeuriGUI/dist". You can then run the GUI from your own scripts such as:
-```
-import neuri.gui as ng
-ng.Run()
-```
-
-Note that your settings are stored in a "settings.cfg" file inside the current workspace directory of the IDE or terminal.
-
 ## Troubleshooting
 
 1. If the GUI seems to be stuck, check the following:

dist/neurigui-2.91.2-py3-none-any.whl

@@ -2,7 +2,12 @@
 import socket
 from threading                          import Thread
 from datetime                           import datetime
-from pylsl                              import StreamInlet, resolve_stream
+from pylsl                              import StreamInlet
+try:
+    from pylsl                          import resolve_stream
+except ImportError:
+    from pylsl.resolve                  import resolve_stream
+
 
 class IOManager():
 

dist/neurigui-2.91.2.tar.gz

@@ -8,7 +8,7 @@
 
 
 from json import dumps
-from time import sleep, perf_counter
+from time import time
 from numpy import expand_dims, concatenate, append, array, zeros, reshape
 try:
     from io_manager import IOManager
@@ -74,9 +74,9 @@ def process_samples(self, transmitter, parameter, shared_buffer,
             receiver = receiver_ppg
 
         # Prealloate values of loop ---------------------------------------
-        start_time          = int(perf_counter() * 1000)
-        time_stamp_now      = int(perf_counter() * 1000) # Do NOT copy from start_time (will generate pointer)
-        time_reset          = int(perf_counter() * 1000) # Do NOT copy from start_time (will generate pointer)
+        start_time          = int(time() * 1000)
+        time_stamp_now      = int(time() * 1000) # Do NOT copy from start_time (will generate pointer)
+        time_reset          = int(time() * 1000) # Do NOT copy from start_time (will generate pointer)
         sample_count        = int(0)
 
         buffer              = zeros((parameter["max_chans"],
@@ -120,7 +120,7 @@ def process_samples(self, transmitter, parameter, shared_buffer,
             # require any additional changes from here
 
             # Current timestamp -------------------------------------------
-            time_stamp_now          = int(perf_counter() * 1000) - start_time
+            time_stamp_now          = int(raw_message_eeg[1] / 1000) - start_time
             # This will generate unchanged time_stamps for all samples of 
             # the incoming buffer (= 10 in case of bluetooth), but that is
             # not a problem

dist/neurigui-2.91.4-py3-none-any.whl

@@ -21,7 +21,7 @@ def __init__(self):
         self.frontend_path  = os.path.dirname(__file__)
 
         self.conf_file      = os.path.join(".", "settings.cfg")
-        self.version        = '2.91.1' # TO-DO: Find a more elegant way to dynamically define the current version as this line here gets forgotten a lot
+        self.version        = '2.91.4' # TO-DO: Find a more elegant way to dynamically define the current version as this line here gets forgotten a lot
         self.ico_neuri      = os.path.join(self.frontend_path, "Neuri_logo.ico")
 
         self.set_defaults() # Necessary to execute first in case user 

dist/neurigui-2.91.4.tar.gz

@@ -4,14 +4,14 @@ build-backend = "hatchling.build"
 
 [project]
 name = "neurigui"
-version = "2.91.2"
+version = "2.91.4"
 authors = [
   { name="David Marcel BAUM" },
-  { email="contact@davidbaum.org" },
+  { email="david.marcel.baum@gmail.com" },
 ]
 maintainers = [
   { name="SoftcodingForYou" },
-  { email="contact@davidbaum.org" },
+  { email="david.marcel.baum@gmail.com" },
 ]
 description = "NeuriGUI is a modular, cross-platform and FOSS app for exploring electrophysiological signals in real-time"
 keywords = ["eeg", "visualization", "digital signal processing", "DSP", "neuroscience", "electrophysiology", "real-time"]
@@ -25,7 +25,7 @@ classifiers = [
 license = {file = "LICENSE"}
 dependencies = [
   "setuptools",
-  "customtkinter==5.2.0",
+  "customtkinter",
   "numpy",
   "oauthlib",
   "Pillow",

neuri/backend/io_manager.py

@@ -1,5 +1,5 @@
 setuptools
-customtkinter==5.2.0
+customtkinter
 numpy
 oauthlib
 Pillow
@@ -8,4 +8,5 @@ PyQt5
 pyqtgraph
 pyserial
 requests
-scipy
+scipy
+pylsl