Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup and harmonize Carla build #7919

Open
wants to merge 43 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
5be0e2f
Fix OSM2ODR build
Blyron May 6, 2024
649e2aa
Merge branch 'dev' of https://github.com/carla-simulator/carla into dev
Blyron May 13, 2024
d854ab5
Merge branch 'dev' of https://github.com/carla-simulator/carla into dev
Blyron May 14, 2024
2a50799
Merge branch 'dev' of https://github.com/carla-simulator/carla into dev
Blyron May 15, 2024
b86b199
Merge branch 'dev' of https://github.com/carla-simulator/carla into dev
Blyron May 21, 2024
5043ad7
Merge branch 'dev' of https://github.com/carla-simulator/carla into dev
Blyron May 28, 2024
1796390
Merge branch 'dev' of https://github.com/carla-simulator/carla into dev
Blyron May 30, 2024
7c47e7d
Merge branch 'dev' of https://github.com/carla-simulator/carla into dev
Blyron Jul 8, 2024
634e418
Cleanup and harmonize Carla build
berndgassmann Jul 7, 2024
edcbae1
removed debug logs
berndgassmann Jul 8, 2024
fa5b123
Merge remote-tracking branch 'carla/dev' into berndgassmann/rework_ro…
berndgassmann Jul 8, 2024
c83c045
Merge branch 'dev' of https://github.com/carla-simulator/carla into dev
Blyron Jul 10, 2024
b013f17
updated readme with advisories
MattRoweEAIF Jul 10, 2024
83068cb
Merge branch 'dev' into berndgassmann/rework_ros2_step_1_harmonize_build
berndgassmann Aug 27, 2024
43441c7
Dev (#8185)
Blyron Sep 25, 2024
21f3e40
Update pull_request_template.md (#8187)
Blyron Sep 25, 2024
d6f23ed
Update Jenkinsfile (#8188)
Blyron Sep 27, 2024
0ce3559
update ue4 docs (#8253)
MattRoweEAIF Oct 7, 2024
1c55966
Updated install_gtest.bat
Setnr Oct 8, 2024
6df1c1e
added Unreal Engine lhcs diagram (#8280)
MattRoweEAIF Oct 15, 2024
f91eab2
Docs/lh coord system diagram (#8281)
MattRoweEAIF Oct 15, 2024
715c217
Docs/lh coord system diagram (#8282)
MattRoweEAIF Oct 15, 2024
9a59963
Typing and modernisation of Agent code (#8072)
Daraan Oct 18, 2024
b60034b
Include invertedai script (#8322)
PabloVD Oct 28, 2024
e8947a4
Instance segmentation (#8334)
AreopagX Nov 5, 2024
e41ffa0
Fix waypoints next and previous when connecting two lines with opposi…
matejm42 Nov 7, 2024
bed15c4
Update UE5 build setup script name (#8377)
MattRoweEAIF Nov 15, 2024
bc3b18d
Update build_linux_ue5.md to 5.5
MattRoweEAIF Nov 19, 2024
21dfe70
Update build_windows_ue5.md
MattRoweEAIF Nov 19, 2024
e9b2d16
Update build_carla.md from UE 5.3 to UE 5.5
MattRoweEAIF Nov 19, 2024
30ce294
Update stale bot configuration (#8388)
Blyron Nov 21, 2024
c568719
Remove py dependency. (#8379)
donghaiwang Nov 22, 2024
3935f73
removed UE5 build docs (#8417)
MattRoweEAIF Nov 27, 2024
6ffe564
Update typo in example code in core_actors.md (#8424)
karimkohel Nov 29, 2024
baabfae
Introducing CARLA Simulator Guru on Gurubase.io (#8398)
kursataktas Nov 29, 2024
238f84a
Remove RSS documentation from UE4 CARLA (#8418)
MattRoweEAIF Dec 2, 2024
a1399c6
Fix mistake in bounding box documentation. (#8457)
dominikmaeckel Dec 10, 2024
0bbe650
Change order of spawn points getter
PabloVD Dec 10, 2024
92856c8
Fix typo
nongfugengxia Dec 13, 2024
64bec80
Fix typo (#8478)
donghaiwang Dec 17, 2024
685281a
added note about UE5 documentation (#8498)
MattRoweEAIF Dec 19, 2024
8f7e40f
Fix zOffset typo.
MarcelPiNacy-CVC Jan 3, 2025
66924ac
Merge remote-tracking branch 'origin/ue4-dev' into berndgassmann/rewo…
berndgassmann Jan 9, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@

Thanks for sending a pull request! Please make sure you click the link above to
view the contribution guidelines, then fill out the blanks below.
Please, make sure if your contribution is for UE4 version of CARLA you merge against ue4-dev branch.
if it is for UE5 version of CARLA you merge agaisnt ue5-dev branch

Checklist:

- [ ] Your branch is up-to-date with the `dev` branch and tested with latest changes
- [ ] Your branch is up-to-date with the `ue4-dev/ue5-dev` branch and tested with latest changes
- [ ] Extended the README / documentation, if necessary
- [ ] Code compiles correctly
- [ ] All tests passing with `make check` (only Linux)
- [ ] All tests passing with `make check` (only Linux and ue4-dev)
- [ ] If relevant, update CHANGELOG.md with your changes

-->
Expand Down
3 changes: 2 additions & 1 deletion .github/stale.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Number of days of inactivity before an issue becomes stale
daysUntilStale: 60
# Number of days of inactivity before a stale issue is closed
daysUntilClose: 7
daysUntilClose: 700000
# Issues with these labels will never be considered stale
exemptLabels:
- backlog
- TeamTask
# Label to use when marking an issue as stale
staleLabel: stale
# Comment to post when marking an issue as stale. Set to `false` to disable
Expand Down
11 changes: 8 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
## Latest Changes
* Fixed waypoint.next and .previous causing loops when two opposite-direction lanes follow each other in the map.
* Fixed a bug that caused navigation information not to be loaded when switching maps
* Prevent from segfault on failing SignalReference identification when loading OpenDrive files
* Added vehicle doors to the recorder
* Added functions to get actor' components transform
Expand All @@ -12,13 +14,16 @@
* Fixed bug in python agents when vehicle list was empty causing a check on all vehicles (BasicAgent.py) and detected pedestrians as vehicles if no pedestrains are present (BehaviourAgent.py)
* Extended debug drawing functions to allow drawing primitives on HUD layer
* Added possibility to change gravity variable in imui sensor for the accelerometer
* Fixed ROS2 native extension build error when ROS2 is installed in the system.
* ROS2Native: Force fast-dds dependencies download to avoid build crash when boost_asio and tinyxml2 are not installed in Linux.
* Added API function `get_telemetry_data` to the vehicle actor.
* PythonAPI `Sensor.is_listening` was defined twice (property and method), cleaned and clarified it as a method.
* Added V2X sensors for cooperative awareness message and custom user-defined messages to support vehicle-to-vehicle communication
* Added named tuples for BasicAgent.py's detection result to allow for type-hints and better semantics.

* Cleaned up the client/server build and respective naming
* Added type-hint support for the PythonAPI
* Added type-hints to GlobalRoutePlanner and use carla.Vector3D code instead of pre 0.9.13 numpy code.
* If available, use ActorIDs instead of Unreal Engine IDs for instance segmentation
* Synchronized actor BoundingBox between server and client
* Add actor_id to bounding boxes

## CARLA 0.9.15

Expand Down
5 changes: 0 additions & 5 deletions Docs/3rd_party_integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ CARLA has been developed to integrate with several 3rd party applications in ord
- [__Chrono__](tuto_G_chrono.md)
- [__ASAM OpenDRIVE__](adv_opendrive.md)
- [__PTV Vissim__](adv_ptv.md)
- [__RSS__](adv_rss.md)
- [__AWS and RLlib__](tuto_G_rllib_integration.md)

---
Expand Down Expand Up @@ -63,10 +62,6 @@ Learn how to use CARLA alongside CarSIM [here](tuto_G_carsim_integration.md).

[__ASAM OpenDRIVE__](https://www.asam.net/standards/detail/opendrive/) is an open format specification used to describe the logic of a road network intended to standardise the discription of road networks in digital format and allow different applications to exchange data on road networks. Please refer to the full documentation [__here__](adv_opendrive.md)

## RSS - Responsibility Sensitive Safety

CARLA integrates the [C++ Library for Responsibility Sensitive Safety](https://github.com/intel/ad-rss-lib) in the client library. This feature allows users to investigate behaviours of RSS without having to implement anything. CARLA will take care of providing the input, and applying the output to the AD systems on the fly. Refer to the full documentation [__here__](adv_rss.md)

## AWS and RLlib integration

The RLlib integration brings support between the Ray/RLlib library and CARLA, allowing the easy use of the CARLA environment for training and inference purposes. Ray is an open source framework that provides a simple, universal API for building distributed applications. Ray is packaged with RLlib, a scalable reinforcement learning library, and Tune, a scalable hyperparameter tuning library. Read more about operating CARLA on AWS and RLlib [__here__](tuto_G_rllib_integration.md).
Expand Down
2 changes: 1 addition & 1 deletion Docs/adv_benchmarking.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ python3 performance_benchmark.py --show_scenarios

>> * Show what scenarios will run when configurations are applied without actually executing them:
```shell
python3 performance_benchmark.py --sensors 2 5 --maps Town03 Town05 --weather 0 1 --show_scenarios`
python3 performance_benchmark.py --sensors 2 5 --maps Town03 Town05 --weather 0 1 --show_scenarios
```

>> * Execute the performance benchmark for those scenarios:
Expand Down
2 changes: 0 additions & 2 deletions Docs/adv_cpp_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,5 +138,3 @@ TOOLCHAIN=$(CURDIR)/ToolChain.cmake





3 changes: 2 additions & 1 deletion Docs/adv_digital_twin.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@

The __Digital Twin Tool__ enables procedural generation of unique 3D environments based on road networks derived from the [OpenStreetMap](https://www.openstreetmap.org) (OSM) service. Through the Digital Twin Tool interface in CARLA's Unreal Engine editor a user can select a region of map from OSM and download the road network as the basis for a new CARLA map. The tool then fills the spaces between the roads with procedurally generated 3D buildings that adjust to the layout of the road, creating a realistic 3D road environment with high variability.

<iframe width="100%" height="400px" src="https://www.youtube.com/embed/gTutXdS2UkQ?si=hssM3YRCAjSIzdXM" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

## Building the OSM renderer

If you are using Linux, you have the option of using the OSM renderer in the CARLA interface to navigate a large OSM map region that you have downloaded. You first need to build the OSM renderer before proceeding to build CARLA. Run `make osmrenderer` inside the CARLA root directory. You may need to upgrade your version of CMake to v3.2 or above in order for this to work. This will create two folders in your build directory called `libosmcout-source` and `libosmcout-build`. Before proceeding to build CARLA, you need to then edit the `Build.sh` file in the directory `$CARLA_ROOT/Build/libosmcout-source/maps` like so, to ensure the executable is found:
Expand Down Expand Up @@ -103,4 +105,3 @@ The generation step will take around 10 minutes for a 2x2 km<sup>2</sup> region,
## Save the map

If you are satisfied with the generated map then you can press *Save Map* button to save the map. __This step will take a significant amount of time__, it may take over an hour and could take several. You should prepare to leave your computer running for several hours while this step is completed. Once this step is completed, the map will be available through the Unreal Engine editor or through the CARLA API, the same as any other map.

130 changes: 0 additions & 130 deletions Docs/adv_rss.md

This file was deleted.

3 changes: 0 additions & 3 deletions Docs/bp_library.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,9 +255,6 @@ Check out the [introduction to blueprints](core_actors.md).
- `role_name` (_String_) <sub>_- Modifiable_</sub>
- `sensor_tick` (_Float_) <sub>_- Modifiable_</sub>
- `vertical_fov` (_Float_) <sub>_- Modifiable_</sub>
- **<font color="#498efc">sensor.other.rss</font>**
- **Attributes:**
- `role_name` (_String_) <sub>_- Modifiable_</sub>

### static
- **<font color="#498efc">static.prop.advertisement</font>**
Expand Down
7 changes: 3 additions & 4 deletions Docs/build_carla.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ Build instructions are available for Linux and Windows. You can also build CARLA
* [__Updating CARLA__](build_update.md)
* [__Build system__](build_system.md)

* [__Linux build with Unreal Engine 5.3__](build_linux_ue5.md)
* [__Windows build with Unreal Engine 5.3__](build_windows_ue5.md)

* [__FAQ__](build_faq.md)
* [__FAQ__](build_faq.md)

!!! note
These build instructions are for the **Unreal Engine 4.26 version of CARLA**, if you are looking for build instructions for the Unreal Engine 5.5 version of CARLA, please visit [the correct build instructions for that version](https://carla-ue5.readthedocs.io/en/latest/build_carla/).
38 changes: 11 additions & 27 deletions Docs/build_linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ CARLA requires many different kinds of software to run. Some are built during th
sudo apt-get update &&
sudo apt-get install wget software-properties-common &&
sudo add-apt-repository ppa:ubuntu-toolchain-r/test &&
wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key|sudo apt-key add
sudo apt-get update
```

!!! Warning
Expand All @@ -50,53 +50,37 @@ To avoid compatibility issues between Unreal Engine and the CARLA dependencies,

__Ubuntu 22.04__.
```sh
sudo apt-add-repository "deb http://archive.ubuntu.com/ubuntu focal main universe"
sudo apt-get update
sudo apt-get install build-essential clang-10 lld-10 g++-7 cmake ninja-build libvulkan1 python python3 python3-dev python3-pip libpng-dev libtiff5-dev libjpeg-dev tzdata sed curl unzip autoconf libtool rsync libxml2-dev git git-lfs
sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/lib/llvm-10/bin/clang++ 180 &&
sudo update-alternatives --install /usr/bin/clang clang /usr/lib/llvm-10/bin/clang 180 &&
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-7 180
sudo apt-get install build-essential g++-13 cmake ninja-build libvulkan1 python3 python3-dev python3-pip libpng-dev libtiff5-dev libjpeg-dev tzdata sed curl unzip autoconf libtool rsync libxml2-dev git git-lfs
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-13 180
```

__Ubuntu 20.04__.
```sh
sudo apt-add-repository "deb http://apt.llvm.org/focal/ llvm-toolchain-focal main"
sudo apt-get update
sudo apt-get install build-essential clang-10 lld-10 g++-7 cmake ninja-build libvulkan1 python python-dev python3-dev python3-pip libpng-dev libtiff5-dev libjpeg-dev tzdata sed curl unzip autoconf libtool rsync libxml2-dev git
sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/lib/llvm-10/bin/clang++ 180 &&
sudo update-alternatives --install /usr/bin/clang clang /usr/lib/llvm-10/bin/clang 180
sudo apt-get install build-essential g++-13 cmake ninja-build libvulkan1 python python-dev python3-dev python3-pip libpng-dev libtiff5-dev libjpeg-dev tzdata sed curl unzip autoconf libtool rsync libxml2-dev git
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-13 180
```

__Ubuntu 18.04__.

```sh
sudo apt-add-repository "deb http://apt.llvm.org/bionic/ llvm-toolchain-bionic main"
sudo apt-get update
sudo apt-get install build-essential clang-8 lld-8 g++-7 cmake ninja-build libvulkan1 python python-pip python-dev python3-dev python3-pip libpng-dev libtiff5-dev libjpeg-dev tzdata sed curl unzip autoconf libtool rsync libxml2-dev git
sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/lib/llvm-8/bin/clang++ 180 &&
sudo update-alternatives --install /usr/bin/clang clang /usr/lib/llvm-8/bin/clang 180
sudo apt-get install build-essential g++-13 cmake ninja-build libvulkan1 python python-pip python-dev python3-dev python3-pip libpng-dev libtiff5-dev libjpeg-dev tzdata sed curl unzip autoconf libtool rsync libxml2-dev git
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-13 180
```

__Ubuntu 16.04__.

```sh
sudo apt-add-repository "deb http://apt.llvm.org/xenial/ llvm-toolchain-xenial-8 main" &&
sudo apt-get update
sudo apt-get install build-essential clang-8 lld-8 g++-7 cmake ninja-build libvulkan1 python python-pip python-dev python3-dev python3-pip libpng16-dev libtiff5-dev libjpeg-dev tzdata sed curl unzip autoconf libtool rsync libxml2-dev git
sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/lib/llvm-8/bin/clang++ 180 &&
sudo update-alternatives --install /usr/bin/clang clang /usr/lib/llvm-8/bin/clang 180
sudo apt-get install build-essential g++-13 cmake ninja-build libvulkan1 python python-pip python-dev python3-dev python3-pip libpng16-dev libtiff5-dev libjpeg-dev tzdata sed curl unzip autoconf libtool rsync libxml2-dev git
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-13 180
```

__Previous Ubuntu versions__.

We strongly advise using Ubuntu 18.04 or later to build CARLA. However, you may attempt to build CARLA on older versions of Ubuntu with the following commands:

```sh
sudo apt-add-repository "deb http://apt.llvm.org/<code_name>/ llvm-toolchain-<code_name>-8 main" &&
sudo apt-get update
sudo apt-get install build-essential clang-8 lld-8 g++-7 cmake ninja-build libvulkan1 python python-pip python-dev python3-dev python3-pip libpng16-dev libtiff5-dev libjpeg-dev tzdata sed curl unzip autoconf libtool rsync libxml2-dev git
sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/lib/llvm-8/bin/clang++ 180 &&
sudo update-alternatives --install /usr/bin/clang clang /usr/lib/llvm-8/bin/clang 180
sudo apt-get install build-essential g++-13 cmake ninja-build libvulkan1 python python-pip python-dev python3-dev python3-pip libpng16-dev libtiff5-dev libjpeg-dev tzdata sed curl unzip autoconf libtool rsync libxml2-dev git
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-13 180
```

__All Ubuntu systems__.
Expand Down
Loading