Overview of Solar Sails

"SunVox Augmentation and Interactive Live-coding System"

Solar Sails is a cross-platform app that augments the SunVox modular music studio.

It combines Radiant Voices, Solar Flares, and sunvox-dll-python into a downloadable app that provides a workspace to make use of those tools.

Downloading and installing

Solar Sails is still alpha-quality software.

Please follow the steps outlined in the installation docs.

Requirements for downloadable app

• MacOS 10.11 El Capitan, or later
• Windows 7, or later, 64-bit install
• Linux, 64-bit install, Ubuntu 16.04 or equivalent

Requirements for building from source

• Python 3.12 or later
• OS supported by PyQt6 and sunvox-dll-python.
• uv package manager

Development setup

To set up a development environment:

1. Install uv if not already installed:

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

2. Clone the repository and navigate to the project directory:

   git clone https://github.com/metrasynth/solar-sails.git
   cd solar-sails
   

3. Install Python 3.12 and sync dependencies:

   uv python install 3.12
   uv sync --all-extras
   

4. Install the package in editable mode:

   uv pip install -e .
   

5. Run the application:

   uv run sails-gui
   

6. Run tests:

   uv run pytest
   

Metrasynth

Solar Sails is part of the Metrasynth project.