"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.

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

You can download SUMO from SourceForge via our downloads site.

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

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

(or if you still prefer subversion)

    svn co https://github.com/DLR-TS/sumo.git

To stay informed, we have a mailing list for SUMO. You can subscribe at https://dev.eclipse.org/mailman/listinfo/sumo-user. 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 this list at https://dev.eclipse.org/mailman/listinfo/sumo-announce.

For Windows we provide pre-compiled binaries and Visual Studio project files. Using Linux a simple "./configure && make" should be enough for the distributions, if you have installed all needed libraries properly. Using the repository checkout you need to issue "make -f Makefile.cvs" before "./configure && make" in order to run the autoconf utilities creating configure and the Makefiles. If configure does not find the libraries or includes needed, please check "./configure --help" for information on how to specify the paths needed.

For detailed build instructions have a look at our wiki.

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.

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

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

EPL requires that "derivative works" be licensed under the terms of the EPL whereas "separate modules of software" may be licensed arbitrarily. Please follow the links below for lists of files where modifications are considered derivative work.

We currently consider all modifications to src and tools (including the subdirectories) as derivative work except for the following cases:

• TraCI client applications that use the public TraCI client libraries
• separate modules residing in src
• car following models that inherit from MSCFModel (excluding modifications of the existing models)
• lane changing models that inherit from MSAbstractLaneChangeModel (excluding modifications of the existing models)
• simulation output modules (excluding changes to the existing classes)
• vehicle device modules (excluding changes to the existing classes)
• network import modules (excluding changes to the existing classes)
• network export modules (excluding changes to the existing classes)
• software that build upon the existing Python and Java tools libraries (excluding changes to the existing)