pbl-exp 0.1__tar.gz

pbl_exp-0.1/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

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

@@ -0,0 +1,67 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      url: https://pypi.org/p/VisFeats
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

pbl_exp-0.1/.gitignore

@@ -0,0 +1,183 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor  
+#  Cursor is an AI-powered code editor.`.cursorignore` specifies files/directories to 
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+.demo_logs/

pbl_exp-0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Qian Chu
+
+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.

pbl_exp-0.1/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: pbl-exp
+Version: 0.1
+Summary: Helper functions for running experiments at the Predictive Brain Lab (Bochum)
+Author-email: Qian Chu <qianchu99@gmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: psychopy
+Requires-Dist: pupil-labs-realtime-api
+Requires-Dist: sr-research-pylink
+Dynamic: license-file
+
+# pbl-exp
+

pbl_exp-0.1/README.md

@@ -0,0 +1,2 @@
+# pbl-exp
+

pbl_exp-0.1/demos/psychopy_and_pupil_labs.py

@@ -0,0 +1,63 @@
+from psychopy import core, logging, visual
+from psychopy.hardware import keyboard
+
+from PBL.exp import get_pupil_labs_device, send_event_to_pupil_labs
+
+# Create a log file to record experiment events and messages
+lastLog = logging.LogFile(
+    "demo_logs/psychopy_and_pupil_labs.log", level=logging.INFO, filemode="w"
+)
+
+N = 5  # Number of trials
+DUR = 0.5  # Duration of the flash in seconds
+INTERVAL = 3  # Interval between flashes in seconds
+
+# Choose whether to record from a Pupil Labs device
+device, offset_ns = get_pupil_labs_device()
+
+
+def end_experiment(device, offset_ns):
+    if device is not None and offset_ns is not None:
+        send_event_to_pupil_labs(device, "experiment end", offset_ns)
+        device.recording_stop_and_save()
+        device.close()
+    logging.exp("experiment end")
+    logging.flush()
+    core.quit()
+
+
+# Experiment parameters and PsychoPy objects
+win = visual.Window(fullscr=True, color=[-1, -1, -1])  # black
+win.mouseVisible = False
+square = visual.Rect(win, width=2, height=2, fillColor="white", units="norm")
+text = visual.TextStim(win, text="Press space to start", height=0.05, units="height")
+
+kb = keyboard.KeyboardDevice()
+kb.registerCallback(
+    response="escape",
+    func=end_experiment,
+    args=[device, offset_ns],
+)
+
+# Display initial message and wait for space key to continue
+text.draw()
+win.flip()
+kb.waitKeys(keyList=["space"])
+win.flip()
+logging.exp("experiment start")
+device.recording_start() if device is not None else None
+core.wait(3)
+
+for i in range(N):
+    square.draw()
+    win.callOnFlip(send_event_to_pupil_labs, device, "flash onset", offset_ns)
+    win.logOnFlip(level=logging.EXP, msg="flash onset")
+    win.flip()
+    core.wait(DUR)
+    win.flip()
+    core.wait(INTERVAL)
+    logging.flush()
+    kb.getKeys()  # Check for escape key press during the interval
+
+core.wait(1)
+end_experiment(device, offset_ns)

pbl_exp-0.1/pyproject.toml

@@ -0,0 +1,18 @@
+[build-system]
+requires = ["setuptools>=80", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pbl-exp"
+dynamic = ["version"]
+description = "Helper functions for running experiments at the Predictive Brain Lab (Bochum)"
+readme = "README.md"
+authors = [{ name = "Qian Chu", email = "qianchu99@gmail.com" }]
+requires-python = ">=3.10"
+dependencies = ["psychopy", "pupil-labs-realtime-api", "sr-research-pylink"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools_scm]
+local_scheme = "node-and-date"

pbl_exp-0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pbl_exp-0.1/src/PBL/exp/__init__.py

@@ -0,0 +1,3 @@
+from .pupil_labs import get_pupil_labs_device, send_event_to_pupil_labs
+
+__all__ = ["get_pupil_labs_device", "send_event_to_pupil_labs"]

pbl_exp-0.1/src/PBL/exp/pupil_labs.py

@@ -0,0 +1,99 @@
+import sys
+from time import time_ns
+
+from psychopy import gui, logging
+from pupil_labs.realtime_api.simple import Device, discover_devices
+
+
+def get_pupil_labs_device(search_duration_seconds=5.0):
+    """
+    Get the Pupil Labs device and its time offset.
+
+    Parameters
+    ----------
+    search_duration_seconds : float
+        Duration to search for Pupil Labs devices.
+
+    Returns
+    -------
+    device : object or None
+        The connected Pupil Labs device, or None if not used.
+    median_offset_ns : int or None
+        The estimated median time offset of the device in nanoseconds, or None if not used.
+
+    Raises
+    ------
+    RuntimeError
+        If no Pupil Labs device is found when one is expected.
+    """
+    # Get whether to use the Pupil Labs Eye Tracker
+    dlg = gui.Dlg(title="Pupil Labs Eye Tracker")
+    dlg.addField("Use Pupil Labs eye tracker?", False, choices=[True, False])
+    dlg_data = dlg.show()
+    sys.exit() if not dlg.OK else None
+    record_pl = dlg_data[0]
+
+    if record_pl:
+        devices = discover_devices(search_duration_seconds=search_duration_seconds)
+        if not devices:
+            dlg = gui.Dlg(title="No Pupil Labs device found")
+            dlg.addText("No Pupil Labs device found. Check your connection.")
+            dlg.show()
+            raise RuntimeError("No Pupil Labs device found.")
+        elif len(devices) == 1:
+            device = devices[0]
+            dlg = gui.Dlg(title="Pupil Labs configuration")
+            dlg.addText(f"Using the only Pupil Labs device found at {device.address}")
+            dlg.show()
+        else:
+            ip_addresses = [device.address for device in devices]
+            dlg = gui.Dlg(title="Pupil Labs configuration")
+            dlg.addText("Multiple Pupil Labs devices found.")
+            dlg.addField("Select the device to use:", choices=ip_addresses)
+            dlg.show()
+            selected_ip = dlg.data[0]
+            for d in devices:
+                if d.address == selected_ip:
+                    device = d
+                else:
+                    d.close()
+        logging.info(f"Connected to Pupil Labs device at {device.address}")
+
+        median_offset_ns = round(
+            device.estimate_time_offset().time_offset_ms.median * 1_000_000
+        )
+        offset_std = round(device.estimate_time_offset().time_offset_ms.std * 1_000_000)
+        logging.info(
+            f"Estimated Pupil Labs device time offset (ns) = {median_offset_ns} ± {offset_std} (median ± std)"
+        )
+
+        return device, median_offset_ns
+    else:
+        return None, None
+
+
+def send_event_to_pupil_labs(device: Device, event_string: str, clock_offset_ns: int):
+    """
+    Send an event to the Pupil Labs device with a timestamp.
+
+    Parameters
+    ----------
+    device : Device
+        The connected Pupil Labs device.
+    event_string : str
+        The event description to send.
+    clock_offset_ns : int
+        The clock offset in nanoseconds to adjust the event timestamp.
+    """
+    if device is not None:
+        device.send_event(
+            event_string,
+            event_timestamp_unix_ns=int(time_ns() - clock_offset_ns),
+        )
+
+
+if __name__ == "__main__":
+    logging.console.setLevel(logging.INFO)
+    device, offset_ns = get_pupil_labs_device()
+    if device is not None:
+        device.close()

pbl_exp-0.1/src/pbl_exp.egg-info/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: pbl-exp
+Version: 0.1
+Summary: Helper functions for running experiments at the Predictive Brain Lab (Bochum)
+Author-email: Qian Chu <qianchu99@gmail.com>
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: psychopy
+Requires-Dist: pupil-labs-realtime-api
+Requires-Dist: sr-research-pylink
+Dynamic: license-file
+
+# pbl-exp
+

pbl_exp-0.1/src/pbl_exp.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+.gitattributes
+.gitignore
+LICENSE
+README.md
+pyproject.toml
+.github/workflows/python-publish.yml
+demos/psychopy_and_pupil_labs.py
+src/PBL/exp/__init__.py
+src/PBL/exp/eyelink.py
+src/PBL/exp/psychopy.py
+src/PBL/exp/pupil_labs.py
+src/pbl_exp.egg-info/PKG-INFO
+src/pbl_exp.egg-info/SOURCES.txt
+src/pbl_exp.egg-info/dependency_links.txt
+src/pbl_exp.egg-info/requires.txt
+src/pbl_exp.egg-info/scm_file_list.json
+src/pbl_exp.egg-info/scm_version.json
+src/pbl_exp.egg-info/top_level.txt

pbl_exp-0.1/src/pbl_exp.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pbl_exp-0.1/src/pbl_exp.egg-info/requires.txt

@@ -0,0 +1,3 @@
+psychopy
+pupil-labs-realtime-api
+sr-research-pylink

pbl_exp-0.1/src/pbl_exp.egg-info/scm_file_list.json

@@ -0,0 +1,15 @@
+{
+  "files": [
+    ".gitattributes",
+    ".github/workflows/python-publish.yml",
+    ".gitignore",
+    "LICENSE",
+    "README.md",
+    "demos/psychopy_and_pupil_labs.py",
+    "pyproject.toml",
+    "src/PBL/exp/__init__.py",
+    "src/PBL/exp/eyelink.py",
+    "src/PBL/exp/psychopy.py",
+    "src/PBL/exp/pupil_labs.py"
+  ]
+}

pbl_exp-0.1/src/pbl_exp.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "0.1",
+  "distance": 0,
+  "node": "gb376e98382f28a811bf1d36ac7a8aa437eba381c",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-29"
+}

pbl_exp-0.1/src/pbl_exp.egg-info/top_level.txt

@@ -0,0 +1 @@
+PBL