# CommonRoad Route Planner
The CommonRoad Route Planner aims to give an extendable, light-weight route- and reference path planner for the CommonRoad project
This tool is built for and Ubuntu 22.04 and Python3 ^3.8.
## Documentation
The documentation can be found [here](https://cps.pages.gitlab.lrz.de/commonroad-route-planner/)
## Project status
This tool is still under development but has already been successfully deployed in both simulation and on real-world
autonomous vehicles.
We highly welcome your contribution.
## Installation and Usage
We recommend to use PyCharm (Professional) as IDE.
### Usage in other projects
We provide an PyPI package which can be installed with the following command
```shell
pip install commonroad-route-planner
```
### Development
It is recommended to use [poetry](https://python-poetry.org/) as an environment manager.
Clone the repository and install it with poetry. Currently, only the internal repository can be cloned.
This repo contains a number of scenario xml files in /scenarios. They are stored with git large-file-system (git lfs).
If you want to download these scenario files, before cloning this repo, do the following:
```shell
sudo apt-get install -y git-lfs and git lfs install
git config --global credential.helper store
git clone https://gitlab.lrz.de/cps/commonroad-route-planner.git
conda activate ENVIRONMENT
pip install .
```
### Examples
We recommend to use PyCharm (Professional) as IDE.
Examples can be found on our CommonRoad website
## Documentation
You can generate the documentation within your activated Poetry environment using.
```bash
conda activate ENVIRONMENT
mkdocs build
```
The documentation will be located under site, where you can open `index.html` in your browser to view it.
For updating the documentation you can also use the live preview:
```bash
conda activate ENVIRONMENT
mkdocs serve
```
## Authors
Responsible: Tobias Mascetta, tobias.mascetta[at]tum.de
Raw data
{
"_id": null,
"home_page": "https://commonroad.in.tum.de",
"name": "commonroad-route-planner",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "autonomous, automated, vehicles, driving, motion, planning, prediction",
"author": "Tobias Mascetta",
"author_email": "commonroad@lists.lrz.de",
"download_url": "https://files.pythonhosted.org/packages/5c/82/119e334417ab46b2fb998a7fe107eb5320ba0b16f649e27221f8b8f379cc/commonroad_route_planner-2024.1.1.tar.gz",
"platform": null,
"description": "# CommonRoad Route Planner\nThe CommonRoad Route Planner aims to give an extendable, light-weight route- and reference path planner for the CommonRoad project\nThis tool is built for and Ubuntu 22.04 and Python3 ^3.8.\n\n## Documentation\nThe documentation can be found [here](https://cps.pages.gitlab.lrz.de/commonroad-route-planner/)\n\n\n## Project status\nThis tool is still under development but has already been successfully deployed in both simulation and on real-world \nautonomous vehicles.\n\nWe highly welcome your contribution.\n\n## Installation and Usage\nWe recommend to use PyCharm (Professional) as IDE.\n\n### Usage in other projects\nWe provide an PyPI package which can be installed with the following command\n```shell\npip install commonroad-route-planner\n```\n\n### Development\nIt is recommended to use [poetry](https://python-poetry.org/) as an environment manager.\nClone the repository and install it with poetry. Currently, only the internal repository can be cloned.\nThis repo contains a number of scenario xml files in /scenarios. They are stored with git large-file-system (git lfs).\nIf you want to download these scenario files, before cloning this repo, do the following:\n```shell\nsudo apt-get install -y git-lfs and git lfs install\ngit config --global credential.helper store\ngit clone https://gitlab.lrz.de/cps/commonroad-route-planner.git\nconda activate ENVIRONMENT\npip install .\n```\n\n### Examples\nWe recommend to use PyCharm (Professional) as IDE.\nExamples can be found on our CommonRoad website\n\n\n## Documentation\nYou can generate the documentation within your activated Poetry environment using.\n```bash\nconda activate ENVIRONMENT\nmkdocs build\n```\nThe documentation will be located under site, where you can open `index.html` in your browser to view it.\nFor updating the documentation you can also use the live preview:\n```bash\nconda activate ENVIRONMENT\nmkdocs serve\n```\n\n## Authors\nResponsible: Tobias Mascetta, tobias.mascetta[at]tum.de\n\n\n\n\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Route and reference path planning tool for CommonRoad scenarios",
"version": "2024.1.1",
"project_urls": {
"Homepage": "https://commonroad.in.tum.de"
},
"split_keywords": [
"autonomous",
" automated",
" vehicles",
" driving",
" motion",
" planning",
" prediction"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4e806570bcdaa6db19f55679937e0af1e7a269e2102b050dd3a282a4ebb9aa66",
"md5": "473c3c651d590384287ee291550c82e9",
"sha256": "30a5ea20f4598631e91b3637ee702c27b369682b1c2b4e5653ba2877c663b603"
},
"downloads": -1,
"filename": "commonroad_route_planner-2024.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "473c3c651d590384287ee291550c82e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 41511,
"upload_time": "2024-03-22T13:49:22",
"upload_time_iso_8601": "2024-03-22T13:49:22.443377Z",
"url": "https://files.pythonhosted.org/packages/4e/80/6570bcdaa6db19f55679937e0af1e7a269e2102b050dd3a282a4ebb9aa66/commonroad_route_planner-2024.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5c82119e334417ab46b2fb998a7fe107eb5320ba0b16f649e27221f8b8f379cc",
"md5": "13aaed7db8d6daf850241ab94744a2b7",
"sha256": "e840030a8ddbca264e59ba6014404bde6359c05c6128c21f71e6b40a2a6a637a"
},
"downloads": -1,
"filename": "commonroad_route_planner-2024.1.1.tar.gz",
"has_sig": false,
"md5_digest": "13aaed7db8d6daf850241ab94744a2b7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 29811,
"upload_time": "2024-03-22T13:49:24",
"upload_time_iso_8601": "2024-03-22T13:49:24.992030Z",
"url": "https://files.pythonhosted.org/packages/5c/82/119e334417ab46b2fb998a7fe107eb5320ba0b16f649e27221f8b8f379cc/commonroad_route_planner-2024.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-22 13:49:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "commonroad-route-planner"
}
JSON