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
Metadata
Release files for commonroad-prediction 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| commonroad_prediction-0.1.2.tar.gz | 20.2 kB | Without provenance | Details for commonroad_prediction-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| commonroad_prediction-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for commonroad_prediction-0.1.2-py3-none-any.whl |
Total release size: 48.3 kB
Release files / commonroad_prediction-0.1.2.tar.gz
| Download URL | commonroad_prediction-0.1.2.tar.gz |
|---|---|
| Size | 20.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d06e0cfe5dcacf36df8bb8e836bcae4cfbcfc3a943b794a84b5a0210582e379a
|
|
BLAKE2b-256 checksum How to use checksums |
0b34b854566bb856c45e64130d3cbc98ce13071abf80b460b9a86762b9928467
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.3 CPython/3.11.16 Linux/5.15.0-87-generic
|
Release files / commonroad_prediction-0.1.2-py3-none-any.whl
| Download URL | commonroad_prediction-0.1.2-py3-none-any.whl |
|---|---|
| Size | 28.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7a45b2da5560d95ca6d9d36912a305af6fa33c9d0365349efd894cf5adebf347
|
|
BLAKE2b-256 checksum How to use checksums |
d60a2bf8c3f001bdd1097515d2568fd71ccb85f7340f8f31542697f8406da12b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.3 CPython/3.11.16 Linux/5.15.0-87-generic
|
Security for commonroad-prediction 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.