Commit 86eddd66 authored by Moritz Klischat's avatar Moritz Klischat

Update readme.txt

parent 1a67d705
# Vehicle Models of CommonRoad
This repository contains all vehicle models of the [CommonRoad benchmarks](https://commonroad.in.tum.de/).
We provide implementation examples in MATLAB and Python, routines to convert initial states and parameters, simulation examples to demonstrate the advantages of more complicated models, and a detailed documentation.
## Installation and Tests (Python)
To use vehicle models and parameters, add the folder `Python` to your PYTHONPATH. If you are using PyCharm, this can be set through File->Settings->Project Interpreter->Show all->Edit
To execute a test function, which produces the plots of the vehicle models documentation, run 'testVehicle.py'.
## Contribute
If you want to contribute new vehicle models, you can create a merge request or contact us per [e-mail](mailto:commonroad-i06@in.tum.de).
## References
If you use CommonRoad, please cite *[M. Althoff, M. Koschi, and S. Manzinger, ''CommonRoad: Composable Benchmarks for Motion Planning on Roads,'' in Proc. of the IEEE Intelligent Vehicles Symposium, 2017, pp. 719-726](http://mediatum.ub.tum.de/doc/1379638/776321.pdf)*.
To execute a test function, which produces the plots of the vehicle models documentation, run 'testVehicle.py'.
Initialization of models------------------------------------------
kinematic single-track model: init_KS.py
single-track model: init_ST.py
multi-body model: init_MB.py
------------------------------------------------------------------
Parameter sets----------------------------------------------------
Ford Escort: parameters_vehicle1.py
BMW 320i: parameters_vehicle2.py
VW Vanagon: parameters_vehicle3.py
------------------------------------------------------------------
Vehicle models----------------------------------------------------
kinematic single-track model: vehicleDynamics_KS.py
single-track model: vehicleDynamics_ST.py
multi-body model: vehicleDynamics_MB.py
------------------------------------------------------------------
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment