Skip to main content

Latest PyPI Release Latest Conda Release Python 3.9+ License

pyXDF

pyXDF is a Python importer for XDF files.

Sample usage

import pyxdf
import matplotlib.pyplot as plt
import numpy as np

data, header = pyxdf.load_xdf('test.xdf')

for stream in data:
    y = stream['time_series']

    if isinstance(y, list):
        # list of strings, draw one vertical line for each marker
        for timestamp, marker in zip(stream['time_stamps'], y):
            plt.axvline(x=timestamp)
            print(f'Marker "{marker[0]}" @ {timestamp:.2f}s')
    elif isinstance(y, np.ndarray):
        # numeric data, draw as lines
        plt.plot(stream['time_stamps'], y)
    else:
        raise RuntimeError('Unknown stream format')

plt.show()

CLI examples

pyxdf has an examples module. These can be run from the command line for basic functionality.

  • print_metadata will enable a DEBUG logger to log read messages, then it will print basic metadata about each found stream.
    • python -m pyxdf.examples.print_metadata -f=/path/to/my.xdf
  • playback_lsl will open an XDF file then replay its data in an infinite loop, but using current timestamps. This is useful for prototyping online processing.
    • python -m pyxdf.examples.playback_lsl /path/to/my.xdf

Installation

The latest stable version can be installed with pip install pyxdf.

For the latest development version, use pip install git+https://github.com/xdf-modules/pyxdf.git.

For maintainers

A new release is automatically uploaded to PyPI. Therefore, as soon as a new release is created on GitHub (using a tag labeled e.g. v1.16.3), a PyPI package is created with the version number matching the release tag.

Metadata

Release files for pyxdf 1.16.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyxdf 1.16.6
File Size Uploaded
pyxdf-1.16.6.tar.gz 21.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyxdf 1.16.6
File Interpreter ABI Platform
pyxdf-1.16.6-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 40.5 kB

Release files / pyxdf-1.16.6.tar.gz

Download URL pyxdf-1.16.6.tar.gz
Size 21.7 kB
Tags Source
SHA-256 checksum
How to use checksums
7d1aa8b6a07703a3cea0805b45d232e00081dd8678fd0f49e0421bcfc29078e9
BLAKE2b-256 checksum
How to use checksums
19b85fc096f1cbca2cac4dd5c060fa2734d79422844f54012991930a8293149d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Release files / pyxdf-1.16.6-py2.py3-none-any.whl

Download URL pyxdf-1.16.6-py2.py3-none-any.whl
Size 18.8 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
c9945b8debb1caf63345bbe01795b27b05a03788c266803e85e28d272a1d9d5f
BLAKE2b-256 checksum
How to use checksums
e4d4012411cccacd354088a762e75e0e2a75c7473e001e7a672515a3427b7bfe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Release history Release notifications | RSS feed

1.17.5

2 release files

1.17.4

2 release files

1.17.3

2 release files

1.17.1

2 release files

1.16.8

2 release files

1.16.7

2 release files

This release

1.16.6 This release

2 release files

1.16.5

2 release files

1.16.4

2 release files

1.16.2

2 release files

1.16.1

2 release files

1.16.0

2 release files

1.15.1

2 release files

1.14.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page