Installation

Requirements

Lunascope is supported for Python 3.10 to 3.13.

Ideally, use a Python virtual environment: e.g.

python3.13 -m venv myenv

and active it (on macOS/Linux):

source myenv/bin/activate    # macOS / Linux

or on Windows:

myenv\Scripts\activate       # Windows

Download lunascope with pip

pip install lunascope

This will also install the dependent packes including lunapi.

Note: you may have to use python3 and pip3 on some platforms.

To run Lunascope, type from the command line:

lunascope

or (on some platforms):

python -m lunascope

Note: On first run, Lunascope will pause for a few moments while key libraries are configured; start-up will be faster on subsequent runs.

To open Lunascope with a particular EDF:

lunascope sleep1.edf

To open Lunascope with a particular annotation file (.annot or .xml as described here):

lunascope sleep1.annot

To open Lunascope with a particular sample list

lunascope s.lst

To open Lunascope with a particular parameter file applied, use the -p argument, e.g.:

lunascope s.lst -p my-param.txt

To open Lunascope with a particular configuration file applied, use the -c argument, e.g.:

lunascope s.lst -c hd-eeg.cfg

If new versions are available, force an upgrade with:

pip install --upgrade lunascope