Skip to content

Automatically score rodent sleep using EEG and EMG recordings

License

Notifications You must be signed in to change notification settings

zekebarger/AccuSleePy

Repository files navigation

AccuSleePy

Description

AccuSleePy is a python implementation of AccuSleep--a set of graphical user interfaces for scoring rodent sleep using EEG and EMG recordings. It offers several improvements over the original MATLAB version and is the only version that will be actively maintained.

If you use AccuSleep in your research, please cite our publication:

Barger, Z., Frye, C. G., Liu, D., Dan, Y., & Bouchard, K. E. (2019). Robust, automated sleep scoring by a compact neural network with distributional shift correction. PLOS ONE, 14(12), 1–18.

The data and models associated with AccuSleep are available at https://osf.io/py5eb/

Please contact zekebarger (at) gmail (dot) com with any questions or comments about the software.

Installation

  • (recommended) create a new virtual environment (using venv, conda, etc.) using python >=3.10,<3.13
  • (optional) if you have a CUDA device and want to speed up model training, install PyTorch
  • pip install accusleepy
  • (optional) download a classification model from https://osf.io/py5eb/ under /python_format/models/

Usage

python -m accusleepy will open the primary interface.

Screenshots

Primary interface AccuSleePy primary interface

Manual scoring interface AccuSleePy manual scoring interface

Acknowledgements

We would like to thank Franz Weber for creating an early version of the manual labeling interface. Jim Bohnslav's deepethogram served as an incredibly useful reference when reimplementing this project in python.

About

Automatically score rodent sleep using EEG and EMG recordings

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages