# CommonROAD-OpenSCENARIO Converter
Automatic Traffic Scenario Conversion between [OpenSCENARIO](https://www.asam.net/standards/detail/openscenario/)
and [CommonRoad](commonroad.in.tum.de/). Currently, only the conversion from **O**pen**SC**ENARIO to **C**ommon**R**OAD (osc2cr) is developed.<br>
[](https://pypi.python.org/pypi/commonroad-openscenario-converter/)
[](https://pypi.python.org/pypi/commonroad-openscenario-converter/)
[](https://pypi.python.org/pypi/commonroad-openscenario-converter/)
[](https://pypi.python.org/pypi/commonroad-openscenario-converter/)<br>
[](https://pypi.python.org/pypi/commonroad-openscenario-converter/)
[](https://pypi.python.org/pypi/commonroad-openscenario-converter/)<br>
### 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:
```bash
pip install commonroad-openscenario-converter
```
### Development
For developing purposes, we recommend using [Anaconda](https://www.anaconda.com/) 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](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html).
- First, clone the repository.
- After installing Anaconda, create a new environment with (>=3.9) and enter it:
``` bash
$ conda create -n commonroad-py39 python=3.9 -y
$ conda activate commonroad-py39
or
$ source activate commonroad-py39
```
- Then, install the dependencies with:
```sh
$ cd <path-to-this-repo>
$ pip install .
$ conda develop .
```
- To test the installition, run unittest:
```bash
$ cd tests
$ python -m unittest -v
```
### Open Simulation Interface (OSI) and UDP Driver
If you want to use the [esmini](https://github.com/esmini/esmini) UDPDriverController in combination with OSI for including
external driver models or vehicle simulators, you need to install OSI manually,
see [here](https://github.com/OpenSimulationInterface/open-simulation-interface).
### 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-openscenario-converter/.
In order to generate the documentation via Sphinx locally, run the following commands in the root directory:
```bash
$ 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](https://github.com/esmini/esmini) for
their remarkable effort in developing the simulation tool. Specifically, we would like to express our sincere
appreciation to [Emil Knabe](https://www.linkedin.com/in/emil-knabe-216a1a11/?originalSubdomain=se)
for his invaluable contribution in reviewing and accepting the proposed changes to the esmini interface,
and to [Sebastian Maierhofer](https://www.ce.cit.tum.de/air/people/sebastian-maierhofer-msc/)
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](https://www.ce.cit.tum.de/air/research/kosi/)).
### Citation
If you use `commonroad-openscenario-converter` for academic work, we highly encourage you to cite our [paper](https://mediatum.ub.tum.de/doc/1716501/1716501.pdf):
```text
@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](mailto:yuanfei.lin@tum.de) directly.
Raw data
{
"_id": null,
"home_page": "https://commonroad.in.tum.de/tools/openscenario-converter",
"name": "commonroad-openscenario-converter",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "scenario description,autonomous driving",
"author": "Yuanfei Lin, Michael Ratzel, Matthias Althoff",
"author_email": "yuanfei.lin@tum.de",
"download_url": "https://files.pythonhosted.org/packages/2c/7f/5fe58de4143e5c5b315a6a6b99d02ea13a6f16e227b4ef53241cfc6a8233/commonroad-openscenario-converter-0.1.0.tar.gz",
"platform": null,
"description": "# CommonROAD-OpenSCENARIO Converter\n\n\nAutomatic Traffic Scenario Conversion between [OpenSCENARIO](https://www.asam.net/standards/detail/openscenario/)\nand [CommonRoad](commonroad.in.tum.de/). Currently, only the conversion from **O**pen**SC**ENARIO to **C**ommon**R**OAD (osc2cr) is developed.<br>\n[](https://pypi.python.org/pypi/commonroad-openscenario-converter/)\n[](https://pypi.python.org/pypi/commonroad-openscenario-converter/)\n[](https://pypi.python.org/pypi/commonroad-openscenario-converter/)\n[](https://pypi.python.org/pypi/commonroad-openscenario-converter/)<br>\n[](https://pypi.python.org/pypi/commonroad-openscenario-converter/) \n[](https://pypi.python.org/pypi/commonroad-openscenario-converter/)<br>\n\n### Using the Converter\nThe recommended way of installation if you only want to use the OpenSCENARIO-CommonROAD Converter\n(i.e., you do not want to work with the code directly) is to use the PyPI package:\n```bash\npip install commonroad-openscenario-converter\n```\n### Development\nFor developing purposes, we recommend using [Anaconda](https://www.anaconda.com/) to manage your environment so that\neven if you mess something up, you can always have a safe and clean restart. \nA guide for managing python environments with Anaconda can be found [here](https://conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html).\n\n- First, clone the repository. \n- After installing Anaconda, create a new environment with (>=3.9) and enter it:\n``` bash\n$ conda create -n commonroad-py39 python=3.9 -y\n$ conda activate commonroad-py39\nor\n$ source activate commonroad-py39\n```\n- Then, install the dependencies with:\n\n```sh\n$ cd <path-to-this-repo>\n$ pip install .\n$ conda develop .\n```\n\n- To test the installition, run unittest:\n```bash\n$ cd tests\n$ python -m unittest -v\n```\n\n### Open Simulation Interface (OSI) and UDP Driver\nIf you want to use the [esmini](https://github.com/esmini/esmini) UDPDriverController in combination with OSI for including\nexternal driver models or vehicle simulators, you need to install OSI manually, \nsee [here](https://github.com/OpenSimulationInterface/open-simulation-interface).\n\n### Contributors (in alphabetical order by last name)\n- Yuanfei Lin\n- Michael Ratzel\n\n### Documentation\n\nThe documentation of our toolbox is available on our website: https://cps.pages.gitlab.lrz.de/commonroad-openscenario-converter/.\n\nIn order to generate the documentation via Sphinx locally, run the following commands in the root directory:\n\n```bash\n$ pip install -r ./docs/requirements_doc.txt\n$ cd docs/sphinx\n$ make html\n```\nThe documentation can then be launched by browsing ``./docs/sphinx/build/html/index.html/``.\n### Acknowledgments\nWe would like to extend our heartfelt gratitude to the team behind [esmini](https://github.com/esmini/esmini) for \ntheir remarkable effort in developing the simulation tool. Specifically, we would like to express our sincere \nappreciation to [Emil Knabe](https://www.linkedin.com/in/emil-knabe-216a1a11/?originalSubdomain=se)\nfor his invaluable contribution in reviewing and accepting the proposed changes to the esmini interface, \nand to [Sebastian Maierhofer](https://www.ce.cit.tum.de/air/people/sebastian-maierhofer-msc/)\nfor maintaining the converter from OpenDRIVE to lanelets.\nWe gratefully acknowledge partial financial support by the German Federal Ministry for Digital and Transport (BMDV) \nwithin the project _Cooperative Autonomous Driving with Safety Guarantees_\n([KoSi](https://www.ce.cit.tum.de/air/research/kosi/)).\n\n### Citation\nIf you use `commonroad-openscenario-converter` for academic work, we highly encourage you to cite our [paper](https://mediatum.ub.tum.de/doc/1716501/1716501.pdf):\n```text\n@inproceedings{Lin2023Osc2Cr,\n\tauthor = {Yuanfei Lin, Michael Ratzel, and Matthias Althoff},\n\ttitle = {Automatic Traffic Scenario Conversion from {OpenSCENARIO} to {CommonRoad}},\n\tbooktitle = {Proc. of the IEEE Int. Conf. on Intell. Transp. Syst.},\n\tyear = {2023},\n\tpages= {},\n}\n```\nIf you use this project's code in industry, we'd love to hear from you as well; \nfeel free to reach out to [Yuanfei Lin](mailto:yuanfei.lin@tum.de) directly.\n\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "Converter between OpenSCENARIO and CommonRoad formats",
"version": "0.1.0",
"project_urls": {
"Documentation": "https://cps.pages.gitlab.lrz.de/commonroad-openscenario-converter/",
"Forum": "https://commonroad.in.tum.de/forum/c/dataset-converter/",
"Homepage": "https://commonroad.in.tum.de/tools/openscenario-converter",
"Source": "https://gitlab.lrz.de/tum-cps/commonroad-openscenario-converter"
},
"split_keywords": [
"scenario description",
"autonomous driving"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "972e05009891e613997a27914271a998adedf52f691b498c55c85f519e5dfcf3",
"md5": "25fbe8b1396b22c1370db424ac8f73a9",
"sha256": "a64c6e4aab97365079eebf541564c7764f1c05776f53680c09ad6b5768cc76ae"
},
"downloads": -1,
"filename": "commonroad_openscenario_converter-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "25fbe8b1396b22c1370db424ac8f73a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 52075,
"upload_time": "2023-07-25T11:27:38",
"upload_time_iso_8601": "2023-07-25T11:27:38.797388Z",
"url": "https://files.pythonhosted.org/packages/97/2e/05009891e613997a27914271a998adedf52f691b498c55c85f519e5dfcf3/commonroad_openscenario_converter-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2c7f5fe58de4143e5c5b315a6a6b99d02ea13a6f16e227b4ef53241cfc6a8233",
"md5": "eca7434d9747500df59260b94e3f1daf",
"sha256": "6afe71cec92f88c57926817a1cab4550a4e457159b0b5146009e73b1f30d9e68"
},
"downloads": -1,
"filename": "commonroad-openscenario-converter-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "eca7434d9747500df59260b94e3f1daf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 37263,
"upload_time": "2023-07-25T11:27:40",
"upload_time_iso_8601": "2023-07-25T11:27:40.481270Z",
"url": "https://files.pythonhosted.org/packages/2c/7f/5fe58de4143e5c5b315a6a6b99d02ea13a6f16e227b4ef53241cfc6a8233/commonroad-openscenario-converter-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-25 11:27:40",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "commonroad-openscenario-converter"
}
JSON