Skip to content

Add basic software overview page. Closes #7. #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tompollard merged 1 commit into from
Apr 28, 2025
Merged

Add basic software overview page. Closes #7. #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion software/c.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: C Implementation
parent: WFDB Software
nav_order: 1
nav_order: 2
---

# WFDB C Software Package
Expand Down
31 changes: 31 additions & 0 deletions software/implementations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |
2 changes: 1 addition & 1 deletion software/matlab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: MATLAB Toolbox
parent: WFDB Software
nav_order: 2
nav_order: 3
---

# WFDB MATLAB Toolbox
Expand Down
2 changes: 1 addition & 1 deletion software/python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: default
title: Python Implementation
parent: WFDB Software
nav_order: 1
nav_order: 4
---

# WFDB Python Package
Expand Down