Skip to content

🧠 Sumo docker📦

A modular component of the internal project ecosystem
This documentation provides structure, setup, and integration details for the repository.

📝 Project Overview

This project simplifies deployment of the SUMO (Simulation of Urban MObility) traffic simulator in any environment by using Docker. It provides a reproducible, containerized environment for simulations, removing the need for manual installations and configuration.

🏗️ Repository Purpose

This repository contains everything needed to build and run SUMO in a Docker container, with scripts to install dependencies, fetch the latest SUMO sources, and launch an interactive shell ready for simulation tasks.

⚙️ Setup & Installation

🔗 Requirements

  • Linux machine (tested on Ubuntu/Debian)
  • make utility
  • Docker and Docker Compose

📦 Setup Steps

1️⃣ Clone this repository:

git clone https://github.com/sanevec/sumo_docker
cd sumo_docker

2️⃣ Create your `` file:

cp .env.example .env

Edit .env and set the desired variables.

3️⃣ Install Docker (if needed):

make docker-install

Or follow the official guide.

4️⃣ Start the Docker container:

make up

🧩 Structure & Components

Path Description
.env.example Example environment variables file
Makefile Helper commands for setup and usage
docker/ Docker build context with custom SUMO

📐 Configuration

Edit the .env file to configure parameters for the container. Example:

VERSION=1.0.0
PROJECT_NAME=sumo_alpine
GIT_REMOTE_URL=github.com/sanevec/sumo_snvc
GIT_TAG=v1.23.1
GH_USERNAME=yourusername
GH_PAT=your github personal access token with read permissions

🚀 Usage

▶️ How to run the container and use SUMO.

✅ Run an interactive shell in the container:

make shell

You can then run SUMO tools from inside the container:

sumo-gui
sumo
netedit

🧪 Testing & Validation

You can validate the setup by running a basic SUMO command in the container:

sumo --version

or check that sumo-gui launches without errors.

📊 Example Results

Once running, SUMO and its tools should be fully operational in the container. Example:

SUMO version 1.19.0
Build features: …

❓ FAQ

  • Q: Why does sumo docker-install fail?\ A: Ensure you are running on Ubuntu/Debian and have sudo privileges. Alternatively, follow the Docker official installation guide.

  • Q: Can I use a specific version of SUMO?\ A: Yes, edit the .env file and set SUMO_VERSION accordingly before running make git.

🛠️ Troubleshooting

  • If sumo-gui fails to start inside the container:

  • Check that X11 forwarding is correctly configured.

  • Use xhost +local: on your host to allow Docker to access your display.

  • If the SUMO repository is empty:

  • Delete docker/custom_sumo and re-run make git.

  • If Make: Command not found:

  • Run sudo apt install -y build-essential

📎 Notes & References