A collection and interface for CommonRoad prediction algorithms.
Project description
CommonRoad-Prediction
A collection and interface for CommonRoad-based prediction algorithms.
Project status
Currently implemented and tested models:
- Constant Velocity Linear Predictor [1]
- Constant Velocity Curvilinear Predictor [1]
- Constant Acceleration Linear Predictor [1]
- Constant Acceleration Curvilinear Predictor [1]
In development:
- Intelligent Driver Model (IDM) Predictor [2]
- Lane-Changing Model MOBIL Predictor [3]
We highly welcome your contribution. If you want to contribute a prediction algorithm, please create an issue/pull request in our GitHub repository.
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
pip install commonroad-prediction
Development
It is recommended to use poetry as an environment manager. Clone the repository and install it with poetry.
git clone git@github.com:commonroad/commonroad-prediction.git
poetry shell
poetry install
Examples
We recommend to use PyCharm (Professional) as IDE. An example script for visualizing predictions is provided here.
Documentation
You can generate the documentation within your activated Poetry environment using.
poetry shell
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:
poetry shell
mkdocs serve
Authors
Responsible: Roland Stolz, Sebastian Maierhofer
References
The implemented algorithms are based on the subsequent publications:
[1] R. Schubert, E. Richter and G. Wanielik, "Comparison and evaluation of advanced motion models for vehicle tracking," Proc. of the IEEE Int. Conf. on Information Fusion, 2008, pp. 1-6.
[2] M. Treiber, A. Hennecke, and D. Helbing, "Congested traffic states in empirical observations and microscopic simulations," Physical Review E, vol. 62, no. 2, pp. 1805–1824, 2000.
[3] A. Kesting, M. Treiber, and D. Helbing, “General lane-changing model MOBIL for car-following models,” Transportation Research Record, vol. 1999, pp. 86–94, Jan. 2007
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file commonroad_prediction-0.1.1.tar.gz
.
File metadata
- Download URL: commonroad_prediction-0.1.1.tar.gz
- Upload date:
- Size: 20.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.11.9 Linux/5.15.0-87-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39766779be1bfe4ba39ffffdffc78e0818aa2fc3b0bd30fef9565757a4c8943a |
|
MD5 | b07f177886abd6221374d929db5d2261 |
|
BLAKE2b-256 | da8e1e115db69a9a3fd573623e53803b0e488ac24b4085b02d1c466b5174b9c9 |
File details
Details for the file commonroad_prediction-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: commonroad_prediction-0.1.1-py3-none-any.whl
- Upload date:
- Size: 27.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.11.9 Linux/5.15.0-87-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e65cf19d94c725f206075434ff4241bd6d7e7f3660f75c94713afda8811a4ec4 |
|
MD5 | 20fa828781f65edb8f5c5a177d949ca3 |
|
BLAKE2b-256 | 817b4415fdf46ea6172d91df0ec0b4d19564bb713ef063787912a1dcb7ca5ba7 |