Skip to main content

A lightweight I/O utility for the BrainVision data format.

Project description

CircleCI codecov Downloads Documentation Status

pybv

A lightweight I/O utility for the BrainVision data format, written in Python.

See the pybv documentation for more information.

ALPHA SOFTWARE. This package is currently in its early stages of iteration. It may change both its internals or its user-facing API in the near future. Any feedback and ideas on how to improve either of these is more than welcome!

For more information on how to help, see CONTRIBUTING.md.

Installation

  • install dependencies: pip install numpy
  • install pybv: pip install -U pybv

Usage

from pybv import write_brainvision

# data: an ndarray of shape (n_channels, n_times)
# sfreq: the sampling frequency
# ch_names: a list of strings for channel names
# fname: the base file name for all created BrainVision files
# tmpdir: a path to where the output files will be placed
# events: an ndarray of shape (n_events, 2). Each row is an event,
#         the first column is the index of the event,
#         the second column is the event ID.
# resolution: the desired resolution (in volts) of the stored data.
write_brainvision(data, sfreq, ch_names, fname, tmpdir, events,
                  resolution=1e-6)

Acknowledgements

This package was originally adapted from palday's Philistine package. It copies much of the BrainVision exporting code, removes the dependence on MNE, and focuses the code around BrainVision I/O.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pybv-0.0.2.tar.gz (5.9 kB view hashes)

Uploaded Source

Built Distribution

pybv-0.0.2-py3-none-any.whl (7.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page