mirror of
https://github.com/sunnypilot/sunnypilot.git
synced 2026-02-19 03:03:57 +08:00
3ca9b7f02e
* Try poetry
* Remove casadi for now
* Update docker
* Copy pipfiles
* add casadi back
* Too many slashes
* New poetry api
* Install system
* Try again
* No more pipenv
* new dependencies
* updates
* poetry 1.2.1, install dev dependencies
* keep install pipenv for xx for now?
* add pre-commit checks for poetry
* poetry lock is too slow
* update pip
* migrate to poetry groups
* update lockfile
* don't need to specify dev group unless it is made optional
* always install poetry
* set POETRY_VIRTUALENVS_CREATE instead, and use pipenv for xx
* use env for docs docker image
* alphabetical
* poetry 1.2.2
* add dev dependencies for typing
added in aacf6ae3
* remove constraint
* fix PIPENV_SYSTEM
* remove constraint
* don't need this here
* bump
* bump pipenv
adds support for installing local pyprojects (can add openpilot as dependency of xx)
* README improvements
* probably not necessary
* bump pip
* maybe not necessary?
* revert
* don't install openpilot itself into the virtual env
* remove PySide2 and shiboken2
reverts 3e41c775cbf670740ac648a8614d2d6b433312fe
* remove Pipenv, add xx dependencies, sync system python
* add pipenv as xx dep
* semver package constraints, use old lockfile versions
* fix casadi
* remove whitespace
Co-authored-by: Adeeb Shihadeh <adeebshihadeh@gmail.com>
* disable poetry cache
* cleanup
* prefer config file
Co-authored-by: Cameron Clough <cameronjclough@gmail.com>
Co-authored-by: Adeeb Shihadeh <adeebshihadeh@gmail.com>
old-commit-hash: a98d105cb9
66 lines
2.7 KiB
Markdown
66 lines
2.7 KiB
Markdown
# openpilot tools
|
|
|
|
## System Requirements
|
|
|
|
openpilot is developed and tested on **Ubuntu 20.04**, which is the primary development target aside from the [supported embedded hardware](https://github.com/commaai/openpilot#running-on-pc). We also have a CI test to verify that openpilot builds on macOS, but the tools are untested. For the best experience, stick to Ubuntu 20.04, otherwise openpilot and the tools should work with minimal to no modifications on macOS and other Linux systems.
|
|
|
|
## Setup your PC
|
|
|
|
First, clone openpilot:
|
|
``` bash
|
|
cd ~
|
|
git clone https://github.com/commaai/openpilot.git
|
|
|
|
cd openpilot
|
|
git submodule update --init
|
|
```
|
|
|
|
Then, run the setup script:
|
|
|
|
``` bash
|
|
# for Ubuntu 20.04 LTS
|
|
tools/ubuntu_setup.sh
|
|
|
|
# for macOS
|
|
tools/mac_setup.sh
|
|
```
|
|
|
|
Activate a shell with the Python dependencies installed:
|
|
|
|
``` bash
|
|
cd openpilot && poetry shell
|
|
```
|
|
|
|
Build openpilot with this command:
|
|
``` bash
|
|
scons -u -j$(nproc)
|
|
```
|
|
|
|
### Windows
|
|
|
|
Neither openpilot nor any of the tools are developed or tested on Windows, but the [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/about) should get Windows users a similar experience to 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-20.04` distribution. Once your Ubuntu WSL environment is setup, follow the Linux setup instructions to finish setting up your environment.
|
|
|
|
GUI applications do not work with WSL out of the box. You will have to either [upgrade your system to Windows 11](https://docs.microsoft.com/en-us/windows/wsl/tutorials/gui-apps) or [set up an Xorg server](https://techcommunity.microsoft.com/t5/windows-dev-appconsult/running-wsl-gui-apps-on-windows-10/ba-p/1493242).
|
|
|
|
|
|
## CTF
|
|
Learn about the openpilot ecosystem and tools by playing our [CTF](/tools/CTF.md).
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
├── ubuntu_setup.sh # Setup script for Ubuntu
|
|
├── mac_setup.sh # Setup script for macOS
|
|
├── 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
|
|
├── ssh/ # SSH into a comma device
|
|
└── webcam/ # Run openpilot on a PC with webcams
|
|
```
|