<a href="https://sumo.dlr.de/docs"><p align="center"><img width=50% src="https://raw.githubusercontent.com/eclipse/sumo/main/docs/web/docs/images/sumo-logo.svg"></p></a>

Eclipse SUMO - Simulation of Urban MObility

What is SUMO

"Simulation of Urban MObility" (SUMO) is an open source, highly portable, microscopic traffic simulation package designed to handle large road networks and different modes of transport.

<p align="center"><img width=70% src="https://raw.githubusercontent.com/eclipse/sumo/main/docs/web/docs/images/multiple-screenshots.png"></p>

It is mainly developed by employees of the Institute of Transportation Systems at the German Aerospace Center.

Where to get it

You can download SUMO via our downloads site.

As the program is still under development (and is being extended continuously), we advice you to use the latest sources from our GitHub repository. Using a command line client, execute the following command:

git clone --recursive https://github.com/eclipse-sumo/sumo

Contact

To stay informed, we have a mailing list for SUMO, which you can subscribe to. Messages to the list can be sent to sumo-user@eclipse.org. SUMO announcements will be made through the sumo-announce@eclipse.org list; you can subscribe to it as well. For further contact information, have a look at this page.

Build and Installation

For Windows we provide pre-compiled binaries and CMake files to generate Visual Studio projects. If you want to develop under Windows, please also clone the dependent libraries using:

git clone --recursive https://github.com/DLR-TS/SUMOLibraries

If you're using Linux, you should have a look whether your distribution already contains sumo. There is also a ppa for ubuntu users and an open build service instance. If you want to build SUMO yourself, the steps for ubuntu are:

cd <SUMO_DIR> # please insert the correct directory name here
export SUMO_HOME="$PWD"
sudo apt-get install $(cat build_config/build_req_deb.txt build_config/tools_req_deb.txt)
cmake -B build .
cmake --build build -j$(nproc)

For detailed build instructions, have a look at our Documentation.

Getting started

To get started with SUMO, take a look at the docs/tutorial and examples directories, which contain some example networks with routing data and configuration files. There is also user documentation provided in the docs/ directory and on the homepage.

Documentation

• The main documentation is at sumo.dlr.de/docs. Note that this tracks the development version.
• A mirror of the main documentation is at eclipse.dev/sumo/docs/.
• An offline version of the documentation is part of every release and can be accessed via docs/userdoc/index.html.

Improving SUMO

Please use the GitHub issue tracking tool for bugs and requests, or file them to the sumo-user@eclipse.org list. Before filing a bug, please consider to check with a current repository checkout whether the problem has already been fixed.

We welcome patches, pull requests and other contributions! For details see our contribution guidelines.

We use Weblate for translating SUMO. If you want to add translation strings or a language, see our contribution guidelines and this page for more information.

License

SUMO is licensed under the Eclipse Public License Version 2. The licenses of the different libraries and supplementary code information are in the subdirectories and in the Documentation.