Skip to main content

Sleep-EEG viewer and interface to Luna

Project description

lunascope

A viewer and frontend for Luna (http://zzz.nyspi.org/luna/)

Requirements:

  • Python 3.9 - 3.14

  • Compatible with CPython: PyPy not supported.

  • Depends on lunapi, the Python version of the core Luna library. This binary package is tested and supported on macOS (Intel and Apple Silicon), Linux (x86_64), and Windows 10/11 (x86_64) with Python 3.9 – 3.14. Other platforms or Python versions may build successfully from source but are not officially supported.

Standalone Binaries (no Python required)

Pre-built standalone apps for macOS and Windows are available from the Latest Build release — no Python installation needed.

macOS

  1. Download Lunascope.app.zip and unzip it.

  2. Move Lunascope.app to your Applications folder (or anywhere you like).

  3. First launch only: macOS will block the app because it is not from the App Store. Right-click (or Control-click) Lunascope.app and choose Open, then click Open in the dialog that appears. You only need to do this once; subsequent double-clicks will work normally.

    If you see "Lunascope.app" will damage your computer and no Open option appears, run this once in Terminal to remove the quarantine flag:

    xattr -dr com.apple.quarantine /path/to/Lunascope.app
    

Windows

  1. Download Lunascope-Windows.zip and unzip it (right-click → Extract All).
  2. Open the extracted Lunascope.dist folder and double-click Lunascope.exe.
  3. First launch only: Windows SmartScreen may show a blue "Windows protected your PC" dialog because the app is not code-signed. Click More info, then Run anyway.

Note: These binaries are unsigned. Your browser or antivirus may warn you on download — this is expected. The source code is fully open and auditable above.


Installation

lunascope is distributed via PyPI:

pip install lunascope

After installation, you can launch it from the command line:

lunascope

or equivalently:

python -m lunascope

Recommended: Use a Virtual Environment

It is strongly recommended to install lunascope into a virtual environment rather than into your system Python.

Option 1 — Using venv (Standard Python)

Create and activate a virtual environment:

macOS / Linux

python3 -m venv .venv
source .venv/bin/activate

Windows

python -m venv .venv
.venv\Scripts\activate

Then install:

pip install lunascope

Run:

lunascope

To leave the environment:

deactivate

Option 2 — Using pipx (Recommended for CLI Apps)

If you prefer to install lunascope as an isolated application:

pipx install lunascope

Then run:

lunascope

pipx keeps the application isolated from your main Python installation and avoids dependency conflicts. This is often the simplest option if you are not otherwise managing environments.


Python vs python3

On some systems:

  • python may refer to Python 2 (older systems)
  • python3 refers to Python 3

Check your version:

python --version

or:

python3 --version

Use whichever command reports Python 3.9–3.14.

Similarly for pip:

pip3 install lunascope

or more explicitly:

python3 -m pip install lunascope

Using python -m pip ensures you install into the correct interpreter.


Platform Notes

  • Supported platforms: macOS (Intel & Apple Silicon), Linux (x86_64), Windows 10/11 (x86_64).
  • On macOS with Homebrew Python, you may see an “externally managed environment” error. In that case, use a virtual environment or pipx.
  • On Windows, install Python from python.org and ensure “Add Python to PATH” is checked during installation.

First Launch

The first time you run lunascope, startup may take longer while dependencies and components initialize. Subsequent launches are typically much faster.


Updating

If installed with pip:

pip install --upgrade lunascope

If installed with pipx:

pipx upgrade lunascope

Uninstalling

With pip:

pip uninstall lunascope

With pipx:

pipx uninstall lunascope

Questions

Please write to luna.remnrem@gmail.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lunascope-0.3.2-py3-none-any.whl (117.1 kB view details)

Uploaded Python 3

File details

Details for the file lunascope-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: lunascope-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 117.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for lunascope-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a5988f362b88b7551f3356938d480aafff706e980986e1bdf29a92d4967fe49c
MD5 c4d6eab9bdf331226af2c4e378a7fd12
BLAKE2b-256 8be236a49d773b9031293d2de11cfa98ceff455ffdb9de8d8d1a2505f288804d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page