A python software tool to detect REM sleep behavioral disorder (RBD) in .edf files. Relies on .txt files of previously classified periods of sleep phases and arousals.
Table of contents:
- Download the zipped version of RBDtector here: dist/RBDtector.zip
- Extract the zip file into a folder of your choice
- Click the extracted RBDtector.exe to run RBDtector
In some cases, Windows Defender SmartScreen will flag RBDtector as an 'Application of unknown source'. This warning can simply be clicked away. If you want to, you can also submit the file to Windows' malware analysis before trusting it.
Installing RBDtector under MacOS or Linux requires the usage of simple terminal commands. General commands that work in the terminals of both operating systems can be found here.
- Prerequisites: Ensure you have a version of Git and Python 3 installed (including pip and tkinter - usually already included in Python 3)
- Open a terminal
- (optional: navigate to a folder into which you want to place RBDtector)
- Enter the following commands line by line:
- Clone git repository
git clone https://github.com/aroethen/RBDtector.git - Install requirements
python3 -m pip -r RBDtector/requirements.txt - Change into folder with main.py
cd RBDtector/RBDtector - Run with
python3 main.py
- Clone git repository
This project is licensed under the MIT License (s. LICENSE file).
This project gratefully uses the following third-party open source libraries:
| Library | License |
|---|---|
| pyEDFlib | BSD 2-Clause "Simplified" License |
| numpy | [BSD 3-Clause "New" or "Revised" License] (https://github.com/numpy/numpy/blob/main/LICENSE.txt) |
| pandas | [BSD 3-Clause "New" or "Revised" License] (https://github.com/pandas-dev/pandas/blob/main/LICENSE) |
| scipy | [BSD 3-Clause "New" or "Revised" License] (https://github.com/scipy/scipy/blob/main/LICENSE.txt) |
| openpyxl | [MIT License] (https://foss.heptapod.net/openpyxl/openpyxl/-/blob/branch/3.0/LICENCE.rst) |