From 28b8bfdcfc43b8818bfff429915a010d963aafc4 Mon Sep 17 00:00:00 2001 From: Tom Pollard Date: Mon, 28 Apr 2025 14:09:42 -0400 Subject: [PATCH] Add basic software overview page. Closes #7. --- software/c.md | 2 +- software/implementations.md | 31 +++++++++++++++++++++++++++++++ software/matlab.md | 2 +- software/python.md | 2 +- 4 files changed, 34 insertions(+), 3 deletions(-) create mode 100644 software/implementations.md diff --git a/software/c.md b/software/c.md index 3dccb33..dbf6b3c 100644 --- a/software/c.md +++ b/software/c.md @@ -2,7 +2,7 @@ layout: default title: C Implementation parent: WFDB Software -nav_order: 1 +nav_order: 2 --- # WFDB C Software Package diff --git a/software/implementations.md b/software/implementations.md new file mode 100644 index 0000000..8fff042 --- /dev/null +++ b/software/implementations.md @@ -0,0 +1,31 @@ +--- +layout: default +title: Overview +parent: WFDB Software Implementations +nav_order: 1 +--- + +# Overview of the WFDB Software Implementations + +{: .important } +> The are several WFDB software implementations. They include: + +| Implementation | | Description | +|:--------------|:------------| +| **WFDB C Library** | The core implementation of WFDB, optimized for speed and memory efficiency. Ideal for performance-sensitive tasks. | +| **WFDB-Python** | A Python interface for reading, writing, and processing WFDB data. It integrates with other Python tools, offering flexibility for research and analysis. | +| **WFDB MATLAB** | Designed for MATLAB users, providing functionality for signal processing and data analysis within the MATLAB environment. | + +--- + +# Key Differences + +Below is an overview of how the different WFDB software implementations compare: + +| Feature/Functionality | WFDB-Python | WFDB C Library | WFDB MATLAB | +|--------------------------------------|-------------|----------------|-------------| +| **File Reading** | Yes | Yes | Yes | +| **File Writing** | Yes | Yes | Yes | +| **Signal Processing** | Limited | Full | Limited | +| **Data Annotation Support** | Yes | Yes | Yes | +| **Operating System Compatibility** | Cross-Platform | Unix-based | Cross-Platform | diff --git a/software/matlab.md b/software/matlab.md index 10d19aa..02dd744 100644 --- a/software/matlab.md +++ b/software/matlab.md @@ -2,7 +2,7 @@ layout: default title: MATLAB Toolbox parent: WFDB Software -nav_order: 2 +nav_order: 3 --- # WFDB MATLAB Toolbox diff --git a/software/python.md b/software/python.md index 05c54d0..f91cf4c 100644 --- a/software/python.md +++ b/software/python.md @@ -2,7 +2,7 @@ layout: default title: Python Implementation parent: WFDB Software -nav_order: 1 +nav_order: 4 --- # WFDB Python Package