mirror of
https://github.com/sunnypilot/sunnypilot.git
synced 2026-02-18 23:33:58 +08:00
tools: add info on common issues (#22709)
* tools/README.md: add more information
1. Add info about OpenCL drivers
2. Add info about pipenv environment
* ubuntu_setup.sh: add clinfo
Adds the clinfo command so you can verify your OpenCL installation.
* tools/README.md: add info on GUI WSL
old-commit-hash: e68849cfc8
This commit is contained in:
@@ -31,12 +31,28 @@ MacOS:
|
||||
openpilot/tools/mac_setup.sh
|
||||
```
|
||||
|
||||
3. Build openpilot by running SCons in the root of the openpilot directory
|
||||
3. Ensure you have a working OpenCL runtime:
|
||||
|
||||
You can verify your OpenCL installation with the `clinfo` command.
|
||||
|
||||
If you do not have any working platforms, you can download drivers from your GPU vendor's site.
|
||||
On Ubuntu you can just install one of the packages returned by `apt search opencl-icd`.
|
||||
|
||||
4. Activate the Python environment:
|
||||
|
||||
Execute the following command in root openpilot directory:
|
||||
```bash
|
||||
pipenv shell
|
||||
```
|
||||
|
||||
Your shell prompt should change to something similar to `(openpilot) user@machine:~/openpilot$ `.
|
||||
|
||||
5. Build openpilot by running SCons in the root of the openpilot directory
|
||||
``` bash
|
||||
cd openpilot && scons -j$(nproc)
|
||||
```
|
||||
|
||||
4. Try out some tools!
|
||||
6. Try out some tools!
|
||||
|
||||
NOTE: you can always run `update_requirements.sh` to pull in new python dependencies.
|
||||
|
||||
@@ -47,6 +63,8 @@ Neither openpilot nor any of the tools are developed or tested on Windows, but t
|
||||
|
||||
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).
|
||||
|
||||
Tools
|
||||
============
|
||||
|
||||
|
||||
@@ -57,6 +57,7 @@ function install_ubuntu_common_requirements() {
|
||||
opencl-headers \
|
||||
ocl-icd-libopencl1 \
|
||||
ocl-icd-opencl-dev \
|
||||
clinfo \
|
||||
python-dev \
|
||||
python3-pip \
|
||||
qml-module-qtquick2 \
|
||||
|
||||
Reference in New Issue
Block a user