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 生成可执行文件。
• 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. 在Git终端中，导航到要保存虚幻引擎的位置并克隆 carla 分支：

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

或者打开 UnrealEngine 进行项目文件下载：

2. 运行配置脚本：

Setup.bat
GenerateProjectFiles.bat

3. 编译修改后的引擎：

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

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

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

以下是编译过程中可能遇到的错误：

在默认情况下，Unreal Engine 使用 CPU 的所有核心进行编译。这可能导致内存不足的问题，尤其是在高性能电脑但内存有限的情况下。为避免此问题，可以通过以下两种方式解决：减少 CPU 核心使用数量。增加虚拟内存。以下是通过修改 CPU 核心数来优化编译的详细解决方案：

（1）您需要修改 BuildConfiguration.xml 文件中的设置。文件路径如下： ~/UnrealEngine\Engine\Saved\UnrealBuildTool\BuildConfiguration.xml

（2）打开 BuildConfiguration.xml 文件，并添加或修改以下内容（使用7核进行编译）：

<?xml version="1.0" encoding="utf-8" ?>
<Configuration xmlns="https://www.unrealengine.com/BuildConfiguration">
  <BuildConfiguration>
    <ProcessorCountMultiplier>7</ProcessorCountMultiplier>
    <MaxParallelActions>7</MaxParallelActions>
    <bAllowParallelExecutor>true</bAllowParallelExecutor>
  </BuildConfiguration>
  <SNDBS>
    <ProcessorCountMultiplier>4</ProcessorCountMultiplier>
    <MaxProcessorCount>4</MaxProcessorCount>
  </SNDBS>
  <ParallelExecutor>
    <ProcessorCountMultiplier>7</ProcessorCountMultiplier>
    <MaxProcessorCount>7</MaxProcessorCount>
    <bStopCompilationAfterErrors>true</bStopCompilationAfterErrors>
  </ParallelExecutor>
</Configuration>

（3）清理配置文件。完成编译后，在执行 make launch 之前，务必删除 BuildConfiguration.xml 文件中新增的内容。否则，可能导致程序运行时出现卡顿或性能下降的问题。

4. 设置虚幻引擎变量

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

设置环境变量：

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

5. 编译解决方案后，您可以打开引擎，通过启动可执行文件 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 版本的资产链接（将当中的 PUT_FILE_ID_HERE 替换为对应版本ID）。 如这里要下载 0.9.15 版本，即把 PUT_FILE_ID_HERE 替换为对应版本 ID：20231108 c5101a5
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 的命令。

• 命令应通过 VS 2019 的 x64 Native Tools Command Prompt for VS 2019 执行。通过单击该Windows键并搜索 来打开它x64，或者运行call "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat"。
• 所有命令都应在根 Carla 文件夹中运行。

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 --force-reinstall <path/to/wheel>.whl

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

2. 编译服务端:

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

make launch

• 问题一：
• make PythonAPI 或者 make launch 的时候会遇到 cmakelist.txt 的错误，说没有这个文件，这可能是编译的时候由于网速问题，导致一些本该下载的东西直接跳过了，比如这个 txt，解决方法就是重新编译，最好是重新下载 CARLA 这个文件，然后重新编译，网速好的情况下应该就不会出现这个问题。
• 问题二：fatal error C1083: 无法打开 包括文件: “CARLA/Version.h”: No such file or directory
• 将 CARLA\LibCARLA\source\CARLA 中的 version.h.in，重命名，去掉.in，接着重新运行 make launch
• 成功会在你的 CARLA\PythonAPI\CARLA 目录下生成一个 dist 文件夹，这个就是你的 CARLA 版本
• 依次执行上面两个命令，过程需要很久。

该项目可能会要求构建其他实例，例如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命令。在下表中找到它们：

构建一个 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目录下的文件，需要删除Build/libcarla-visualstudio目录，然后重新运行编译命令（否则PythonAPI\carla\dependencies目录不会生成，生成.whl文件时遍历的不到依赖库，报错：NotADirectoryError: [WinError 267] 目录名称无效。: 'dependencies/lib'）：

make LibCarla

启动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'

使用Anaconda Powershell Prompt打开，或者：

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

报chrono模块的错：D:/work/workspace/carla/Unreal/CarlaUE4/Plugins/Carla/Source/Carla/Sensor/V2X/PathLossModel.cpp(176): error C3861: “DrawDebugLine”: 找不到标识符、

D:/work/workspace/carla/Unreal/CarlaUE4/Plugins/Carla/Source/Carla/Sensor/V2X/PathLossModel.cpp(542): error C2027: 使用了未定义类型“URandomEngine”
D:/work/workspace/carla/Unreal/CarlaUE4/Plugins/Carla/Source/Carla/Sensor/V2XSensor.cpp(189): error C2653: “UCarlaStatics”: 不是类或命名空间名称
D:/work/workspace/carla/Unreal/CarlaUE4/Plugins/Carla/Source/Carla/Sensor/V2XSensor.cpp(189): error C3861: “GetCurrentEpisode”: 找不到标识符

解决：先使用VS编译后，然后再用命令行启动则可，原因不明。

Unreal/CarlaUE4/Plugins/Carla/Source/Carla/Sensor/V2XSensor.cpp添加头文件

#include "Carla/Game/CarlaStatics.h"

报错：

D:/work/workspace/carla/Unreal/CarlaUE4/Plugins/Carla/Source/Carla/Sensor/V2X/PathLossModel.cpp(176): error C3861: “DrawDebugLine”: 找不到标识符

#include "DrawDebugHelpers.h"

报错：

错误  C2027   使用了未定义类型“URandomEngine” CarlaUE4    D:\work\workspace\carla\Unreal\CarlaUE4\Plugins\Carla\Source\Carla\Sensor\V2X\PathLossModel.cpp 542 

解决：Unreal\CarlaUE4\Plugins\Carla\Source\Carla\Sensor\V2X\PathLossModel.cpp中添加头文件：

#include "Carla/Util/RandomEngine.h"

执行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

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

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

系统

Win11专业版 激活方法 。

报错

• 执行make osm2odr报错：

  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)。 找不到指定的模块。

• 执行make launch时报错D:/work/workspace/carla/Unreal/CarlaUE4/Plugins/Carla/Source/Carla/Server/CarlaServer.cpp(46): fatal error C1083: 无法打开包括文件: “carla/rpc/BoundingBox.h”: No such file or directory

换了vs环境，需要重新删除Build/libcarla-visualstudio，删除之前的 cmake 结果目录并再次运行 make launch(cmake) 后问题就消失了。

• 或者D:\work\workspace\carla\Build\osm2odr-source\src\utils/geom/GeoConvHelper.h(31,10): fatal error C1083: 无法打开包括文件: “proj_api.h”: No such file or directory

目录Build/proj-install没有生成，尝试从其他电脑中拷贝过来。

• 执行make PythonAPI提示成功，但是没生成dist文件夹，前面报错：C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Tools\MSVC\14.29.30133\include\xtree(885) : fatal error C1128: 节数超过对象文件格式限制: 请使用 /bigobj 进行编译

原因：文件PythonAPI/carla/setup.cfg中配置了调试选项。 解决：将debug = 1改为debug = 0。

• 执行make PythonAPI 报错：libboost_filesystem-vc142-mt-gd-x64-1_80.lib(path_traits.obj) : error LNK2038: 检测到“_ITERATOR_DEBUG_LEVEL”的不匹配项: 值“2”不匹配值“0”(libcarla.obj 中)

原因：链接的是libboost库的调式版本。 解决：将PythonAPI\carla\dependencies\lib目录下libboost-*开头的文件中，包含*-gd-*的文件（调试版本）移除，则可编译通过。

• 使用make Python编译 Carla 0.9.13 时报错：osm2odr.lib(GeoConvHelper.obj) : error LNK2001: 无法解析的外部符号 proj_create：

删除位于Build目录下的proj源代码和安装目录，然后运行下面命令（参数改为对应的Build目录）：

install_proj.bat --build-dir D:\work\DReyeVR\carla\Build

• 执行make launch-only报错：The following modules are missing or built with a different version

  右键 .uproject 文件生成vs 工程，然后使用vs打开，构建项目（点击菜单中的生成->生成解决方案）。 注：执行make clean后然后执行make launch-only后会出现这种情况。

参考

持续集成

构建系统

Windows平台下的依赖安装脚本

车载HUD设计与验证平台文档 ：文档 包括：当前驾驶车辆工况、导航路径引导、提示周围环境信息、接管提升和辅助、个性化娱乐功能。。

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

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