commonroad-route-planner


Namecommonroad-route-planner JSON
Version 2025.1.0 PyPI version JSON
download
home_pageNone
SummaryRoute and reference path planning tool for CommonRoad scenarios
upload_time2025-02-20 15:57:46
maintainerNone
docs_urlNone
authorTobias Mascetta
requires_python<3.12,>=3.9
licenseBSD
keywords autonomous automated vehicles driving motion planning prediction
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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-reference_path-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": null,
    "name": "commonroad-route-planner",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.12,>=3.9",
    "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/77/78/83a91fd5175653697620e2d307367f4b19ecc9325c308fb2874fe146fc19/commonroad_route_planner-2025.1.0.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-reference_path-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": "2025.1.0",
    "project_urls": null,
    "split_keywords": [
        "autonomous",
        " automated",
        " vehicles",
        " driving",
        " motion",
        " planning",
        " prediction"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fec2705dceabacbe2d18ce427fbea4dea4e6dec22ed18e493efde1f27b6da6c5",
                "md5": "df72f26488ed4c23c5f38c424bac82f7",
                "sha256": "88b314882c94b9cf1adb060c3c58b1ef18c42224c4fd5cdc350421527fadf097"
            },
            "downloads": -1,
            "filename": "commonroad_route_planner-2025.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "df72f26488ed4c23c5f38c424bac82f7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.12,>=3.9",
            "size": 41895,
            "upload_time": "2025-02-20T15:57:44",
            "upload_time_iso_8601": "2025-02-20T15:57:44.767982Z",
            "url": "https://files.pythonhosted.org/packages/fe/c2/705dceabacbe2d18ce427fbea4dea4e6dec22ed18e493efde1f27b6da6c5/commonroad_route_planner-2025.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "777883a91fd5175653697620e2d307367f4b19ecc9325c308fb2874fe146fc19",
                "md5": "fc16ee9071d226e8e1cced111809ef86",
                "sha256": "677a9eaeebeb9e7595e2bd44adf1c65b5832e8267140fdc09c7a6f18e36d1c5d"
            },
            "downloads": -1,
            "filename": "commonroad_route_planner-2025.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "fc16ee9071d226e8e1cced111809ef86",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.12,>=3.9",
            "size": 28821,
            "upload_time": "2025-02-20T15:57:46",
            "upload_time_iso_8601": "2025-02-20T15:57:46.074983Z",
            "url": "https://files.pythonhosted.org/packages/77/78/83a91fd5175653697620e2d307367f4b19ecc9325c308fb2874fe146fc19/commonroad_route_planner-2025.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-20 15:57:46",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "commonroad-route-planner"
}
        
Elapsed time: 0.41023s