Skip to content

wavesresearch/sleepeegpy

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

sleepeegpy

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

Installation

  1. Make sure you have Python version installed. Requires Python >3.9, <3.12.
  2. Create a Python virtual environment, for more info you can refer to python venv, virtualenv or conda.
  3. Activate the environment
  4. pip install sleepeegpy
    
  5. Download notebooks.

Quickstart

  1. Open the complete pipeline notebook in the created environment.
  2. Follow the notebook's instructions.

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.

Retrieve example dataset

odie = pooch.create(
    path=pooch.os_cache("sleepeegpy_dataset"),
    base_url="doi:10.5281/zenodo.10362189",
)
odie.load_registry_from_doi()
bad_channels = odie.fetch("bad_channels.txt")
annotations = odie.fetch("annotations.txt")
path_to_eeg = odie.fetch("resampled_raw.fif")
for i in range(1,4):
    odie.fetch(f"resampled_raw-{i}.fif")

Releases

No releases published

Packages

No packages published

Languages

  • Jupyter Notebook 99.5%
  • Python 0.5%