Skip to main content

CommonROAD-OpenSCENARIO Converter

image info

Automatic Traffic Scenario Conversion between OpenSCENARIO and CommonRoad. Currently, only the conversion from OpenSCENARIO to CommonROAD (osc2cr) is developed.
Linux PyPI pyversions PyPI license PyPI version fury.io
PyPI download month PyPI download week

Using the Converter

The recommended way of installation if you only want to use the OpenSCENARIO-CommonROAD Converter (i.e., you do not want to work with the code directly) is to use the PyPI package:

pip install commonroad-openscenario-converter

Development

For developing purposes, we recommend using Anaconda to manage your environment so that even if you mess something up, you can always have a safe and clean restart. A guide for managing python environments with Anaconda can be found here.

  • First, clone the repository.
  • After installing Anaconda, create a new environment with (>=3.9) and enter it:
$ conda create -n commonroad-py39 python=3.9 -y
$ conda activate commonroad-py39
or
$ source activate commonroad-py39
  • Then, install the dependencies with:
$ cd <path-to-this-repo>
$ pip install .
$ conda develop .
  • To test the installition, run unittest:
$ cd tests
$ python -m unittest -v

Open Simulation Interface (OSI) and UDP Driver

If you want to use the esmini UDPDriverController in combination with OSI for including external driver models or vehicle simulators, you need to install OSI manually, see here.

Contributors (in alphabetical order by last name)

  • Yuanfei Lin
  • Michael Ratzel

Documentation

The documentation of our toolbox is available on our website: https://cps.pages.gitlab.lrz.de/commonroad/commonroad-openscenario-converter/.

In order to generate the documentation via Sphinx locally, run the following commands in the root directory:

$ pip install -r ./docs/requirements_doc.txt
$ cd docs/sphinx
$ make html

The documentation can then be launched by browsing ./docs/sphinx/build/html/index.html/.

Acknowledgments

We would like to extend our heartfelt gratitude to the team behind esmini for their remarkable effort in developing the simulation tool. Specifically, we would like to express our sincere appreciation to Emil Knabe for his invaluable contribution in reviewing and accepting the proposed changes to the esmini interface, and to Sebastian Maierhofer for maintaining the converter from OpenDRIVE to lanelets. We gratefully acknowledge partial financial support by the German Federal Ministry for Digital and Transport (BMDV) within the project Cooperative Autonomous Driving with Safety Guarantees (KoSi).

Citation

If you use commonroad-openscenario-converter for academic work, we highly encourage you to cite our paper:

@inproceedings{Lin2023Osc2Cr,
	author = {Yuanfei Lin, Michael Ratzel, and Matthias Althoff},
	title = {Automatic Traffic Scenario Conversion from {OpenSCENARIO} to {CommonRoad}},
	booktitle = {Proc. of the IEEE Int. Conf. on Intell. Transp. Syst.},
	year = {2023},
	pages= {},
}

If you use this project's code in industry, we'd love to hear from you as well; feel free to reach out to Yuanfei Lin directly.

Metadata

Release files for commonroad-openscenario-converter 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for commonroad-openscenario-converter 0.1.1
File Size Uploaded Provenance Actions
commonroad_openscenario_converter-0.1.1.tar.gz 37.1 kB Without provenance Details for commonroad_openscenario_converter-0.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for commonroad-openscenario-converter 0.1.1
File Interpreter ABI Platform Actions
commonroad_openscenario_converter-0.1.1-py3-none-any.whl Python 3 none any Details for commonroad_openscenario_converter-0.1.1-py3-none-any.whl

Total release size: 88.9 kB

Release files / commonroad_openscenario_converter-0.1.1.tar.gz

Download URL commonroad_openscenario_converter-0.1.1.tar.gz
Size 37.1 kB
Tags Source
SHA-256 checksum
How to use checksums
161427c7599d34965ac509d1a6030dc80a84b2d76d8e84755152581724c2c2bf
BLAKE2b-256 checksum
How to use checksums
e6787c8b2fad677a6fb449cf344c7e2ce74609c4671e06c1e08069ee459db68d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.8

Release files / commonroad_openscenario_converter-0.1.1-py3-none-any.whl

Download URL commonroad_openscenario_converter-0.1.1-py3-none-any.whl
Size 51.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1d37a4d90ce9799b90f1a9b0cfa28adefcef3b4d16d3046cdb346ea2934ea897
BLAKE2b-256 checksum
How to use checksums
efb4ad58bdaf3bf7a96f804719e4061ce9e09231bf9f07ee070cc2e188d1274b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.12.8

Security for commonroad-openscenario-converter 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page