sumocr 2024.1

Python tool to interface with the SUMO traffic simulator

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