Welcome to Snooz Toolbox documentation!

Snooz Toolbox is a Python software for the analysis of sleep recordings (Polysomnography). It is developped by the team at the CARSM (Center for Advanced Research in Sleep Medicine) of Montreal.

Note

This documentation is under active development.

User’s Guide

Want to install and use Snooz? Follow this guide!

• To get started with Snooz: Getting Started with Snooz

• To manage Snooz packages: Snooz packages

• For details on required data formats: Polysomnography file format

• For information about a specific tool or app: Tools and Apps

• For details on EDFbrowser compatibility when using it as a polysomnography viewer with Snooz: EDFbrowser compatibility

• For instructions on running Snooz on Compute Canada clusters for users: Running Snooz on Compute Canada for Users

Developer’s Guide

Are you a programmer? Want to integrate your process into Snooz? Follow this guide!

• To understand how it all works, check out the Technical Overview

• To get the code and start coding, click here: Developer Installation

• To run Snooz from the source code, see : Run Snooz from the source code

• To explore examples before creating your first package, see : Explore examples

• For instructions on running Snooz on Compute Canada clusters for developers: Running Snooz on Compute Canada for Developers

• For specific programming questions, check out the How Tos section: How Tos

• For more details about the Snooz architecture, check out the Information section: Information