Skip to main content

Python tool to interface with the SUMO traffic simulator

Project description

SUMO - CommonRoad Interface

This package implements the interface between the framework for motion planning of automated vehicles commonroad-io and the traffic simulator SUMO. The interface is presented in detail in our paper [1].

Documentation

Please refer to the documentation and tutorials. To run interactive scenarios, denoted by the suffix I, from the CommonRoad database, please use the script from the corresponding repository gitlab.lrz.de/tum-cps/commonroad-interactive-scenarios.

[1] Moritz Klischat, Octav Dragoi, Mostafa Eissa, and Matthias Althoff, Coupling SUMO with a Motion Planning Framework for Automated Vehicles, SUMO 2019: Simulating Connected Urban Mobility

Development

Dependencies

You can easily install all dependencies with poetry:

$ poetry install --with tests --with dev

Tests

To run the tests you can use:

$ export SUMO_HOME=$(whereis sumo)
$ poetry run pytest tests/ --ignore=./tests/sumocr/sumo_docker

pre-commit

pre-commit is used to run a variety of checks on the code (e.g. formatting with black). You can install the hooks with:

$ pre-commit install

Those hooks will be run everytime you run git commit.

Documentation

The documentation is built with sphinx. Before building make sure to install the required dependencies:

$ poetry install --with docs

Than you can build the documentation with:

$ cd docs/source
$ poetry run sphinx-build -b html . ../../public

After the built finished successfully you can view in you browser by opening public/index.html from the root of the project. If you perfomed API changes, you might need to recreate the API doc:

$ cd docs
$ poetry run sphinx-apidoc -o ./source/api ../sumocr

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

sumocr-2024.1.tar.gz (53.5 kB view details)

Uploaded Source

Built Distribution

sumocr-2024.1-py3-none-any.whl (65.1 kB view details)

Uploaded Python 3

File details

Details for the file sumocr-2024.1.tar.gz.

File metadata

  • Download URL: sumocr-2024.1.tar.gz
  • Upload date:
  • Size: 53.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.14 Linux/5.15.0-87-generic

File hashes

Hashes for sumocr-2024.1.tar.gz
Algorithm Hash digest
SHA256 f4fac380d99f68670eafbce74752f14f6f0d5362058c9c84b8e7d7eba10800c6
MD5 608b0b931813d39a61a54d5b1a38fd99
BLAKE2b-256 93d98c3606cac59546e7a531a08dd6db827aaa8b9d03627864d87f3b99c3fe88

See more details on using hashes here.

File details

Details for the file sumocr-2024.1-py3-none-any.whl.

File metadata

  • Download URL: sumocr-2024.1-py3-none-any.whl
  • Upload date:
  • Size: 65.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.14 Linux/5.15.0-87-generic

File hashes

Hashes for sumocr-2024.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7d7bc53b71e89dbb0353e6a6004c138496c69391d03ed07d2d18d45664f4c23c
MD5 a6b6fea844a7d59bb3e74d3393c134c4
BLAKE2b-256 10349845aedc1ac7ec9a9b17ff681688457c79d87af48534413f24efb4fdd0a6

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