sleeplab-format

NOTE: this software is under initial development, breaking changes may occur.

Tools for transforming heterogeneous sleep measurement data to a unified format.

Related tools

sleeplab-converters for converting other formats exported from PSG software to sleeplab format.

sleeplab-extractor for extracting and preprocessing a subset of data in sleeplab format for the needs of specific studies.

sleeplab-tf-dataset for reading data in sleeplab format as a tensorflow Dataset.

Installation

For development, you need to install from cloned repository. To just use the current version, install with pip from github.

Install with pip from Github

pip install git+https://github.com/UEF-SmartSleepLab/sleeplab-format.git#egg=sleeplab-format

Install from cloned repository

Clone repository to your local files:

git clone [email protected]:UEF-SmartSleepLab/sleeplab-format.git

This project uses Hatch for project management. First, install hatch. You will also need a recent version of pip.

Then, go to the root of the cloned repository and create an environment for it:

hatch env create

After that, you can enter the environment by:

hatch shell

You can confirm that the project has been installed by:

pip show sleeplab-format

Usage

See the automatic sleep staging example for a full end-to-end example.

Running tests

This project uses pytest for testing. To run the tests after cloning and installing, go to the root of the cloned repository and run:

pytest

How to contribute

We follow Github flow in the development.

The basic procedure to contribute code to the project is:

1. Install from cloned repository
2. Create your own branch and implement the changes (and tests, preferably)
3. Make sure the tests pass
4. Create a pull request on Github
5. Another contributor reviews the pull request
6. Fix review comments if any
7. Reviewer merges the pull request