Metadata-Version: 2.4
Name: commonroad-idm-planner
Version: 0.2.1
Summary: CommonRoad Intelligent Driver Model Planner
License: BSD
License-File: LICENSE
Keywords: autonomous,automated,vehicles,driving,motion,planning
Author: Tobias Mascetta
Author-email: <tobias.mascetta@tum.de>
Requires-Python: >=3.9, < 3.12
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: POSIX :: Linux
Requires-Dist: commonroad-drivability-checker (>=2025.1.0,<2026.0.0)
Requires-Dist: commonroad-io (>=2022.2,<2025.0.1)
Requires-Dist: commonroad-route-planner (>=2025.0.1,<2026.0.1)
Requires-Dist: matplotlib (>=3.9)
Requires-Dist: numpy (>=2.0)
Description-Content-Type: text/markdown

## CommoRoad IDM Planner
A simple IDM-based planner implementation as a baseline for benchmarking new planners. 

The implemented planner uses the concept of path-velocity-decomposition: first a path is planned and, then, 
a velocity profile is generated to avoid (dynamic) obstacles

By default, the planner uses the reference path planning module 
implemented in [CommonRoad-Route-Planner](https://cps.pages.gitlab.lrz.de/commonroad-route-planner/) to generate the path
on which, subsequently, a modified version of the Intelligent Driver Model (IDM) [1] is used to perform velocity planning.

In standard configuration, the planner only avoids dynamic obstacles, as it would wait indefinitely for static obstacles.

## Installation
This tool is available as pypi package using:
```
pip install commonroad-idm-planner
```

If you want to build it from source, make sure that you use the correct g++ version, as this is one fixed version
for all CommonRoad C++ project (e.g. the CommonRoad Curvilinear Coordinate System and the CommonRoad Drivability Checker).

## Documentation and Examples
The documentation can be found [here](https://commonroad-idm-planner-ddfe71.pages.gitlab.lrz.de/). 

A [module for standard use cases](https://commonroad-idm-planner-ddfe71.pages.gitlab.lrz.de/easy_api/) enables effortless integration.

## Integrated Models
- Intelligent Driver Models (IDM) [1]

## Author
Tobias Mascetta: tobias.mascetta[at]tum.de

## Source Code and Contribution
The original source code lives in a private gitlab repo. The official branches are mirrored to the [CommonRoad github](https://github.com/CommonRoad).
You can still issue pull requests, though, if you wish to contribute

## References
[1] Treiber, M., Hennecke, A., & Helbing, D. (2000). Congested traffic states in empirical observations and microscopic simulations. Physical review E, 62(2), 1805.
