commonroad-drivability-checker 2025.3.0

CommonRoad Drivability Checker

:warning: Deprecation Notice

:warning: Starting from version 2025.1 the curvilinear coordinate system has been moved to a standalone package (commonroad-clcs).

To continue using it and the commonroad_dc.geometry submodule either install the standalone package (pip install commonroad-clcs) and update your imports OR use commonroad-drivability-checker == 2024.1.

Collision avoidance, kinematic feasibility, and road-compliance must be validated to ensure the drivability of planned motions for autonomous vehicles. The CommonRoad Drivability Checker toolbox unifies these checks in order to simplify the development and validation of motion planning algorithms. It is compatible with the CommonRoad benchmark suite, which additionally facilitates and drastically reduces the effort of the development of motion planning algorithms.

Please post questions, bug reports, etc. related to our tools or website in our forum.

Installation

We provide two installation options: Installation as a Python package or building from source.

1. Python Package: Install the python package via pip in your Conda environment:

   pip install commonroad-drivability-checker
   

   Note for MacOS M1 users: You need to use the 64-bit Anaconda Installer (graphical or command-line) in order to install the MacOS PyPi package.

2. Build from source: To build the drivability checker from source, please refer to the installation description in the documentation.

System Requirements

The software is written in Python 3.10 and C++17 and tested on MacOS and Linux (Ubuntu 18.04, 20.04 and 22.04).

The usage of the Anaconda Python distribution is strongly recommended.

For building the code from source, the following minimum versions are required:

• GCC and G++: version 10 or above
• CMake: version 3.20 or above.
• Pip: version 21.3 or above

Note for MacOS users (M1 or Intel):

• We additionally recommend using the Homebrew package manager, to install required dependencies such as Eigen.
• The installation has been tested for the AppleClang (15.0) and the GCC (13) compiler.

Third Party Libraries and Packages

The following third-party dependencies of the C++ code are only required for building the project from source!

Essential dependencies:

Manual installation required:

• OpenMP

Automatic installation via CMake FetchContent:

• Eigen3
• Boost
• Box2D
• FCL
• libccd
• gpc

Source code included:

• libs11n

Optional dependencies:

• pybind11 (optional for building Python bindings directly without using pip)
• Triangle (optional library for triangulation, not built by default)
• CGAL (optional library for triangulation, not built by default)
• Pandoc (optional for building documentation)
• Doxygen (optional for building documentation)

Note: Please be aware of the specific licensing conditions when including the optional dependencies Triangle and CGAL. See also notes.txt and the licensing information on the respective package websites for more details.

The Python dependencies are listed in pyproject.toml.

Documentation

A full documentation as well as tutorials to get started with the tool can be found on our toolpage.

Publication

CommonRoad Drivability Checker: Simplifying the Development and Validation of Motion Planning Algorithms

Christian Pek, Vitaliy Rusinov, Stefanie Manzinger, Murat Can Üste, and Matthias Althoff

Abstract— Collision avoidance, kinematic feasibility, and road-compliance must be validated to ensure the drivability of planned motions for autonomous vehicles. Although these tasks are highly repetitive, computationally efficient toolboxes are still unavailable. The CommonRoad Drivability Checker—an open-source toolbox—unifies these mentioned checks. It is compatible with the CommonRoad benchmark suite, which additionally facilitates the development of motion planners. Our toolbox drastically reduces the effort of developing and validating motion planning algorithms. Numerical experiments show that our toolbox is real-time capable and can be used in real test vehicles.

Fulltext is available on mediaTUM.

Bibtex:

@inproceedings{ PekIV20.pdf,
	author = "Christian Pek, Vitaliy Rusinov, Stefanie Manzinger, Murat Can Üste, and Matthias Althoff",
	title = "CommonRoad Drivability Checker: Simplifying the Development and Validation of Motion Planning Algorithms",
	pages = "1-8",
	booktitle = "Proc. of the IEEE Intelligent Vehicles Symposium",
	year = "2020",
	abstract = "Collision avoidance, kinematic feasibility, and road-compliance must be validated to ensure the drivability of planned motions for autonomous vehicles. Although these tasks are highly repetitive, computationally efficient toolboxes are still unavailable. The CommonRoad Drivability Checker— an open-source toolbox—unifies these mentioned checks. It is compatible with the CommonRoad benchmark suite, which additionally facilitates the development of motion planners. Our toolbox drastically reduces the effort of developing and validating motion planning algorithms. Numerical experiments show that our toolbox is real-time capable and can be used in real test vehicles."
}