sunnypilot v2026.002.000

version: sunnypilot v2026.002.000 (staging)
date: 2026-07-21T07:44:02
master commit: 2c334ede443d7391d27575af8c854a095ba702a8

tools/README.md

@@ -0,0 +1,59 @@
+# openpilot tools
+
+## System Requirements
+
+openpilot is developed and tested on **Ubuntu 24.04**, which is the primary development target aside from the [supported embedded hardware](https://github.com/commaai/openpilot#running-on-a-dedicated-device-in-a-car).
+
+Most of openpilot 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 openpilot**
+``` bash
+git clone https://github.com/commaai/openpilot.git
+```
+
+**2. Run the setup script**
+``` bash
+cd openpilot
+tools/op.sh setup
+```
+
+**3. Activate a Python shell**
+Activate a shell with the Python dependencies installed:
+``` bash
+source .venv/bin/activate
+```
+
+**4. Build openpilot**
+``` bash
+scons -u
+```
+
+## WSL on Windows
+
+[Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/about) should provide a similar experience to native Ubuntu. [WSL 2](https://docs.microsoft.com/en-us/windows/wsl/compare-versions) specifically has been reported by several users to be a seamless experience.
+
+Follow [these instructions](https://docs.microsoft.com/en-us/windows/wsl/install) 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](https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps) for running GUI apps.
+
+**NOTE**: If you are running WSL 2 and experiencing performance issues with the UI or simulator, you may need to explicitly enable hardware acceleration by setting `GALLIUM_DRIVER=d3d12` before commands. Add `export GALLIUM_DRIVER=d3d12` to your `~/.bashrc` file to make it automatic for future sessions.
+
+## CTF
+Learn about the openpilot ecosystem and tools by playing our [CTF](/tools/CTF.md).
+
+## 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 openpilot logs
+├── plotjuggler/        # A tool to plot openpilot logs
+├── replay/             # Replay drives and mock openpilot services
+├── scripts/            # Miscellaneous scripts
+├── serial/             # Tools for using the comma serial
+├── sim/                # Run openpilot in a simulator
+└── webcam/             # Run openpilot on a PC with webcams
+```