sleepecg 0.5.4

A package for sleep stage classification using ECG data

SleepECG

SleepECG provides tools for sleep stage classification when EEG signals are not available. Based only on ECG (and to a lesser extent also movement data), SleepECG provides functions for

• downloading and reading open polysomnography datasets,
• detecting heartbeats from ECG signals, and
• classifying sleep stages (which includes preprocessing, feature extraction, and classification).

Documentation

Documentation for SleepECG is available on Read the Docs.

Changelog

Check out the changelog to learn what we added, changed, or fixed.

Dependencies

SleepECG requires Python ≥ 3.8 and the following packages:

• numpy ≥ 1.20.0
• requests ≥ 2.25.0
• scipy ≥ 1.7.0
• tqdm ≥ 4.60.0
• PyYAML ≥ 5.4.0

Optional dependencies provide additional features:

• joblib ≥ 1.0.0 (parallelized feature extraction)
• matplotlib ≥ 3.5.0 (plot ECG time courses, hypnograms, and confusion matrices)
• mne ≥ 1.0.0 (read data from MESA and SHHS)
• numba ≥ 0.55.0 (JIT-compiled heartbeat detector)
• tensorflow ≥ 2.7.0 (sleep stage classification with Keras models)
• wfdb ≥ 3.4.0 (read data from SLPDB, MITDB, and LTDB)

Installation

SleepECG is available on PyPI and can be installed with pip:

pip install sleepecg

Alternatively, an unofficial conda package is available:

conda install -c conda-forge sleepecg

SleepECG with all optional dependencies can be installed with the following command:

pip install sleepecg[full]

If you want the latest development version, use the following command:

pip install git+https://github.com/cbrnr/sleepecg

Contributing

The contributing guide contains detailed instructions on how to contribute to SleepECG.