🏃 Getting started

🔗 Compatibility

While the web app is compatible with most browsers, we've encountered intermittent issues with Firefox on Windows 11 and Safari on macOS 14. For optimal performance, we recommend using Chrome.

🔧 sse_vis Command

warning

Ensure you have an active Python venv in a terminal window.

info

Learn how to activate 🔮 virtual environments

This command swiftly initiates both the Audio and Front services.

In an active venv terminal, enter the following command to start both services (replace the path to your configuration file by dragging and dropping the configuration file icon into your terminal):

# Windows
sse_vis C:\path\to\config.xlsx

# Ubuntu / macOS
(venv)$> sse_vis /path/to/config.xlsx

After pressing <Enter>, both services will launch, and your default browser will open.

note

You can alternatively use sse_viz as an alias for the sse_vis command.

Windows screencast

🔧 audio:front Command

Simultaneously start both the Front and Audio services.

pnpm audio:front relative/or/absolute/path/to/audio/folder

🔧 audio Command

Start the Audio service on port 5531.

pnpm audio -- relative/or/absolute/path/to/audio/folder

🔧 front Command

Start the Front service on port 5530.

pnpm front