Skip to content

Commit 28b8bfd

Browse files
committed
Add basic software overview page. Closes #7.
1 parent 25a8619 commit 28b8bfd

4 files changed

Lines changed: 34 additions & 3 deletions

File tree

software/c.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: C Implementation
44
parent: WFDB Software
5-
nav_order: 1
5+
nav_order: 2
66
---
77

88
# WFDB C Software Package

software/implementations.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
layout: default
3+
title: Overview
4+
parent: WFDB Software Implementations
5+
nav_order: 1
6+
---
7+
8+
# Overview of the WFDB Software Implementations
9+
10+
{: .important }
11+
> The are several WFDB software implementations. They include:
12+
13+
| Implementation | | Description |
14+
|:--------------|:------------|
15+
| **WFDB C Library** | The core implementation of WFDB, optimized for speed and memory efficiency. Ideal for performance-sensitive tasks. |
16+
| **WFDB-Python** | A Python interface for reading, writing, and processing WFDB data. It integrates with other Python tools, offering flexibility for research and analysis. |
17+
| **WFDB MATLAB** | Designed for MATLAB users, providing functionality for signal processing and data analysis within the MATLAB environment. |
18+
19+
---
20+
21+
# Key Differences
22+
23+
Below is an overview of how the different WFDB software implementations compare:
24+
25+
| Feature/Functionality | WFDB-Python | WFDB C Library | WFDB MATLAB |
26+
|--------------------------------------|-------------|----------------|-------------|
27+
| **File Reading** | Yes | Yes | Yes |
28+
| **File Writing** | Yes | Yes | Yes |
29+
| **Signal Processing** | Limited | Full | Limited |
30+
| **Data Annotation Support** | Yes | Yes | Yes |
31+
| **Operating System Compatibility** | Cross-Platform | Unix-based | Cross-Platform |

software/matlab.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: MATLAB Toolbox
44
parent: WFDB Software
5-
nav_order: 2
5+
nav_order: 3
66
---
77

88
# WFDB MATLAB Toolbox

software/python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: Python Implementation
44
parent: WFDB Software
5-
nav_order: 1
5+
nav_order: 4
66
---
77

88
# WFDB Python Package

0 commit comments

Comments
 (0)