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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file pybv-0.0.2.tar.gz.

File metadata

  • Download URL: pybv-0.0.2.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8

File hashes

Hashes for pybv-0.0.2.tar.gz
Algorithm Hash digest
SHA256 ac587743a1c38414f9dc77cf70e2f45699596ad4e29763c4e938f64a7f69e3f6
MD5 4b88f90bec1a71c2d240bb8efd7b9ac3
BLAKE2b-256 f75c814295f1871c8f9f67bcbe3f6e04355fa43a7506aa3b02ca74a74a3e0653

See more details on using hashes here.

File details

Details for the file pybv-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: pybv-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8

File hashes

Hashes for pybv-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b46ce9d6dc736e855d88387a670b0399a7943f1eaa2a70c8930585288025d370
MD5 bf7272e93d7e068788785cc6ca2bfd8c
BLAKE2b-256 e58c26de13d15f9efc13e77e2fe980df11f008f3c54434b81a7de4462c418970

See more details on using hashes here.

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