Skip to main content

Implementation of vehicle models with varying abstraction levels ranging from kinematic single track model to a multi-body model.

Project description

Python Vehicle Models of CommonRoad

This package contains all vehicle models of the CommonRoad benchmarks.

We provide implementations of the vehicle dynamics, routines to convert initial states, and vehicle parameters.

Documentation

For a detailed explanation of the vehicle models, please have a look at the documentation.

Installation

To use vehicle models and parameters, run

pip install commonroad-vehicle-models

Code examples

For an extended simulation example demonstrating the advantages of more complicated models, we refer to our gitlab repository. A simple simulation example for using the single-track model in combination with an odeint solver would be

from scipy.integrate import odeint
import numpy

from vehiclemodels.init_ks import init_ks
from vehiclemodels.parameters_vehicle1 import parameters_vehicle1
from vehiclemodels.vehicle_dynamics_ks import vehicle_dynamics_ks

def func_KS(x, t, u, p):
    f = vehicle_dynamics_ks(x, u, p)
    return f

tStart = 0  # start time
tFinal = 1  # start time

# load vehicle parameters
p = parameters_vehicle1()

# initial state for simulation
delta0 = 0
vel0 = 15
Psi0 = 0
sy0 = 0
initialState = [0, sy0, delta0, vel0, Psi0]
x0_KS = init_ks(initialState)

t = numpy.arange(0, tFinal, 0.01)
u = [0, 5]
x = odeint(func_KS, x0_KS, t, args=(u, p))

Contribute

If you want to contribute new vehicle models, you can create a merge request in our repository, or contact via our forum.

Changelog

Compared to version 2.0.0 the following features were added/changed:

  • linearized kinematic single-track model added as an additional vehicle model
  • vehicle parameters are stored in YAML-files
  • parameter configuration of vehicles are generated from YAML-files using OmegaConf (backwards compatible)

Referencing

If you use CommonRoad for your research, please cite our paper:

@inproceedings{Althoff2017a,
	author = {Althoff, Matthias and Koschi, Markus and Manzinger, Stefanie},
	title = {CommonRoad: Composable benchmarks for motion planning on roads},
	booktitle = {Proc. of the IEEE Intelligent Vehicles Symposium},
	year = {2017},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

commonroad-vehicle-models-3.0.2.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

commonroad_vehicle_models-3.0.2-py3-none-any.whl (44.4 kB view details)

Uploaded Python 3

File details

Details for the file commonroad-vehicle-models-3.0.2.tar.gz.

File metadata

  • Download URL: commonroad-vehicle-models-3.0.2.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/57.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.7.9

File hashes

Hashes for commonroad-vehicle-models-3.0.2.tar.gz
Algorithm Hash digest
SHA256 874de3b173f7b39869b69ec8da71690f849766af8623525e3e96f8a33d034f8e
MD5 0d986eaa61ca77c389d2885936a01211
BLAKE2b-256 bfe1bc6dbacfc1af64c73e0610a7b71a47510c7d77d0d1eba88737c423fa84e1

See more details on using hashes here.

File details

Details for the file commonroad_vehicle_models-3.0.2-py3-none-any.whl.

File metadata

  • Download URL: commonroad_vehicle_models-3.0.2-py3-none-any.whl
  • Upload date:
  • Size: 44.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/57.0.0 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.7.9

File hashes

Hashes for commonroad_vehicle_models-3.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c8a675ddfdbba0c14521a4479cd820cfb42d03eb549723b00bd9384a434ddd6e
MD5 875754fb8cd85f67d13da42bcaf22a26
BLAKE2b-256 c3050bcea75e39bcb98192bfe908d2e53d636f87d0d9a365dcd95ffe5c1d9373

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page