Skip to main content

Python tool to read, write, and visualize CommonRoad scenarios and solutions.

Project description


Numerical experiments for motion planning of road vehicles require numerous ingredients: vehicle dynamics, a road network, static obstacles,dynamic obstacles and their movement over time, goal regions, a cost function, etc. Providing a description of the numerical experiment precise enough to reproduce it might require several pages of information. Thus, only key aspects are typically described in scientific publications, making it impossible to reproduce results - yet, reproducibility is an important asset of good science.

Composable benchmarks for motion planning on roads (CommonRoad) are proposed so that numerical experiments are fully defined by a unique ID; all required information to reconstruct the experiment can be found on . Each benchmark is composed by a vehicle model , a cost function , and a scenario (including goals and constraints). The scenarios are partly recorded from real traffic and partly hand-crafted to create dangerous situations. Solutions to the benchmarks can be uploaded and ranked on the CommonRoad Website.


The CommonRoad_io package provides methods to read, write, and visualize CommonRoad scenarios and planning problems. Furthermore, it can be used as a framework for implementing motion planning algorithms to solve CommonRoad Benchmarks and is the basis for other tool of the CommonRoad Framework. With CommonRoad_io, those solutions can be written to xml-files for uploading them on

The software is written in Python 3.6 and tested on MacOs and Linux. The usage of the Anaconda Python distribution is strongly recommended.


The full documentation of the API and introducing examples can be found under documentation.

For getting started, we recommend our tutorials.

Additional Tools

Based on CommonRoad_io, we have developed a list of tools for implementing motion-planning algorithms:


The required dependencies for running CommonRoad_io are:

  • numpy>=1.13
  • shapely>=1.6.4
  • matplotlib>=2.2.2
  • networkx>=2.2


CommonRoad_io can be installed with:

pip install commonroad-io

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for commonroad-io, version 2019.2
Filename, size & hash File type Python version Upload date
commonroad_io-2019.2-py3-none-any.whl (93.8 kB) View hashes Wheel py3
commonroad-io-2019.2.tar.gz (68.1 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page