phosphor 0.1__tar.gz

phosphor-0.1/.github/workflows/docs.yml

@@ -0,0 +1,66 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+      - dev
+  release:
+    types: [published]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Needed for hatch-vcs to determine version
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          python-version: "3.12"
+
+      - name: Install the project
+        run: uv sync --only-group docs
+
+      - name: Build documentation
+        run: |
+          cd docs
+          uv run make html
+
+      - name: Add .nojekyll file
+        run: touch docs/build/html/.nojekyll
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'docs/build/html'
+
+  deploy:
+    # Only deploy when a release is published
+    if: github.event_name == 'release'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

phosphor-0.1/.github/workflows/python-publish.yml

@@ -0,0 +1,28 @@
+# This workflow will upload a Python Package using Twine when a release is created
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: build and upload release to PyPI
+    runs-on: ubuntu-latest
+    environment: "release"
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Build Package
+        run: uv build
+
+      - name: Publish package distributions to PyPI
+        run: uv publish

phosphor-0.1/.github/workflows/python-tests.yml

@@ -0,0 +1,36 @@
+name: Test package
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches:
+      - main
+      - dev
+  workflow_dispatch:
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+        os:
+          - "ubuntu-latest"
+          - "windows-latest"
+          - "macos-latest"
+    runs-on: ${{matrix.os}}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install the project
+        run: uv sync --python ${{ matrix.python-version }}
+
+      - name: Lint
+        run: uv tool run ruff check --output-format=github src
+
+#      - name: Run tests
+#        run: uv run pytest tests

phosphor-0.1/.gitignore

@@ -0,0 +1,16 @@
+__pycache__/
+*.pyc
+.venv/
+*.egg-info/
+dist/
+build/
+uv.lock
+*.local.json
+src/phosphor/__version__.py
+
+# Sphinx documentation
+docs/_build/
+docs/build/
+docs/source/_build
+docs/source/generated
+docs/source/api/generated

phosphor-0.1/.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.3
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

phosphor-0.1/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: phosphor
+Version: 0.1
+Summary: WebGPU accelerated visualization of unbounded neural data streams in Python
+Author-email: Chadwick Boulay <chadwick.boulay@gmail.com>
+Requires-Python: >=3.11
+Requires-Dist: numpy>=2.4.2
+Requires-Dist: pyside6>=6.10.2
+Requires-Dist: rendercanvas>=2.6.1
+Requires-Dist: wgpu>=0.29.0
+Description-Content-Type: text/markdown
+
+# phosphor
+
+GPU-accelerated real-time sweep renderer for multichannel timeseries data. Built on [WebGPU](https://github.com/pygfx/wgpu-py) and Qt, phosphor renders thousands of channels at high sample rates with minimal CPU overhead.
+
+Designed for neuroscience and real-time signal monitoring -- push `(n_samples, n_channels)` numpy arrays and phosphor handles downsampling, autoscaling, and rendering.
+
+## Installation
+
+```bash
+pip install phosphor
+```
+
+## Quick Start
+
+```python
+import numpy as np
+from PySide6.QtWidgets import QApplication
+from phosphor import SweepConfig, SweepWidget
+
+app = QApplication([])
+
+widget = SweepWidget(SweepConfig(
+    n_channels=128,
+    srate=30000.0,
+    display_dur=2.0,
+    n_visible=64,
+))
+widget.show()
+
+# Push data from any source -- shape: (n_samples, n_channels), float32
+widget.push_data(np.random.randn(500, 128).astype(np.float32))
+
+app.exec()
+```
+
+### Embedding in an Existing Qt Application
+
+`SweepWidget` is a standard `QWidget` that can be added to any layout:
+
+```python
+from PySide6.QtWidgets import QMainWindow, QVBoxLayout, QWidget
+from phosphor import SweepConfig, SweepWidget
+
+class MyWindow(QMainWindow):
+    def __init__(self):
+        super().__init__()
+        self.sweep = SweepWidget(SweepConfig(n_channels=64, srate=1000.0))
+        self.setCentralWidget(self.sweep)
+
+    def on_new_data(self, data):
+        self.sweep.push_data(data)
+```
+
+### Runtime Configuration
+
+Update parameters without recreating the widget:
+
+```python
+from phosphor import SweepConfig
+
+widget.update_config(SweepConfig(
+    n_channels=256,
+    srate=30000.0,
+    display_dur=4.0,
+    n_visible=128,
+))
+```
+
+## Built-in Demo
+
+```bash
+python -m phosphor
+python -m phosphor --channels 256 --srate 30000 --visible 64 --dur 2.0
+```
+
+## Keyboard Controls
+
+| Key                     | Action                                    |
+|-------------------------|-------------------------------------------|
+| `Up` / `Down`           | Scroll channels by 1                      |
+| `Page Up` / `Page Down` | Scroll channels by one page               |
+| `[` / `]`               | Halve / double visible channel count      |
+| `-` / `=`               | Y-axis zoom out / in (disables autoscale) |
+| `A`                     | Toggle autoscale                          |
+| `,` / `.`               | Halve / double display duration           |
+
+## Development
+
+We use [`uv`](https://docs.astral.sh/uv/) for development.
+
+1. Fork and clone the repository
+2. `uv sync` to create a virtual environment and install dependencies
+3. `uv run pre-commit install` to set up linting and formatting hooks
+4. `uv run pytest tests` to run the test suite
+5. Submit a PR against the `dev` branch

phosphor-0.1/README.md

@@ -0,0 +1,95 @@
+# phosphor
+
+GPU-accelerated real-time sweep renderer for multichannel timeseries data. Built on [WebGPU](https://github.com/pygfx/wgpu-py) and Qt, phosphor renders thousands of channels at high sample rates with minimal CPU overhead.
+
+Designed for neuroscience and real-time signal monitoring -- push `(n_samples, n_channels)` numpy arrays and phosphor handles downsampling, autoscaling, and rendering.
+
+## Installation
+
+```bash
+pip install phosphor
+```
+
+## Quick Start
+
+```python
+import numpy as np
+from PySide6.QtWidgets import QApplication
+from phosphor import SweepConfig, SweepWidget
+
+app = QApplication([])
+
+widget = SweepWidget(SweepConfig(
+    n_channels=128,
+    srate=30000.0,
+    display_dur=2.0,
+    n_visible=64,
+))
+widget.show()
+
+# Push data from any source -- shape: (n_samples, n_channels), float32
+widget.push_data(np.random.randn(500, 128).astype(np.float32))
+
+app.exec()
+```
+
+### Embedding in an Existing Qt Application
+
+`SweepWidget` is a standard `QWidget` that can be added to any layout:
+
+```python
+from PySide6.QtWidgets import QMainWindow, QVBoxLayout, QWidget
+from phosphor import SweepConfig, SweepWidget
+
+class MyWindow(QMainWindow):
+    def __init__(self):
+        super().__init__()
+        self.sweep = SweepWidget(SweepConfig(n_channels=64, srate=1000.0))
+        self.setCentralWidget(self.sweep)
+
+    def on_new_data(self, data):
+        self.sweep.push_data(data)
+```
+
+### Runtime Configuration
+
+Update parameters without recreating the widget:
+
+```python
+from phosphor import SweepConfig
+
+widget.update_config(SweepConfig(
+    n_channels=256,
+    srate=30000.0,
+    display_dur=4.0,
+    n_visible=128,
+))
+```
+
+## Built-in Demo
+
+```bash
+python -m phosphor
+python -m phosphor --channels 256 --srate 30000 --visible 64 --dur 2.0
+```
+
+## Keyboard Controls
+
+| Key                     | Action                                    |
+|-------------------------|-------------------------------------------|
+| `Up` / `Down`           | Scroll channels by 1                      |
+| `Page Up` / `Page Down` | Scroll channels by one page               |
+| `[` / `]`               | Halve / double visible channel count      |
+| `-` / `=`               | Y-axis zoom out / in (disables autoscale) |
+| `A`                     | Toggle autoscale                          |
+| `,` / `.`               | Halve / double display duration           |
+
+## Development
+
+We use [`uv`](https://docs.astral.sh/uv/) for development.
+
+1. Fork and clone the repository
+2. `uv sync` to create a virtual environment and install dependencies
+3. `uv run pre-commit install` to set up linting and formatting hooks
+4. `uv run pytest tests` to run the test suite
+5. Submit a PR against the `dev` branch

phosphor-0.1/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

phosphor-0.1/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

phosphor-0.1/docs/source/_templates/autosummary/module.rst

@@ -0,0 +1,65 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+   :no-members:
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: Functions
+
+   {% for item in functions %}
+   .. autofunction:: {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: Classes
+
+   {% for item in classes %}
+   .. autoclass:: {{ item }}
+      :members:
+      :undoc-members:
+      :show-inheritance:
+      :special-members: __init__
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: Exceptions
+
+   {% for item in exceptions %}
+   .. autoexception:: {{ item }}
+      :members:
+      :show-inheritance:
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

phosphor-0.1/docs/source/api/index.rst

@@ -0,0 +1,11 @@
+API Reference
+=============
+
+This page contains auto-generated API reference documentation.
+
+.. autosummary::
+   :toctree: generated
+   :recursive:
+   :template: autosummary/module.rst
+
+   phosphor

phosphor-0.1/docs/source/conf.py

@@ -0,0 +1,129 @@
+# Configuration file for the Sphinx documentation builder.
+
+import os
+import sys
+
+# Add the source directory to the path
+sys.path.insert(0, os.path.abspath("../../src"))
+
+# -- Project information --------------------------
+
+project = "ezmsg.sigproc"
+copyright = "2024, ezmsg Contributors"
+author = "ezmsg Contributors"
+
+# The version is managed by hatch-vcs and stored in __version__.py
+try:
+    from ezmsg.sigproc.__version__ import version as release
+except ImportError:
+    release = "unknown"
+
+# For display purposes, extract the base version without git commit info
+version = release.split("+")[0] if release != "unknown" else release
+
+# -- General configuration --------------------------
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.duration",
+    "sphinx.ext.graphviz",
+    # "sphinx_autodoc_typehints",  # Disabled due to compatibility issue
+    "sphinx_copybutton",
+    "myst_parser",  # For markdown files
+]
+
+templates_path = ["_templates"]
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# The toctree master document
+master_doc = "index"
+
+# -- Autodoc configuration ------------------------------
+
+# Auto-generate API docs
+autosummary_generate = True
+autosummary_imported_members = False
+autodoc_typehints = "description"
+autodoc_member_order = "bysource"
+autodoc_typehints_format = "short"
+python_use_unqualified_type_names = True
+autodoc_default_options = {
+    "members": True,
+    "member-order": "bysource",
+    "special-members": "__init__",
+    "undoc-members": True,
+    "show-inheritance": True,
+}
+
+# Don't show the full module path in the docs
+add_module_names = False
+
+# -- Intersphinx configuration --------------------------
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/", None),
+    "ezmsg": ("https://www.ezmsg.org/ezmsg/", None),
+    "ezmsg.baseproc": ("https://www.ezmsg.org/ezmsg-baseproc/", None),
+    "ezmsg.learn": ("https://www.ezmsg.org/ezmsg-learn/", None),
+    "ezmsg.event": ("https://www.ezmsg.org/ezmsg-event/", None),
+    "ezmsg.lsl": ("https://www.ezmsg.org/ezmsg-lsl/", None),
+    "ezmsg.blackrock": ("https://www.ezmsg.org/ezmsg-blackrock/", None),
+}
+intersphinx_disabled_domains = ["std"]
+
+# -- Options for HTML output -----------------------------
+
+html_theme = "pydata_sphinx_theme"
+html_static_path = ["_static"]
+
+# Set the base URL for the documentation
+html_baseurl = "https://www.ezmsg.org/ezmsg-sigproc/"
+
+html_theme_options = {
+    "logo": {
+        "text": f"ezmsg.sigproc {version}",
+        "link": "https://ezmsg.org",  # Link back to main site
+    },
+    "header_links_before_dropdown": 4,
+    "navbar_start": ["navbar-logo"],
+    "navbar_end": ["theme-switcher", "navbar-icon-links"],
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/ezmsg-org/ezmsg-sigproc",
+            "icon": "fa-brands fa-github",
+        },
+        {
+            "name": "ezmsg.org",
+            "url": "https://www.ezmsg.org",
+            "icon": "fa-solid fa-house",
+        },
+    ],
+}
+
+# Timestamp is inserted at every page bottom in this strftime format.
+html_last_updated_fmt = "%Y-%m-%d"
+
+# -- Options for linkcode -----------------------------
+
+branch = "main"
+code_url = f"https://github.com/ezmsg-org/ezmsg-sigproc/blob/{branch}/"
+
+
+def linkcode_resolve(domain, info):
+    if domain != "py":
+        return None
+    if not info["module"]:
+        return None
+    filename = info["module"].replace(".", "/")
+    return f"{code_url}src/{filename}.py"

phosphor-0.1/docs/source/index.md

@@ -0,0 +1,14 @@
+```{include} ../../README.md
+```
+
+```{toctree}
+:maxdepth: 2
+:caption: Contents:
+
+api/index
+```
+
+## Indices and tables
+
+- {ref}`genindex`
+- {ref}`modindex`