This project provides a ready-to-use development environment for working with Veins, a popular open-source vehicular network simulation framework. The environment is designed to be used with Visual Studio Code Dev Containers and Docker, making it easy to set up and work with Veins, OMNeT++, and SUMO on any system.

veins_devcontainer/
  ├── .devcontainer/
  │   ├── devcontainer.json
  │   ├── Dockerfile
  │   ├── install-omnetpp.sh
  │   ├── install-sumo.sh
  │   ├── install-misc.sh
  │   ├── install-docker-env.sh
  │   ├── docker-env.sh
  ├── install.sh

This is the main directory containing all scripts and configuration files needed to set up the development environment.

• .devcontainer/ Contains all configuration and setup scripts for the development container.

  • devcontainer.json Main configuration file for VS Code Dev Containers. Specifies the container name, build instructions, required extensions, and shell settings. It ensures the environment is tailored for OMNeT++, SUMO, and Veins development, including:

    • Container name: "OMNeT++ and SUMO on Debian 12"
    • Builds from the provided Dockerfile
    • Installs recommended VS Code extensions (clangd, OMNeT++ NED syntax, LLDB debugger)
    • Sets up zsh as the default shell

  • Dockerfile Defines the base image and steps to install all required software on top of Debian 12. It:

    • Installs system dependencies
    • Runs scripts to install OMNeT++, SUMO, and other tools
    • Sets up the environment for development

  • install-omnetpp.sh Installs OMNeT++ (a discrete event simulator) and its dependencies. It:

    • Downloads and unpacks the specified OMNeT++ version
    • Installs required libraries and tools
    • Configures and builds OMNeT++ in both debug and release modes
    • Disables OpenSceneGraph (OSG) for compatibility in Docker

  • install-sumo.sh Installs SUMO (Simulation of Urban MObility) and its dependencies. It:

    • Downloads and unpacks the specified SUMO version
    • Installs required libraries and tools
    • Builds SUMO from source

  • install-misc.sh Installs additional useful tools for development and debugging, such as:

    • vim, zsh, valgrind, bear, clangd-13, lldb-13

  • install-docker-env.sh Ensures the Docker environment variables are set up for every shell session in the container by linking the docker-env.sh script to /etc/profile.d/.

  • docker-env.sh Script that sets up environment variables (e.g., PATH and PYTHONPATH) for OMNeT++ and SUMO, ensuring their binaries and Python packages are available in every shell session.

• install.sh A helper script to link the .devcontainer setup into an existing Veins installation. It:

  • Checks for the Veins source directory
  • Creates hard links for the devcontainer files in the Veins directory
  • Ensures the setup is not duplicated

1. Clone this repository (or copy the veins_devcontainer directory) into your Veins project root.
2. Run install.sh to set up the devcontainer configuration in your Veins directory. This will link all necessary files for the devcontainer setup.
3. Open the project in VS Code and use the "Reopen in Container" feature. VS Code will build the Docker image and set up the environment automatically.
4. Start developing and simulating with Veins, OMNeT++, and SUMO, all pre-installed and configured.

• Docker
• Visual Studio Code with the Dev Containers extension
• A Veins source directory (the setup expects to be linked into a Veins project)

Veins is an open-source framework for running vehicular network simulations. It couples the OMNeT++ network simulator with the SUMO road traffic simulator, allowing researchers and developers to simulate realistic vehicle movement and communication scenarios.

• OMNeT++: A modular, C++-based discrete event simulator for building network simulators.
• SUMO: An open-source, highly portable, microscopic and continuous road traffic simulation package.

This devcontainer setup ensures both OMNeT++ and SUMO are installed and configured to work together seamlessly, making it easy to start simulating with Veins.

This project and its scripts are licensed under the GNU General Public License v2.0 or later. See individual files for details.

• Veins Documentation
• OMNeT++ Documentation
• SUMO Documentation

If you have questions or need help, please refer to the official documentation or open an issue in your project repository.

Below are some of the most useful commands you can run inside the container, along with explanations of what they do:

• Rebuild the container

  # In VS Code, open the Command Palette (Ctrl+Shift+P) and run:
  Dev Containers: Rebuild and Reopen in Container

  Rebuilds the Docker image and restarts the development environment. Use this if you change the Dockerfile or setup scripts.

• Open a terminal in the container

  # In VS Code, open a new terminal (Ctrl+`)

  Opens a shell inside the running container, where you can run all commands below.

• Check OMNeT++ version

  omnetpp --version

  Displays the installed OMNeT++ version and confirms it is available.

• Run OMNeT++ IDE (GUI)

  omnetpp

  Launches the OMNeT++ graphical IDE (if X11 forwarding or a GUI is available).

• Compile a simulation

  make

  Builds your OMNeT++ simulation project (run in your project directory).

• Run a simulation

  opp_run -n .:../veins/src -l ../veins/src/veins

  Runs a simulation using OMNeT++ (adjust paths as needed for your setup).

• Check SUMO version

  sumo --version

  Displays the installed SUMO version and confirms it is available.

• Run SUMO in command-line mode

  sumo -c your_config_file.sumocfg

  Runs a SUMO simulation using the specified configuration file.

• Run SUMO with GUI

  sumo-gui -c your_config_file.sumocfg

  Launches the SUMO graphical user interface (if X11 forwarding or a GUI is available).

• Install devcontainer setup into Veins project

  ./install.sh

  Links the devcontainer configuration into your Veins project. Run this from the veins_devcontainer directory.