# The WFDB Python Package
[](https://github.com/MIT-LCP/wfdb-python/actions?query=workflow%3Arun-tests+event%3Apush+branch%3Amain)
[](https://pypi.org/project/wfdb/)
[](https://doi.org/10.13026/egpf-2788)
[](https://pypi.org/project/wfdb)
## Introduction
A Python-native package for reading, writing, processing, and plotting physiologic signal and annotation data. The core I/O functionality is based on the Waveform Database (WFDB) [specifications](https://github.com/wfdb/wfdb-spec/).
This package is heavily inspired by the original [WFDB Software Package](https://www.physionet.org/content/wfdb/), and initially aimed to replicate many of its command-line APIs. However, the projects are independent, and there is no promise of consistency between the two, beyond each package adhering to the core specifications.
## Documentation and Usage
See the [documentation site](http://wfdb.readthedocs.io) for the public APIs.
See the [demo.ipynb](https://github.com/MIT-LCP/wfdb-python/blob/main/demo.ipynb) notebook file for example use cases.
## Installation
The distribution is hosted on PyPI at: <https://pypi.python.org/pypi/wfdb/>. The package can be directly installed from PyPI using either pip or poetry:
```sh
pip install wfdb
poetry add wfdb
```
On Linux systems, accessing _compressed_ WFDB signal files requires installing `libsndfile`, by running `sudo apt-get install libsndfile1` or `sudo yum install libsndfile`. Support for Apple M1 systems is a work in progess (see <https://github.com/bastibe/python-soundfile/issues/310> and <https://github.com/bastibe/python-soundfile/issues/325>).
The development version is hosted at: <https://github.com/MIT-LCP/wfdb-python>. This repository also contains demo scripts and example data. To install the development version, clone or download the repository, navigate to the base directory, and run:
```sh
# Without dev dependencies
pip install .
poetry install
# With dev dependencies
pip install ".[dev]"
poetry install -E dev
# Install the dependencies only
poetry install -E dev --no-root
```
**See the [note](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md#package-and-dependency-management) about dev dependencies.**
## Developing
Please see the [DEVELOPING.md](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md) document for contribution/development instructions.
## Citing
When using this resource, please cite the software [publication](https://physionet.org/content/wfdb-python/) on PhysioNet.
Raw data
{
"_id": null,
"home_page": "https://github.com/MIT-LCP/wfdb-python/",
"name": "wfdb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "The Laboratory for Computational Physiology",
"author_email": "contact@physionet.org",
"download_url": "https://files.pythonhosted.org/packages/e4/2c/61bc6692af166becbe4f5ce52cf5f9c573e6ecc09d51fe69f7e37163a2a7/wfdb-4.1.2.tar.gz",
"platform": null,
"description": "# The WFDB Python Package\n\n\n\n[](https://github.com/MIT-LCP/wfdb-python/actions?query=workflow%3Arun-tests+event%3Apush+branch%3Amain)\n[](https://pypi.org/project/wfdb/)\n[](https://doi.org/10.13026/egpf-2788)\n[](https://pypi.org/project/wfdb)\n\n## Introduction\n\nA Python-native package for reading, writing, processing, and plotting physiologic signal and annotation data. The core I/O functionality is based on the Waveform Database (WFDB) [specifications](https://github.com/wfdb/wfdb-spec/).\n\nThis package is heavily inspired by the original [WFDB Software Package](https://www.physionet.org/content/wfdb/), and initially aimed to replicate many of its command-line APIs. However, the projects are independent, and there is no promise of consistency between the two, beyond each package adhering to the core specifications.\n\n## Documentation and Usage\n\nSee the [documentation site](http://wfdb.readthedocs.io) for the public APIs.\n\nSee the [demo.ipynb](https://github.com/MIT-LCP/wfdb-python/blob/main/demo.ipynb) notebook file for example use cases.\n\n## Installation\n\nThe distribution is hosted on PyPI at: <https://pypi.python.org/pypi/wfdb/>. The package can be directly installed from PyPI using either pip or poetry:\n\n```sh\npip install wfdb\npoetry add wfdb\n```\n\nOn Linux systems, accessing _compressed_ WFDB signal files requires installing `libsndfile`, by running `sudo apt-get install libsndfile1` or `sudo yum install libsndfile`. Support for Apple M1 systems is a work in progess (see <https://github.com/bastibe/python-soundfile/issues/310> and <https://github.com/bastibe/python-soundfile/issues/325>).\n\nThe development version is hosted at: <https://github.com/MIT-LCP/wfdb-python>. This repository also contains demo scripts and example data. To install the development version, clone or download the repository, navigate to the base directory, and run:\n\n```sh\n# Without dev dependencies\npip install .\npoetry install\n\n# With dev dependencies\npip install \".[dev]\"\npoetry install -E dev\n\n# Install the dependencies only\npoetry install -E dev --no-root\n```\n\n**See the [note](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md#package-and-dependency-management) about dev dependencies.**\n\n## Developing\n\nPlease see the [DEVELOPING.md](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md) document for contribution/development instructions.\n\n## Citing\n\nWhen using this resource, please cite the software [publication](https://physionet.org/content/wfdb-python/) on PhysioNet.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "The WFDB Python package: tools for reading, writing, and processing physiologic signals and annotations.",
"version": "4.1.2",
"project_urls": {
"Documentation": "https://wfdb.readthedocs.io/",
"Homepage": "https://github.com/MIT-LCP/wfdb-python/",
"Repository": "https://github.com/MIT-LCP/wfdb-python/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce00b83d0bd64384455dbc1f8eccb7b5d6dac23728515a9d4d74aa4def6c6fe4",
"md5": "cb95212a36952dfb14c9ee7fc7927ab1",
"sha256": "57ef64309ec7793bb11611c646d129f0b1936b598947fed8c14f90a35665053d"
},
"downloads": -1,
"filename": "wfdb-4.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb95212a36952dfb14c9ee7fc7927ab1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 159958,
"upload_time": "2023-06-16T18:02:22",
"upload_time_iso_8601": "2023-06-16T18:02:22.849006Z",
"url": "https://files.pythonhosted.org/packages/ce/00/b83d0bd64384455dbc1f8eccb7b5d6dac23728515a9d4d74aa4def6c6fe4/wfdb-4.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e42c61bc6692af166becbe4f5ce52cf5f9c573e6ecc09d51fe69f7e37163a2a7",
"md5": "c20b6688fb71f4326403d72f153a4efa",
"sha256": "6acef3ab2759f60cf911a57d9e5214ea15bd17b5ad4b3c66e4a57a7690e16024"
},
"downloads": -1,
"filename": "wfdb-4.1.2.tar.gz",
"has_sig": false,
"md5_digest": "c20b6688fb71f4326403d72f153a4efa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 147956,
"upload_time": "2023-06-16T18:02:25",
"upload_time_iso_8601": "2023-06-16T18:02:25.217893Z",
"url": "https://files.pythonhosted.org/packages/e4/2c/61bc6692af166becbe4f5ce52cf5f9c573e6ecc09d51fe69f7e37163a2a7/wfdb-4.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-16 18:02:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MIT-LCP",
"github_project": "wfdb-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "wfdb"
}
JSON
