wfdb


Namewfdb JSON
Version 4.2.0 PyPI version JSON
download
home_pageNone
SummaryThe WFDB Python package: tools for reading, writing, and processing physiologic signals and annotations.
upload_time2025-01-21 21:57:16
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseMIT License
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # The WFDB Python Package

![signals](https://raw.githubusercontent.com/MIT-LCP/wfdb-python/main/demo-img.png)

[![tests workflow](https://github.com/MIT-LCP/wfdb-python/actions/workflows/run-tests.yml/badge.svg)](https://github.com/MIT-LCP/wfdb-python/actions?query=workflow%3Arun-tests+event%3Apush+branch%3Amain)
[![PyPI Downloads](https://img.shields.io/pypi/dm/wfdb.svg?label=PyPI%20downloads)](https://pypi.org/project/wfdb/)
[![PhysioNet Project](https://img.shields.io/badge/DOI-10.13026%2Fegpf--2788-blue)](https://doi.org/10.13026/egpf-2788)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/wfdb.svg)](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 pip:

```sh
pip install wfdb
```

On some less-common systems, you may need to install `libsndfile` separately.  See the [soundfile installation notes](https://pypi.org/project/soundfile/) for more information.

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
pip install .
```

If you intend to make changes to the repository, you can install additional packages that are useful for development by running:

```sh
pip install ".[dev]"
```

## Developing

Please see the [DEVELOPING.md](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md) document for contribution/development instructions.

### Creating a new release

For guidance on creating a new release, see: https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md#creating-distributions

## Citing

When using this resource, please cite the software [publication](https://physionet.org/content/wfdb-python/) on PhysioNet.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "wfdb",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "The Laboratory for Computational Physiology <contact@physionet.org>",
    "download_url": "https://files.pythonhosted.org/packages/2b/83/25272703b2290378b2f2e8b01548248ce5501aadb3f2a8083665d30db750/wfdb-4.2.0.tar.gz",
    "platform": null,
    "description": "# The WFDB Python Package\n\n![signals](https://raw.githubusercontent.com/MIT-LCP/wfdb-python/main/demo-img.png)\n\n[![tests workflow](https://github.com/MIT-LCP/wfdb-python/actions/workflows/run-tests.yml/badge.svg)](https://github.com/MIT-LCP/wfdb-python/actions?query=workflow%3Arun-tests+event%3Apush+branch%3Amain)\n[![PyPI Downloads](https://img.shields.io/pypi/dm/wfdb.svg?label=PyPI%20downloads)](https://pypi.org/project/wfdb/)\n[![PhysioNet Project](https://img.shields.io/badge/DOI-10.13026%2Fegpf--2788-blue)](https://doi.org/10.13026/egpf-2788)\n[![Supported Python Versions](https://img.shields.io/pypi/pyversions/wfdb.svg)](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 pip:\n\n```sh\npip install wfdb\n```\n\nOn some less-common systems, you may need to install `libsndfile` separately.  See the [soundfile installation notes](https://pypi.org/project/soundfile/) for more information.\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\npip install .\n```\n\nIf you intend to make changes to the repository, you can install additional packages that are useful for development by running:\n\n```sh\npip install \".[dev]\"\n```\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### Creating a new release\n\nFor guidance on creating a new release, see: https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md#creating-distributions\n\n## Citing\n\nWhen using this resource, please cite the software [publication](https://physionet.org/content/wfdb-python/) on PhysioNet.\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "The WFDB Python package: tools for reading, writing, and processing physiologic signals and annotations.",
    "version": "4.2.0",
    "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": null,
            "digests": {
                "blake2b_256": "4923bd7f13c8857eb880d73ff848f404e16647ce26a91582f9f6405d3f995c43",
                "md5": "ec60f79822339512f5fc88056d70a8b5",
                "sha256": "54eca684172d26cd34647ee91316f2da2d07e766a4747b587f44d949afc5818d"
            },
            "downloads": -1,
            "filename": "wfdb-4.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ec60f79822339512f5fc88056d70a8b5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 162268,
            "upload_time": "2025-01-21T21:57:15",
            "upload_time_iso_8601": "2025-01-21T21:57:15.067330Z",
            "url": "https://files.pythonhosted.org/packages/49/23/bd7f13c8857eb880d73ff848f404e16647ce26a91582f9f6405d3f995c43/wfdb-4.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2b8325272703b2290378b2f2e8b01548248ce5501aadb3f2a8083665d30db750",
                "md5": "43a369b40d99873e6511f3f5cd9b948e",
                "sha256": "983396064a7acc5f9b986c6f6874ad8f541238c14ee06ff2d32658cad03d081e"
            },
            "downloads": -1,
            "filename": "wfdb-4.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "43a369b40d99873e6511f3f5cd9b948e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 162226,
            "upload_time": "2025-01-21T21:57:16",
            "upload_time_iso_8601": "2025-01-21T21:57:16.406807Z",
            "url": "https://files.pythonhosted.org/packages/2b/83/25272703b2290378b2f2e8b01548248ce5501aadb3f2a8083665d30db750/wfdb-4.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-21 21:57:16",
    "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"
}
        
Elapsed time: 0.39873s