emg-gui 0.0.5__tar.gz

emg_gui-0.0.5/LICENSE.md

@@ -0,0 +1,24 @@
+# License
+
+MIT License
+
+Copyright (c) 2026 Nikhil Pareek
+Contact: [nikhilpareek149@gmail.com](mailto:nikhilpareek149@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

emg_gui-0.0.5/PKG-INFO

@@ -0,0 +1,206 @@
+Metadata-Version: 2.4
+Name: emg-gui
+Version: 0.0.5
+Summary: 
+License-File: LICENSE.md
+Author: Nikhil Pareek
+Author-email: nikhilpareek149@gmail.com
+Maintainer: Nikhil Pareek
+Maintainer-email: nikhilpareek149@gmail.com
+Requires-Python: ==3.12.10
+Classifier: Programming Language :: Python :: 3
+Requires-Dist: PyQt5 (==5.15.11)
+Requires-Dist: PyQt5-Qt5 (==5.15.19) ; sys_platform != "win32"
+Requires-Dist: PyQt5-Qt5 (==5.15.2) ; sys_platform == "win32"
+Requires-Dist: PyQt5-sip (==12.17.1)
+Requires-Dist: brainflow (==5.16.0)
+Requires-Dist: dvg-ringbuffer (==1.1.0)
+Requires-Dist: freetype-py (==2.5.1)
+Requires-Dist: librosa (==0.11.0)
+Requires-Dist: matplotlib (==3.9.4)
+Requires-Dist: moderngl (==5.12.0)
+Requires-Dist: numpy (==1.26.4)
+Requires-Dist: pyrr (==0.10.3)
+Requires-Dist: pyserial (==3.5)
+Requires-Dist: setuptools (==80.10.2)
+Requires-Dist: typing-extensions (==4.16.0)
+Project-URL: Documentation, https://pareeknikhil.github.io/
+Project-URL: Homepage, https://github.com/pareeknikhil/emg-gui
+Project-URL: Issues, https://github.com/pareeknikhil/emg-gui/issues
+Description-Content-Type: text/markdown
+
+# <img src="docs/diagrams/Ability_Logomark.svg" alt="Ability logomark" width="48" align="absmiddle"> emg-gui
+
+## 1. Overview
+
+### 1.1 Introduction
+
+A real-time visual engine for acquiring, recording, and exploring raw and filtered EMG signals.
+
+### 1.2 Installation
+
+EMG-GUI can be installed from pypi using pip:
+
+```bash
+pip install emg-gui
+```
+
+### 1.3 How to Run
+
+TODO
+
+---
+
+## 2. Architecture and Project Structure
+
+### 2.1 Architecture
+
+The application separates sensor acquisition, interface controls, signal
+processing, and GPU rendering. Sensor polling and board stream control run on a
+dedicated thread, while Qt interface updates, filtering, and ModernGL rendering
+currently run on the main thread.
+
+```text
+EMG GUI
+├── app.py
+├── Acquisition
+│   ├── DataSource
+│   └── SensorWorker
+│       └── RingBuffer
+├── UI
+│   ├── EMGVisualizerWindow
+│   └── EMGControlPanel
+├── Processing
+│   ├── EMG filtering
+│   └── Window functions
+└── Visualization
+    ├── EMGOpenGLWidget
+    ├── TimeSeriesRenderer
+    ├── SpectrogramRenderer
+    ├── TicksRenderer
+    └── TextRenderer
+```
+
+The `DataSource` provides hardware-independent acquisition from either an
+OpenBCI board or a playback recording. The current application entry point uses
+`OpenBCIBoard` by default, with playback available as an alternate source.
+`SensorWorker` reads EMG samples into a fixed-size ring buffer, and
+`EMGOpenGLWidget` owns duplicate-snapshot checks, snapshot filtering, and
+ModernGL rendering. `TimeSeriesRenderer` and `SpectrogramRenderer` are connected
+to the live rendering path. Channel counts come from the selected data source,
+so synthetic and real boards can expose different numbers of EMG channels. The
+display window is sample-based, while the rendered layout is derived from the
+OpenGL widget size and the selected EMG channel count.
+
+See the [architecture guide](docs/architecture.md) for the detailed component
+hierarchy, data flow, and thread interaction sequences.
+
+### 2.2 Directory Layout
+
+Inside this project, you'll see the following folders and files:
+
+```text
+/
+├── docs/
+│   ├── diagrams/
+│   │   ├── Ability_Logo.svg
+│   │   └── interface-contracts.svg
+│   └── architecture.md
+├── src/
+│   └── emg_gui/
+│       ├── app.py
+│       ├── acquisition/
+│       │   ├── data_source.py
+│       │   ├── dataset_files.py
+│       │   └── sensor_worker.py
+│       ├── config/
+│       │   ├── constants.py
+│       │   └── Roboto-Black.ttf
+│       ├── core/
+│       │   ├── enums.py
+│       │   ├── logger.py
+│       │   └── types.py
+│       ├── processing/
+│       │   ├── filter.py
+│       │   └── window_functions.py
+│       ├── ui/
+│       │   ├── control_panel.py
+│       │   └── window.py
+│       └── visualizer/
+│           ├── shaders/
+│           │   ├── shader_loader.py
+│           │   ├── spec/
+│           │   │   ├── vertex.glsl
+│           │   │   └── fragment.glsl
+│           │   ├── text/
+│           │   │   ├── vertex.glsl
+│           │   │   └── fragment.glsl
+│           │   ├── ticks/
+│           │   │   ├── vertex.glsl
+│           │   │   └── fragment.glsl
+│           │   └── time_series/
+│           │       ├── vertex.glsl
+│           │       └── fragment.glsl
+│           ├── open_gl_widget.py
+│           ├── spectrogram_renderer.py
+│           ├── text_renderer.py
+│           ├── ticks_renderer.py
+│           └── time_series_renderer.py
+├── tests/
+├── CONTRIBUTING.md
+├── pyproject.toml
+└── README.md
+```
+
+---
+
+## 3. Contributing
+
+Contributions are welcome. See the [contributing guide](CONTRIBUTING.md) for
+development and linting guidelines.
+
+---
+
+## 4. Acknowledgements
+
+### 4.1 BrainFlow
+
+This project uses [BrainFlow](https://brainflow.readthedocs.io/en/stable/) for
+biosignal acquisition and hardware integration. BrainFlow provides a uniform
+API for acquiring, parsing, and analyzing EEG, EMG, ECG, and other biosensor
+data across a wide range of supported boards, including OpenBCI devices.
+BrainFlow is distributed under the
+[MIT License](https://github.com/brainflow-dev/brainflow/blob/master/LICENSE).
+
+### 4.2 ModernGL Spectrogram
+
+This project uses
+[nickcercone/spectrogram](https://github.com/nickcercone/spectrogram) as a
+reference for parts of its ModernGL spectrogram rendering implementation. The
+referenced project demonstrates real-time audio spectrogram visualization
+using ModernGL and is distributed under the
+[MIT License](https://github.com/nickcercone/spectrogram/blob/main/LICENCE).
+
+### 4.3 Text Rendering
+
+This project adapts the code in
+[How to render text with PyOpenGL?](https://stackoverflow.com/questions/63836707/how-to-render-text-with-pyopengl)
+by exiled (question) and Rabbid76 (answer) for its ModernGL text renderer.
+The referenced contributions demonstrate text rendering with PyOpenGL and are
+distributed under the
+[CC BY-SA 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).
+
+---
+
+## 5. Tech Debt
+
+1. Add setup and installation instructions to this readme.
+2. Create new repo-emg-ability (create import and remove run.sh).
+3. Folder portability use [EMGFlow](https://github.com/WiIIson/EMGFlow-Python-Package/tree/main) & [system path](https://www.youtube.com/watch?v=v6tALyc4C10&t=3s) reference.
+4. Add legends for raw and filtered emg in timeseries renderer.
+5. Processing latency in the performance metrics.
+6. Improve the GUI toggle controls and expose their options in the left sidebar.
+7. Add timer and countdown visualizations.
+8. Move signal processing from the GUI thread to a dedicated processing thread.
+9. Move the complete data-source lifecycle into the sensor thread, including initialization, streaming, recording, stopping, and release.
+

emg_gui-0.0.5/README.md

@@ -0,0 +1,174 @@
+# <img src="docs/diagrams/Ability_Logomark.svg" alt="Ability logomark" width="48" align="absmiddle"> emg-gui
+
+## 1. Overview
+
+### 1.1 Introduction
+
+A real-time visual engine for acquiring, recording, and exploring raw and filtered EMG signals.
+
+### 1.2 Installation
+
+EMG-GUI can be installed from pypi using pip:
+
+```bash
+pip install emg-gui
+```
+
+### 1.3 How to Run
+
+TODO
+
+---
+
+## 2. Architecture and Project Structure
+
+### 2.1 Architecture
+
+The application separates sensor acquisition, interface controls, signal
+processing, and GPU rendering. Sensor polling and board stream control run on a
+dedicated thread, while Qt interface updates, filtering, and ModernGL rendering
+currently run on the main thread.
+
+```text
+EMG GUI
+├── app.py
+├── Acquisition
+│   ├── DataSource
+│   └── SensorWorker
+│       └── RingBuffer
+├── UI
+│   ├── EMGVisualizerWindow
+│   └── EMGControlPanel
+├── Processing
+│   ├── EMG filtering
+│   └── Window functions
+└── Visualization
+    ├── EMGOpenGLWidget
+    ├── TimeSeriesRenderer
+    ├── SpectrogramRenderer
+    ├── TicksRenderer
+    └── TextRenderer
+```
+
+The `DataSource` provides hardware-independent acquisition from either an
+OpenBCI board or a playback recording. The current application entry point uses
+`OpenBCIBoard` by default, with playback available as an alternate source.
+`SensorWorker` reads EMG samples into a fixed-size ring buffer, and
+`EMGOpenGLWidget` owns duplicate-snapshot checks, snapshot filtering, and
+ModernGL rendering. `TimeSeriesRenderer` and `SpectrogramRenderer` are connected
+to the live rendering path. Channel counts come from the selected data source,
+so synthetic and real boards can expose different numbers of EMG channels. The
+display window is sample-based, while the rendered layout is derived from the
+OpenGL widget size and the selected EMG channel count.
+
+See the [architecture guide](docs/architecture.md) for the detailed component
+hierarchy, data flow, and thread interaction sequences.
+
+### 2.2 Directory Layout
+
+Inside this project, you'll see the following folders and files:
+
+```text
+/
+├── docs/
+│   ├── diagrams/
+│   │   ├── Ability_Logo.svg
+│   │   └── interface-contracts.svg
+│   └── architecture.md
+├── src/
+│   └── emg_gui/
+│       ├── app.py
+│       ├── acquisition/
+│       │   ├── data_source.py
+│       │   ├── dataset_files.py
+│       │   └── sensor_worker.py
+│       ├── config/
+│       │   ├── constants.py
+│       │   └── Roboto-Black.ttf
+│       ├── core/
+│       │   ├── enums.py
+│       │   ├── logger.py
+│       │   └── types.py
+│       ├── processing/
+│       │   ├── filter.py
+│       │   └── window_functions.py
+│       ├── ui/
+│       │   ├── control_panel.py
+│       │   └── window.py
+│       └── visualizer/
+│           ├── shaders/
+│           │   ├── shader_loader.py
+│           │   ├── spec/
+│           │   │   ├── vertex.glsl
+│           │   │   └── fragment.glsl
+│           │   ├── text/
+│           │   │   ├── vertex.glsl
+│           │   │   └── fragment.glsl
+│           │   ├── ticks/
+│           │   │   ├── vertex.glsl
+│           │   │   └── fragment.glsl
+│           │   └── time_series/
+│           │       ├── vertex.glsl
+│           │       └── fragment.glsl
+│           ├── open_gl_widget.py
+│           ├── spectrogram_renderer.py
+│           ├── text_renderer.py
+│           ├── ticks_renderer.py
+│           └── time_series_renderer.py
+├── tests/
+├── CONTRIBUTING.md
+├── pyproject.toml
+└── README.md
+```
+
+---
+
+## 3. Contributing
+
+Contributions are welcome. See the [contributing guide](CONTRIBUTING.md) for
+development and linting guidelines.
+
+---
+
+## 4. Acknowledgements
+
+### 4.1 BrainFlow
+
+This project uses [BrainFlow](https://brainflow.readthedocs.io/en/stable/) for
+biosignal acquisition and hardware integration. BrainFlow provides a uniform
+API for acquiring, parsing, and analyzing EEG, EMG, ECG, and other biosensor
+data across a wide range of supported boards, including OpenBCI devices.
+BrainFlow is distributed under the
+[MIT License](https://github.com/brainflow-dev/brainflow/blob/master/LICENSE).
+
+### 4.2 ModernGL Spectrogram
+
+This project uses
+[nickcercone/spectrogram](https://github.com/nickcercone/spectrogram) as a
+reference for parts of its ModernGL spectrogram rendering implementation. The
+referenced project demonstrates real-time audio spectrogram visualization
+using ModernGL and is distributed under the
+[MIT License](https://github.com/nickcercone/spectrogram/blob/main/LICENCE).
+
+### 4.3 Text Rendering
+
+This project adapts the code in
+[How to render text with PyOpenGL?](https://stackoverflow.com/questions/63836707/how-to-render-text-with-pyopengl)
+by exiled (question) and Rabbid76 (answer) for its ModernGL text renderer.
+The referenced contributions demonstrate text rendering with PyOpenGL and are
+distributed under the
+[CC BY-SA 4.0 License](https://creativecommons.org/licenses/by-sa/4.0/).
+
+---
+
+## 5. Tech Debt
+
+1. Add setup and installation instructions to this readme.
+2. Create new repo-emg-ability (create import and remove run.sh).
+3. Folder portability use [EMGFlow](https://github.com/WiIIson/EMGFlow-Python-Package/tree/main) & [system path](https://www.youtube.com/watch?v=v6tALyc4C10&t=3s) reference.
+4. Add legends for raw and filtered emg in timeseries renderer.
+5. Processing latency in the performance metrics.
+6. Improve the GUI toggle controls and expose their options in the left sidebar.
+7. Add timer and countdown visualizations.
+8. Move signal processing from the GUI thread to a dedicated processing thread.
+9. Move the complete data-source lifecycle into the sensor thread, including initialization, streaming, recording, stopping, and release.

emg_gui-0.0.5/pyproject.toml

@@ -0,0 +1,48 @@
+[project]
+name = "emg-gui"
+version = "0.0.5"
+description = ""
+authors = [
+    {name = "Nikhil Pareek", email = "nikhilpareek149@gmail.com"}
+]
+maintainers = [
+    {name = "Nikhil Pareek", email = "nikhilpareek149@gmail.com"}
+]
+readme = "README.md"
+requires-python = "==3.12.10"
+dependencies = [
+    "brainflow==5.16.0",
+    "dvg-ringbuffer==1.1.0",
+    "freetype-py==2.5.1",
+    "librosa==0.11.0",
+    "matplotlib==3.9.4",
+    "moderngl==5.12.0",
+    "numpy==1.26.4",
+    "PyQt5==5.15.11",
+    "PyQt5-Qt5==5.15.2; sys_platform == 'win32'",
+    "PyQt5-Qt5==5.15.19; sys_platform != 'win32'",
+    "PyQt5-sip==12.17.1",
+    "pyrr==0.10.3",
+    "pyserial==3.5",
+    "setuptools==80.10.2",
+    "typing-extensions==4.16.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/pareeknikhil/emg-gui"
+Documentation = "https://pareeknikhil.github.io/"
+Issues = "https://github.com/pareeknikhil/emg-gui/issues"
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[project.scripts]
+emg-gui = "emg_gui.app:main"
+
+[tool.poetry]
+packages = [{ include = "emg_gui", from = "src" }]
+include = [
+    { path = "src/emg_gui/visualizer/shaders/**/*.glsl", format = ["sdist", "wheel"] },
+    { path = "src/emg_gui/config/*.ttf", format = ["sdist", "wheel"] },
+]