Windows 下的构建

本指南详细介绍了如何在 Windows 上从源代码构建 Carla。有两个部分。第一部分详细介绍系统要求和所需软件的安装，第二部分详细介绍如何实际构建和运行 Carla。

构建过程很长（4小时或更长时间）并且涉及多种软件。强烈建议在开始之前完整阅读该指南。

如果您遇到错误或困难，请查看常见问题解答页面，其中提供了最常见问题的解决方案。或者使用 Carla 论坛 发布您可能有的任何疑问。

• 第一部分：先决条件
  • 系统要求
  • 软件要求
    • 基础软件安装
    • Python 依赖项
    • 主要软件安装
      • Visual Studio 2019
      • 虚幻引擎
• 第二部分：构建 Carla
  • 克隆 Carla 仓库
  • 获取资产
  • 设置虚幻引擎环境变量
  • 构建 Carla
  • 其他 make 命令
  • 其他
• 报错

---

第一部分：先决条件

在本节中，您将找到开始构建 Carla 之前所需的系统要求、次要和主要软件安装以及 Python 依赖项的详细信息。

系统要求

• 64 位操作系统。 模拟器应在任何 64 位 Windows 系统中运行。
• 165 GB 磁盘空间。 Carla 本身将占用大约 32 GB，相关的主要软件安装（包括虚幻引擎）将占用大约 133 GB。
• 足够的 GPU。 Carla 旨在实现真实模拟，因此服务器至少需要 6 GB GPU，但建议使用 8 GB。强烈建议使用专用 GPU 进行机器学习。
• 两个 TCP 端口和良好的互联网连接。 默认端口为 2000 和 2001 。 确保这些端口未被防火墙或任何其他应用程序阻止。

软件要求

基础软件安装

• CMake 从简单的配置文件生成标准构建文件。
• Git 是一个用于管理 Carla 存储库的版本控制系统。
• Make 生成可执行文件。必须使用 Make 的 3.81 版本，否则构建可能会失败。如果安装了多个版本的 Make，请检查构建 Carla 时在 PATH 中使用的版本是否为 3.81。您可以通过运行来检查默认的 Make 版本 make --version。（运行可能出现由于找不到libintl3.dll， 说明需要 Visual C++ Redistributable for Visual Studio 2015，但是vs2019安装不了低版本，所以安装了make-4.4.1 ）
• 7Zip 一款文件压缩软件。这是自动解压缩资产文件所必需的，并防止在构建期间由于错误或部分提取大文件而出现错误。
• Python3 x64 是 Carla 中的主要脚本语言。安装 x32 版本可能会导致冲突，因此强烈建议卸载它。

Python 依赖项

从 Carla 0.9.12 开始，用于可以选择使用 pip3 来安装 Carla 的 Python API。要检查您是否有合适的版本，请运行以下命令：

pip3 -V

如果您需要升级：

pip3 install --upgrade pip

您必须安装以下 Python 依赖项：

pip3 install --user setuptools
pip3 install --user wheel

主要软件安装

Visual Studio 2019

从 此处 获取 2019 版 Visual Studio 。选择 社区 作为免费版本。使用 Visual Studio 安装程序 安装三个附加元素：

• Windows 8.1 SDK. 在右侧的 Installation details 部分中选择它，或者转到 Indivdual Components 选项卡并在 SDKs, libraries, and frameworks 标题下查看。
• x64 Visual C++ Toolset. 在 Workloads 部分中，选择 Desktop development with C++ 。这将启用用于构建的 x64 命令提示符。通过按 Windows 按钮并搜索 x64 来检查它是否已正确安装。小心 不要打开x86_x64提示。
• .NET framework 4.6.2. 在 Workloads 部分中，选择 .NET desktop development ，然后在右侧的安装详细信息面板中选择 .NET Framework 4.6.2 development tools。这是构建虚幻引擎所必需的。

命令行参数安装 。

虚幻引擎

从版本 0.9.12 开始，Carla 使用虚幻引擎 4.26 的修改版。该分支包含 Carla 特定的补丁。

请注意，要下载虚幻引擎的这个分支，您需要有一个链接到虚幻引擎帐户的 GitHub 帐户 。如果您没有进行此设置，请先按照 本指南 进行操作，然后再继续操作。

要构建虚幻引擎的修改版本：

1. 在终端中，导航到要保存虚幻引擎的位置并克隆 carla 分支：

git clone --depth 1 -b carla https://github.com/CarlaUnreal/UnrealEngine.git .

2. 运行配置脚本：

Setup.bat
GenerateProjectFiles.bat

3. 编译修改后的引擎：

1. 使用 Visual Studio 2019打开UE4.sln源文件夹内的文件。

2. 在构建栏中，确保您已选择“Development Editor”、“Win64”和“UnrealBuildTool”选项。如果您需要任何帮助，请查看 本指南 。

3. 在解决方案资源管理器中，右键单击UE4并选择Build。

4. 编译解决方案后，您可以打开引擎，通过启动可执行文件 Engine\Binaries\Win64\UE4Editor.exe 来检查所有内容是否已正确安装。

---

第二部分：构建 Carla

克隆 Carla 存储库

上面的按钮将带您进入该项目的官方存储库。从那里下载并在本地提取它或使用以下命令克隆它：

git clone https://github.com/carla-simulator/carla

获取资产

通过在 Carla 根文件夹中运行以下命令，下载 最新的 资产以使用当前版本的 Carla：

Update.bat

如果安装了 7zip，资源将被下载并解压到适当的位置。如果您没有安装此软件，则需要手动将文件内容解压到Unreal\CarlaUE4\Content\Carla。

要下载 特定版本 Carla 的资源：

1. 从 Carla 根目录，导航到\Util\ContentVersions.txt。本文档包含所有 Carla 版本的资产链接。
2. 提取 Unreal\CarlaUE4\Content\Carla 中的资产。如果该路径不存在，请创建它。
3. 使用类似于以下内容的命令提取文件：

tar -xvzf <assets_file_name>.tar.gz.tar -C C:\path\to\carla\Unreal\CarlaUE4\Content\Carla

设置虚幻引擎变量

需要设置一个环境变量，以便 Carla 可以找到虚幻引擎的安装文件夹。这允许用户选择要使用哪个特定版本的虚幻引擎。如果未指定环境变量，Carla 将在 Windows 注册表中搜索虚幻引擎并使用在那里找到的第一个版本。

设置环境变量：

1. 打开 Windows 控制面板，然后转至Advanced System Settings或在 Windows 搜索栏中搜索 Advanced System Settings。
2. 在面板上AdvancedAdvanced打开Environment Variables...。
3. 单击New...以创建变量。
4. 为变量UE4_ROOT命名并选择所需虚幻引擎安装的安装文件夹的路径。

构建 Carla

本节概述了构建 Carla 的命令。

• 所有命令都应在根 Carla 文件夹中运行。
• 命令应通过VS 2019 的 x64 Native Tools Command Prompt for VS 2019 执行。通过单击该Windows键并搜索 来打开它x64。

Carla 的构建过程分为两部分：编译客户端和编译服务器。

1. 编译 Python API 客户端:

Python API 客户端授予对模拟的控制权。第一次构建 Carla 时需要编译 Python API 客户端，并且在执行任何更新后需要再次编译。客户端编译完成后，您将能够运行脚本与模拟进行交互。

以下命令编译 Python API 客户端：

make PythonAPI

生成的客户端安装文件位于PythonAPI/carla/dist/。Carla 客户端库将以两种截然不同、互斥的形式构建。这使用户可以自由选择他们喜欢的形式来运行 Carla 客户端代码。两种形式包括.egg文件和.whl文件。选择以下选项 之一 来使用客户端库：

A. .egg 文件

.egg 文件不需要安装。导入 Carla 时，Carla 的所有示例脚本都会自动 查找此文件 。

如果您之前安装了 Carla .whl，则 它将.whl优先于.egg文件。

B. .whl 文件

应使用以下pip3命令安装.whl文件：

pip3 install <path/to/wheel>.whl

.whl文件无法分发，因为它是专门为您的操作系统构建的。

2. 编译服务端:

以下命令编译并启动虚幻引擎。每次您想要启动服务器或使用虚幻引擎编辑器时运行此命令：

make launch

该项目可能会要求构建其他实例，例如UE4Editor-Carla.dll第一次。同意才能打开项目。在首次启动期间，编辑器可能会显示有关着色器和网格距离场的警告。这些需要一些时间来加载，在此之前地图将无法正确显示。

3. 开始模拟:

按Play开始服务器模拟。可以使用按键移动相机WASD，并通过在移动鼠标的同时单击场景来旋转相机。

使用里面的示例脚本测试模拟器PythonAPI\examples。在模拟器运行的情况下，为每个脚本打开一个新终端并运行以下命令以在城镇中产生一些生命并创建天气循环：

# 终端 A 
cd PythonAPI\examples
pip3 install -r requirements.txt
python3 generate_traffic.py  

# 终端 B
cd PythonAPI\examples
python3 dynamic_weather.py 

其他 make 命令

您可能会发现还有更多有用的make命令。在下表中找到它们：

命令	描述
make help	打印所有可用的命令。
make launch	在编辑器窗口中启动 Carla 服务器。
make PythonAPI	构建 Carla 客户端。
make LibCarla	准备将 Carla 库导入到任何地方。
make package	构建 Carla 并创建用于分发的打包版本。
make clean	删除构建系统生成的所有二进制文件和临时文件。
make rebuild	make clean 和 make launch 两者都在一个命令中。
make downloadplugin	构建虚幻引擎插件 StreetMap 。
make setup	构下载并生成依赖库
make LibCarla	创建LibCarla的客户端和服务端（make server+make client）
make osm2odr	创建OSM转OpenDRIVE的库
make import	导入资产

构建一个 egg 分发包（binary distribution），会在当前目录下的“dist”目录内创建一个“egg”文件，文件名格式就是”项目名-版本号-Python版本.egg”：

python setup.py bdist_egg

构建一个 wheel 分发包，egg 包是过时的，whl 包是新的标准：

python setup.py bdist_wheel

脚本setup.py中的ext_modules参数用于构建 C 和 C++ 扩展扩展包。其是 Extension 实例的列表，每一个 Extension 实例描述了一个独立的扩展模块，扩展模块可以设置扩展包名，头文件、源文件、链接库及其路径、宏定义和编辑参数等。

当你安装一个包后，这个包需要你不断修改，这时就采用这种安装方法：python setup.py develop。仅在Python37/Lib/site-packages目录下生成链接文件carla.egg-link 指向 carla\PythonAPI\carla\source和../。

而python setup.py install在Python37\Lib\site-packages\carla-0.9.15-py3.7-win-amd64.egg目录下生成运行包，包括libcarla.cp37-win_amd64.pyd。

其他

如果想重新编译LibCarla或者使用最新的修改，需要删除Build/libcarla-visualstudio目录，然后重新运行编译命令：

make LibCarla

则服务端文件carla_server.lib生成至carla\Unreal\CarlaUE4\Plugins\Carla\CarlaDependencies\，客户端文件carla_client.lib生成至carla\PythonAPI\carla\dependencies\。

启动vs2019环境的命令：

call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"
set PATH=C:\software\make-4.4.1\bin;%PATH%
echo %PATH%

启动Python虚拟环境报错：CondaError: Run 'conda init' before 'conda activate'

conda init cmd.exe  # 先执行这个，然后再激活虚拟环境
conda activate carla_cpp

执行make PythonAPI时候报错：无法加载文件Microsoft.PowerShell_profile.ps1...因为在此系统上禁止运行脚本：

# 使用管理员权限启动PowerShell，修改当前用户权限
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
# 弹出选择项后选择`A`

执行make PythonAPI时报错：

-[BuildPythonAPI]: [Batch params]: --py3
信息: 用提供的模式无法找到文件。
-[BuildPythonAPI]: [ERROR] An error ocurred while executing the py.
-[BuildPythonAPI]: [ERROR] Possible causes:
-[BuildPythonAPI]: [ERROR]  - Make sure "py" is installed.
-[BuildPythonAPI]: [ERROR]  - py = python launcher. This utility is bundled with Python installation but not installed by default.
-[BuildPythonAPI]: [ERROR]  - Make sure it is available on your Windows "py".
make: *** [Util/BuildTools/Windows.mk:62: PythonAPI] Error 1

报错位置：BuildPythonAPI.bat：

where py 1>nul
if %errorlevel% neq 0 goto error_py

%errorlevel%表达上一条命令的返回值。0一般会被视为成功，非0为失败或者异常。 应该修改为：

```shell
where python 1>nul
if %errorlevel% neq 0 goto error_py

### 系统
Win11专业版 [激活方法](https://www.orcy.net.cn/1802.html) 。


## 报错 <span id="error"></span>
* 执行`make osm2odr`报错：
```text
CMake Error: The source directory "D:/work/workspace/carla/Build/osm2odr-visualstudio/x64" does not appear to contain CMakeLists.txt.
Specify --help for usage, or press the help button on the CMake GUI.
Error: could not load cache

从其他地方把Build\osm2odr-visualstudio\CMakeCache.txt拷贝过来，修改里面对应的目录为当前工程的目录。

---

• 执行make PythonAPI报错：

libcarla.obj : error LNK2001: 无法解析的外部符号 "class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> > __cdecl osm2odr::ConvertOSMToOpenDRIVE(class std::basic_string<char,struct std::char_traits<char>,class std::allocator<char> >,struct osm2odr::OSM2ODRSettings)" (?ConvertOSMToOpenDRIVE@osm2odr@@YA?AV?$basic_string@DU?$char_traits@D@std@@V?$allocator@D@2@@std@@V23@UOSM2ODRSettings@1@@Z)

从其他编译成功的地方将PythonAPI\carla\dependencies\lib\osm2odr.lib拷贝过来。

• 同一台机器中之前安装过vs，再安装时报错：无法安装 Microsoft.VisualStudio.Debugger.JustInTime.Msi 和 Could not open key: UNKNOWNComponents Werify that you have sufficient access to that key, or contact your support personnel.

解决：注册表编辑器无法在当前所选的项及其部分子项上设置安全性 。

注意：使用在线安装文件vs_community__2019.exe进行安装，不要使用离线版的vs2019安装包，否则会出现错误：系统错误：&H8007007E(-2147024770)。 找不到指定的模块。

---

参考

构建系统

---

有关本指南的任何问题， 请阅读 常见问题解答 页面或在 Carla 论坛 中发帖。

现在您已经构建了 Carla，接下来了解如何更新 Carla 构建或在模拟中迈出第一步，并学习一些核心概念。