Installing/Windows Build

This document describes how to build SUMO under MS-Windows using only freely available (this does not mean "open source") tools. Instructions on how to build SUMO on Windows using an Open Source toolchain are included in our building on Linux pages. Please note that you may also download pre-build Windows binaries.

Further notes#

If you need a different python version or want to test with multiple pythons you can either install them directly from Visual Studio or Download Python for Windows and install it. Most SUMO tools should work with Python 2 and 3. Please make sure that you install the recommend python modules as above.

If you want to clone / checkout a special sumo version, you can of course do it from the ommand line (if you have installed the command line tools) using git clone --recursive https://github.com/eclipse/sumo or download and extract a source package, see Downloads

The command for the #Libraries is: git clone --recursive https://github.com/DLR-TS/SUMOLibraries. If you do not place the libraries in the same folder as sumo, you will need to set the SUMO_LIBRARIES environment variable to the directory.

It Visual Studio fails at first try (maybe SUMOLibraries are not cloned yet or are in an unusual location, the errors talk about not finding Xerces) - Select Project->"Generate Cache" to try again (it is CMake->Generate in earlier Visual Studio versions) or see below

Adapting settings#

If you need to modify settings, you can edit the CMakeCache.txt by opening it in your favorite text editor or via the Project->Cmake-Cache menu. The following things might be useful

- If the libraries are not found, set SUMO_LIBRARIES:PATH to something like C:/Users/testus/source/repos/SUMOLibraries) and retry - If the wrong python interpreter or library is found, edit the PYTHON_* variables - If you want to disable the build of the GUI (Fox) or usage of Proj, set the according library entries to the empty string

To make a debug build, you should not change CMAKE_BUILD_TYPE in the cache file. You should choose a different configuration in the GUI instead.

Libraries#

We provide a central location for getting all dependent libraries at https://github.com/DLR-TS/SUMOLibraries. The easiest way is to clone this repository and define an environment variable SUMO_LIBRARIES pointing to the resulting directory. They are build with Visual Studio 2017, but may be used with earlier and later versions as well. You may need to install the Visual C++ 2017 Runtime Distributable for running SUMO then (tested with Visual Studio 2013).

Caution

When cloning SUMOLibraries you must initialized all submodules with git submoudle update --init

For details on building your own and also on how to use different versions and additional libraries see Installing/Windows_Libraries. Make sure that the subdirectories fox-1.6.54/lib, proj_gdal-1911/bin and xerces-c-3.2.0/bin are in PATH. Note: for 32 bits compilations folders are 32bits/fox-1.6.54/lib, 32bits/proj_gdal-1911/bin and 32bits/xerces-c-3.2.0/bin. You can add both to the path but always add the 64 bit version first.

Tests#

  • If you plan to extend SUMO yourself, or just want to know whether everything compiled OK, it is strongly recommended to have a look at Developer/Tests. This tool makes it easier to check whether some existing functionality was broken by the extensions.

Troubleshooting#

  • Note on installation paths: MSVC seems to have difficulties with include and library paths containing spaces (for instance C:\Program Files). Thus try to avoid installing SUMO or any of the libraries in such paths.

You probably have installed a library to a path containing white spaces in its name. In such a case, the according environment variable should be embedded in quotes (").

Example: set FOX="D:\my libs\fox-1.6.36".

Failure on pre-build event (missing version.h or *typemap.h)#

If Visual Studio reports a failed pre-build event you can safely ignore this, unless you are building from the source code repository. In this case you should probably install Python. Even if python is installed the file associations may be broken which causes the generation of src/version.h via tools/build/version.py to fail. Either repair your file associations or undefine HAVE_VERSION_H in src/windows_config.h.

If you did install Python correctly, double check that it passes command line arguments. For a quick fix, you can also execute the following commands manually:

tools\build\version.py
tools\build\typemap.py

Execution cannot proceed because MSVCR120.dll/MSVCR140.dll was not found#

Install Microsoft Visual C++ Redistributable Packages for Visual Studio 2012 (for MSVCR120.dll) or Microsoft Visual C++ Redistributable Packages for Visual Studio 2015 (for MSVCR140.dll). You can check if all dependencies are correct using Dependencies

In debug mode, execution cannot proceed because MSVCR120D.dll/MSVCR140D.dll was not found#

Your version of Visual Studio doesn't support Debugging, only can be compiled in release mode.

Available configurations#

The release build is used for the distribution of sumo. The Debug build allows all debugging features. Keep in mind that Texttest usually picks up the release build.

  • Release: All optimizations, assertions disabled, no debugging symbols, links against external release libs
  • Debug: No optimizations, assertions enabled, debugging symbols included, links against external debug libs

Left clicking over Solution/Properties/Configuration Manager allow to change between configurations:

To switch to a different platform (e.g. 32bit instead of 64 bit) please run cmake again with a different generator.

Naming Conventions: 64bit executables have the same name as their 32bit counterpart. The Debug build additionally carries the suffix 'D'.