提示

Apollo 10.0 版本开始，支持本机和Docker容器两种部署方式。

如果您使用本机部署方式，建议使用x86_64架构的Ubuntu 22.04操作系统或者aarch64架构的Ubuntu 20.04操作系统。

如果您使用Docker容器部署方式，可以使用x86_64架构的Ubuntu 18.04、20.04、22.04 操作系统或者aarch64架构的Ubuntu 20.04操作系统。

步骤一：安装基础软件

1. 安装 Ubuntu Linux

目前 Apollo 支持 Ubuntu 18.04 Ubuntu 20.04 以及 Ubuntu 22.04，安装的步骤，参见官方安装指南。

完成安装后更新相关软件：

sudo apt-get update

sudo apt-get upgrade

‍注意：若要完成更新，需要保证网络连接。

2. 安装 Docker Engine

‍提示：如果您使用本机部署方式，请跳过此步骤。

Apollo 依赖于 Docker 19.03+。安装 Docker 引擎，您可以根据官方文档进行安装：

参见 Install Docker Engine on Ubuntu。
您还可以者通过 Apollo 提供的安装脚本直接安装：

wget http://apollo-pkg-beta.bj.bcebos.com/docker_install.sh

bash docker_install.sh

这个过程可能会运行多次脚本，根据脚本提示执行即可。

步骤二（可选）：获取 GPU 支持

Apollo某些模块需要GPU的支持才能够编译、运行（例如感知模块），如果您需要使用此类模块，需要安装Nvidia显卡驱动以及Nvidia container toolkit以获取GPU支持。

‍注意：本教程只适用于ubuntu系统，虚拟机无法安装显卡驱动，wsl请自行上网搜索注意：如果您之前已经安装过Nvidia显卡驱动，即往终端输入nvidia-smi能够正常输出，可以跳过1.安装显卡驱动小节

1.安装驱动

可参照官网方法安装驱动官网驱动。

从 Apollo 10.0 开始，CUDA 最低版本要求为 11.8 ，因此推荐使用 520.61.05 以上版本的驱动，CUDA 版本与驱动版本的兼容信息可参考 Nvidia 官方文档。显卡驱动和CUDA版本兼容性，由于nvidia的硬件更新的很快，因此会遇到显卡驱动和CUDA版本不兼容的情况，以下为我们测试的畅通链路。

显卡系列	测试显卡	驱动版本	cuda版本
GeForce 10 Series	GeForce GTX 1080	nvidia-driver-535.183.01	CUDA Version ：11.8
GeForce RTX 20 Series	GeForce RTX 2070 SUPER	nvidia-driver-550.127.05	CUDA Version ：11.8
GeForce RTX 30 Series	GeForce RTX 3090	nvidia-driver-525.147.05	CUDA Version ：11.8
GeForce RTX 30 Series	GeForce RTX 3060	nvidia-driver-550.127.05	CUDA Version ：11.8
GeForce RTX 40 Series	GeForce RTX 4080	nvidia-driver-550.127.05	CUDA Version ：11.8
AMD	MI100 dGPU	ROCm™ 3.10 driver

您可以通过 Nvidia 官网来下载驱动 nvidia-driver-535.179

下载之后，找到相应的文件夹打开终端输入安装指令：

以 NVIDIA-Linux-x86_64-535.179.run 为例

sudo chmod 777 NVIDIA-Linux-x86_64-535.179.run

suod ./NVIDIA-Linux-x86_64-535.179.run

安装完毕后，您可以通过 nvidia-smi 指令来检查驱动是否安装成功，如果一切正常，您可以看到类似以下的提示：

Mon Nov 11 16:35:59 2024
+-----------------------------------------------------------------------------------------+
| NVIDIA-SMI 555.42.06              Driver Version: 555.42.06      CUDA Version: 12.5     |
|-----------------------------------------+------------------------+----------------------+
| GPU  Name                 Persistence-M | Bus-Id          Disp.A | Volatile Uncorr. ECC |
| Fan  Temp   Perf          Pwr:Usage/Cap |           Memory-Usage | GPU-Util  Compute M. |
|                                         |                        |               MIG M. |
|=========================================+========================+======================|
|   0  NVIDIA GeForce RTX 2070 ...    Off |   00000000:06:00.0 Off |                  N/A |
| 30%   36C    P8              4W /  215W |     200MiB /   8192MiB |      0%      Default |
|                                         |                        |                  N/A |
+-----------------------------------------+------------------------+----------------------+
 
+-----------------------------------------------------------------------------------------+
| Processes:                                                                              |
|  GPU   GI   CI        PID   Type   Process name                              GPU Memory |
|        ID   ID                                                               Usage      |
|=========================================================================================|
|    0   N/A  N/A      1095      G   /usr/lib/xorg/Xorg                             35MiB |
|    0   N/A  N/A      1972      G   /usr/lib/xorg/Xorg                             94MiB |
|    0   N/A  N/A      2102      G   /usr/bin/gnome-shell                           59MiB |
+-----------------------------------------------------------------------------------------+

2. 安装 Nvidia container toolkit

‍提示：如果您使用本机部署方式，请跳过此步骤。

为了在容器内获得 GPU 支持，在安装完 docker 后需要安装 NVIDIA Container Toolkit。运行以下指令安装 NVIDIA Container Toolkit：

curl -fsSL https://nvidia.github.io/libnvidia-container/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/nvidia-container-toolkit-keyring.gpg \
  && curl -s -L https://nvidia.github.io/libnvidia-container/stable/deb/nvidia-container-toolkit.list | \
    sed 's#deb https://#deb [signed-by=/usr/share/keyrings/nvidia-container-toolkit-keyring.gpg] https://#g' | \
    sudo tee /etc/apt/sources.list.d/nvidia-container-toolkit.list
sudo apt-get -y update
sudo apt-get install -y nvidia-container-toolkit

安装完毕后，配置 NVIDIA Container Toolkit

sudo nvidia-ctk runtime configure --runtime=docker

配置完成后重启docker

sudo systemctl restart docker

3. 安装 cuda-toolkit

若您期望将 Apollo 直接运行在主机上，而非容器内，您需要安装 cuda-toolkit，以支持 Apollo 的编译和运行。详细可参考 Nvidia cuda 安装文档。

以 Ubuntu22.04 为例，安装 cuda-toolkit 11.8

wget https://developer.download.nvidia.com/compute/cuda/repos/ubuntu2204/x86_64/cuda-keyring_1.1-1_all.deb
sudo dpkg -i cuda-keyring_1.1-1_all.deb
 
sudo apt-get update
 
sudo apt-get install -y cuda-toolkit-11-8

步骤三：安装 Apollo 环境管理工具

Apollo 环境管理工具是一个帮忙管理和启动 Apollo 环境的命令行工具。

1. 安装依赖软件

sudo apt-get update

sudo apt-get install ca-certificates curl gnupg

2. 在宿主机添加 Apollo 软件源的 gpg key，并设置好源和更新

# 添加 gpg key
sudo install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://apollo-pkg-beta.cdn.bcebos.com/neo/beta/key/deb.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/apolloauto.gpg
sudo chmod a+r /etc/apt/keyrings/apolloauto.gpg
 
# 设置源并更新
echo \
    "deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/apolloauto.gpg] https://apollo-pkg-beta.cdn.bcebos.com/apollo/core"\
    $(. /etc/os-release && echo "$VERSION_CODENAME") "main" | \
    sudo tee /etc/apt/sources.list.d/apolloauto.list
sudo apt-get update

‍注：如果之前已经安装过8.0版本的apollo的话，在宿主机上的/etc/apt/sources.list文件中会有形如 deb https://apollo-pkg-beta.cdn.bcebos.com/neo/beta bionic main的配置，可以直接删除，宿主机上的apollo源配置仅用于安装aem工具

3. 安装aem：

sudo apt install apollo-neo-env-manager-dev --reinstall

安装成功后即可使用

aem -h

步骤四：安装示例工程

1. 选择示例工程

Apollo 目前提供了3个示例工程，您可以根据需要选择其一

application-core , 包含 Apollo 所有开源软件包，可以基于此工程搭建自己的应用
application-pnc , 仅包含规划控制相关的软件包，适合仅关注规划控制方向的用户
application-perception , 仅包含感知相关的软件包，适合仅关注感知方向的用户

‍另外也可以使用 Apollo 全量源码的工程 apollo

‍提示：从Apollo 10.0开始，源码模式和包模式采用同一套编译工具，我们建议您统一使用下面的命令进行编译和运行，源码模式下的dev_start.sh、dev_into.sh、apollo.sh等脚本不再建议使用。

2. 克隆工程

以 application-core 为例

git clone https://github.com/ApolloAuto/application-core.git application-core

3. 启动并进入 Apollo 环境

# 先进入工程目录
cd application-core
 
# 切换环境配置, 会自动识别您的宿主机环境切换.env和.workspace.json配置
# 如果您使用apollo源码方式，不需要执行此步骤，aem会自动识别起动环境
bash setup.sh
 
# 启动容器
aem start
 
# 如果您选择使用本机而非docker容器进行环境安装，执行：
aem start -b host

‍注意：本机模式下后面的操作和容器内是一致的。后续都可以在当前工程目录下执行 aem enter 命令进入环境，一个是进入docker容器，一个是进入一个apollo bash空间。

4. 安装软件包

示例工程中包含一个名为 core 目录，其中 core/cyberfile.xml 文件中描述了工程所依赖软件包，可以通过 buildtool 工具进行依赖包的安装

buildtool build -p core
 
# 注：如果您想编译安装工作目录下的所有代码和包，请执行
buildtool build

‍此操作真正含义是编译工程中 core 这个包，但 core 本身并没有需要编译的代码，所以此操作仅会安装 core/cyberfile.xml 中声明的依赖包

‍提示：新版本buildtool编译的时候会默认带上 –opt –gpu（如果您使用gpu环境）参数，如果需要gdb调式请使用–dbg参数编译。

5. 选择车型配置

示例工程中profiles/sample目录是官方提供的基于一个雷达两个摄像头的车型配置，您可以参考profiles目录下的sample编写自己的车型配置，生效车型配置的方法如下：

# 以sample为例

aem profile use sample

6. 播放数据包

获取数据包

wget https://apollo-system.cdn.bcebos.com/dataset/6.0_edu/demo_3.5.record -P $HOME/.apollo/resources/records/

获取数据包对应的地图

buildtool map get sunnyvale

‍从 9.0.0-rc-r10 版本开始，地图数据已经被分离出来，需要单独下载，不再随地图包发布；通过 buildtool map list 可以查看所有可用的地图

启动 Dreamview+

aem bootstrap start --plus

在 Dreamview+ 中播放数据包

启动 Dreamview+ 之后，在浏览器输入 localhost:8888 进入 Dreamview+ 界面，您可以选择默认模式，也可以选择其他模式播放数据包。本小节以默认模式为例。

选择 Default Mode 。
勾选 Accept the User Agreement and Privacy Policy/接受用户协议和隐私政策 ，并单击 Enter this Mode 进入 Mode Settings/模式设置 页面。
在 Mode Settings/模式设置 页面，设置播包参数。
- 在 Operations/操作 中选择 Record 。
- 在 Environment Resources/环境资源 中，单击 Records/数据包 ，并选择具体想要播放的数据包。
- 在 Environment Resources/环境资源 中，单击 HDMap/高精地图 ，并选择 Sunnyvale Big Loop 。
单击底部区域播放按钮。

可以在 Vehicle Visualization/车辆可视化 中看到数据包播放的画面。

通过命令行播放数据包

进入 docker 环境，
在 Dreamview+ 中 Resource Manager/资源管理 > Records/数据包 中先下载需要的数据包。输入以下命令播放数据包：

cyber_recorder play -f ~/.apollo/resources/records/数据包名称 -l

‍注意：如果您想要循环播放数据包，添加 -l，如果不循环播放数据包，则不需要添加 -l。

8. 安装目录结构说明

至此，Apollo 安装已经完成

整个工程的目录结构如下

application-core
├── .aem
│   └── envroot
│       ├── apollo          # 会挂载到容器内的 /apollo 目录
│       └── opt             # 会挂载到容器内的 /opt/ 目录，而 Apollo 的软件包会默认安装到 /opt/ 下，因此该目录可以起到缓存的作用
├── core                    # 工程依赖包
│   ├── BUILD
│   └── cyberfile.xml       # 包的描述文件，描述整个工程的所有依赖
├── CPPLINT.cfg
├── data                    # 数据目录，会挂载到 /apollo/data
│   ├── calibration_data    # 标定配置目录，会挂载到 /apollo/modules/calibration/data
│   ├── kv_db.sqlite
│   ├── log                 # 日志目录，会挂载到 /opt/apollo/neo/data/log
│   └── map_data            # 地图目录，会挂载到 /apollo/modules/map/data
├── profiles                # 新版配置目录
│   ├── current -> sample   # 当前启用的配置目录
│   └── sample              # 官方提供的单lidar和两个camera样例车型配置
├── third_party
├── tools -> /opt/apollo/neo/packages/bazel-extend-tools/latest/src
├── .vscode                 # 默认的 vscode 配置
│   ├── c_cpp_properties.json
│   └── settings.json
├── WORKSPACE               # bazel 的配置
└── .workspace.json         # apollo 工程配置，可以在这指定软件包版本

接下来，您可以通过实践教程来学习放了解更多 Apollo 的使用方法

Apollo规划实践
Apollo感知实践

步骤五：删除工程（可选）

此步骤说明如何删除已安装的工程

1. 删除容器

以 application-core 工程为例

# 先进入工程目录
cd application-core
# 删除容器
aem remove

2. 删除工程

# 回到上一级目录
cd ..
# 删除工程目录
rm -r application-core

文档意见反馈

如果您在使用文档的过程中，遇到任何问题，请到我们在【开发者社区】建立的反馈意见收集问答页面，反馈相关的问题。我们会根据反馈意见对文档进行迭代优化。