Skip to content

Getting started

Installation

Somnio requires Python 3.10+.

With uv

uv add somnio

To use the CLI, install with the optional cli extra:

uv add somnio --extra cli

With pip

pip install somnio

For CLI support:

pip install somnio[cli]

For HDF5 signal layouts (somnio.io.hdf5, native and USleep formats):

uv add somnio --extra hdf5
# or
pip install somnio[hdf5]

Verify installation

If you installed the CLI extra, confirm it works:

somnio --help

You should see the list of commands (e.g. download-nsrr).