sleepeegpy is a high-level package built on top of MNE-python, yasa, PyPREP and specparam (fooof) for preprocessing, analysis, and visualization of sleep EEG data.

The repository also includes a Jupyter notebook demonstrating how to use this package and provides a ready-made workflow for common use cases.

Installation

Prerequisites

Python Version: Ensure you have Python version >3.9 and <3.12 installed.

Steps

Create a Python Virtual Environment: Create a Python virtual environment. For more information you can refer to python venv, virtualenv or conda.
Activate the Environment
Install sleepeegpy:
```
pip install sleepeegpy
```
Download notebooks: Download this repository zip folder, you will need only the notebooks folder.

Quickstart

The notebooks are useful for familiarizing yourself with the library's functionalities. To use them:

Navigate to the Pipeline Notebooks folder and run Jupyter.
```
jupyter notebook
```
Open the complete_pipeline notebook using Jupyter Notebook within the activated environment and follow the instructions.

Additionally, detailed documentation is available for further reference.

RAM requirements

For overnight, high-density (256 channels) EEG recordings downsampled to 250 Hz expect at least 64 GB RAM expenditure for cleaning, spectral analyses, and event detection.

Citation

Paper
Falach, R., G. Belonosov, J. F. Schmidig, M. Aderka, V. Zhelezniakov, R. Shani-Hershkovich, E. Bar, and Y. Nir. "SleepEEGpy: a Python-based software integration package to organize preprocessing, analysis, and visualization of sleep EEG data." Computers in Biology and Medicine 192 (2025): 110232.
https://doi.org/10.1016/j.compbiomed.2025.110232
Dataset
https://doi.org/10.5281/ZENODO.10362189.

Sleepeegpy

Install / Use

README