From 67fd47f6f56478400d5ee8d0cbe3bc6f52ad5310 Mon Sep 17 00:00:00 2001 From: Tom Pollard Date: Fri, 6 Feb 2026 06:26:13 -0500 Subject: [PATCH 1/3] Remove broken buttons. --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index d05eb73b..7c52e1d7 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,8 @@ ![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 From b76b3ce73dad29a163a96c0c9786da723150b801 Mon Sep 17 00:00:00 2001 From: Tom Pollard Date: Fri, 6 Feb 2026 06:28:01 -0500 Subject: [PATCH 2/3] Add 'latest' DOI. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7c52e1d7..6048656d 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ![signals](https://raw.githubusercontent.com/MIT-LCP/wfdb-python/main/demo-img.png) [![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) +[![PhysioNet Project](https://img.shields.io/badge/DOI-10.13026%2Fjt5e--gq15-blue)](https://doi.org/10.13026/jt5e-gq15) ## Introduction From e6c64d0c0559e4aeb79fb5fcf60803bba22d0a99 Mon Sep 17 00:00:00 2001 From: Tom Pollard Date: Fri, 6 Feb 2026 06:42:06 -0500 Subject: [PATCH 3/3] Tidying --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 6048656d..6d68b17f 100644 --- a/README.md +++ b/README.md @@ -7,19 +7,21 @@ ## 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/). +WFDB defines a set of open standards and software tools for the storage, sharing, and analysis of physiologic signal and annotation data. It has been widely used for decades to support biomedical research, clinical studies, and education. For more information on WFDB and its various implementations, see the [WFDB website](https://wfdb.mit.edu/). -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. +This package is heavily inspired by the original [WFDB Software Package](https://www.physionet.org/content/wfdb/). It aims to replicate many of its command-line APIs in Python, but there is no promise of consistency between the two. Core I/O functionality is based on the Waveform Database (WFDB) [specifications](https://github.com/wfdb/wfdb-spec/). -## Documentation and Usage +## Resources -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. +- WFDB Website: [https://wfdb.mit.edu/](https://wfdb.mit.edu/) +- WFDB-Python Documentation: [http://wfdb.readthedocs.io](http://wfdb.readthedocs.io) +- WFDB Specification: [https://github.com/wfdb/wfdb-spec/](https://github.com/wfdb/wfdb-spec/) +- Demo Notebook: [https://github.com/MIT-LCP/wfdb-python/blob/main/demo.ipynb](https://github.com/MIT-LCP/wfdb-python/blob/main/demo.ipynb) +- WFDB Development Repository: [https://github.com/MIT-LCP/wfdb-python](https://github.com/MIT-LCP/wfdb-python) ## Installation -The distribution is hosted on PyPI at: . The package can be directly installed from PyPI using pip: +The distribution is hosted on PyPI at: [https://pypi.python.org/pypi/wfdb/](https://pypi.python.org/pypi/wfdb/). The package can be directly installed from PyPI using pip: ```sh pip install wfdb @@ -27,7 +29,9 @@ 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: . 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: +## Development + +The development version is hosted at: [https://github.com/MIT-LCP/wfdb-python](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 . @@ -39,8 +43,6 @@ If you intend to make changes to the repository, you can install additional pack 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 @@ -49,4 +51,4 @@ For guidance on creating a new release, see: https://github.com/MIT-LCP/wfdb-pyt ## Citing -When using this resource, please cite the software [publication](https://physionet.org/content/wfdb-python/) on PhysioNet. +When using this resource, please cite the software [publication](https://physionet.org/content/wfdb-python/) on PhysioNet. \ No newline at end of file