Installation#

Dependencies#

  • mne (>=1.6)

  • numpy (>=1.21)

  • scipy (>=1.4.0)

  • sssm (>=0.0.5)

We require that you use Python 3.9 or higher. You may choose to install sleep-semantic-segmentation via pip, or conda.

Installation via Conda#

To install Sleep-Semantic-Segmentation using conda in a virtual environment, simply run the following at the root of the repository:

# with python>=3.9 at least
conda create -n sssm
conda activate sssm
conda install -c conda-forge wrap_sssm

Installation via Pip#

To install Sleep-Semantic-Segmentation including all dependencies required to use all features, simply run the following at the root of the repository:

python -m venv .venv
pip install -U wrap_sssm

If you want to install a snapshot of the current development version, run:

pip install --user -U https://api.github.com/repos/mne-tools/mne-connectivity/zipball/main

To check if everything worked fine, the following command should not give any error messages:

python -c 'import wrap_sssm'

sleep-semantic-segmentation works best with the latest stable release of SSSM. To ensure SSSM is up-to-date, run:

pip install --user -U sssm
On this page