Skip to main content

Sleep EEG preprocessing, analysis and visualization

Project description

sleepeegpy

sleepeegpy is a high-level package built on top of mne-python, yasa and specparam (fooof) for preprocessing, analysis, and visualization 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 this repository zip folder, you will need only the notebooks folder.

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")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sleepeegpy-0.6.0.tar.gz (27.7 kB view details)

Uploaded Source

Built Distribution

sleepeegpy-0.6.0-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

Details for the file sleepeegpy-0.6.0.tar.gz.

File metadata

  • Download URL: sleepeegpy-0.6.0.tar.gz
  • Upload date:
  • Size: 27.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for sleepeegpy-0.6.0.tar.gz
Algorithm Hash digest
SHA256 cec03c5a70cefa9cafeda0975eb4b77e59460d80fe8b2311c1f32c7bda61f421
MD5 8cf6050e94a1f67cc8f2bd1086474e98
BLAKE2b-256 c10cc59b90b26af2454d1093594fc44eeec55a8d9e396aaf5d861749757deb56

See more details on using hashes here.

File details

Details for the file sleepeegpy-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: sleepeegpy-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 28.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for sleepeegpy-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 622788053c9aa9188b68511f77272aea64ea65a34a211de6995deadbd010479c
MD5 bb5c33262e1373e54b3a9fac2ca539ee
BLAKE2b-256 b98592c3ba36540f66588ea4501b546b45c7965f05abf5ef113daf87be58e3d8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page