Most of IQ.Pilot should work natively on macOS. On Windows you can use WSL for a nearly native Ubuntu experience. Running natively on any other system is not currently recommended and will likely require modifications.

Native setup on Ubuntu 24.04 and macOS

Follow these instructions for a fully managed setup experience. If you'd like to manage the dependencies yourself, just read the setup scripts in this directory.

1. Clone IQ.Pilot

git clone https://gitlvb.teallvbs.xyz/IQ.Lvbs/IQ.Pilot.git

2. Run the setup script

cd IQ.Pilot
tools/op.sh setup

3. Activate a Python shell Activate a shell with the Python dependencies installed:

source .venv/bin/activate

4. Build IQ.Pilot

scons -u -j$(nproc)

Using IQ.Pilot tools with Konn3kt:

This guide explains how to use IQ.Pilot tools to view and analyze routes from Konn3kt.

Overview

All you need to do is authenticate with Konn3kt so you can access your routes.

Quick Start

1. Authenticate with Konn3kt

Run the authentication helper script:

cd IQ.Pilot
python3 tools/lib/konn3kt_auth.py

This will:

Open your browser to log in via OAuth
Save your authentication token to ~/.comma/auth.json
Allow access to your Konn3kt routes

2. Headless/WSL fallback

If browser auto-open is unavailable, use:

python3 tools/lib/konn3kt_get_token.py

How It Works

OP Tools reads your Konn3kt JWT token from ~/.comma/auth.json.

You can always view public routes!

WSL on Windows

Windows Subsystem for Linux (WSL) should provide a similar experience to native Ubuntu. WSL 2 specifically has been reported by several users to be a seamless experience.

Follow these instructions to setup the WSL and install the Ubuntu-24.04 distribution. Once your Ubuntu WSL environment is setup, follow the Linux setup instructions to finish setting up your environment. See these instructions for running GUI apps.

NOTE: If you are running WSL and any GUIs are failing (segfaulting or other strange issues) even after following the steps above, you may need to enable software rendering with LIBGL_ALWAYS_SOFTWARE=1, e.g. LIBGL_ALWAYS_SOFTWARE=1 selfdrive/ui/ui.

CTF

Learn about the IQ.Pilot ecosystem and tools by playing our CTF.

Directory Structure

├── cabana/             # View and plot CAN messages from drives or in realtime
├── camerastream/       # Cameras stream over the network
├── joystick/           # Control your car with a joystick
├── lib/                # Libraries to support the tools and reading IQ.Pilot logs
├── plotjuggler/        # A tool to plot IQ.Pilot logs
├── replay/             # Replay drives and mock IQ.Pilot services
├── scripts/            # Miscellaneous scripts
├── serial/             # Tools for using the comma serial
├── sim/                # Run IQ.Pilot in a simulator
└── webcam/             # Run IQ.Pilot on a PC with webcams