SUMO

https://sumo.dlr.de/docs/
Admin
SUMO is an open-source microscopic traffic simulation package designed to handle large networks with...
Tokens:491,281
Snippets:4,060
Trust Score:10
Update:4 days ago
Show doc for...
Tokens:
Raw
### C++ simulation example (test.cpp)

Source: https://sumo.dlr.de/docs/Libsumo.html

Example C++ code to start a simulation, run five steps, and close it. Requires the SUMO bin directory in the PATH.

```cpp
#include <iostream>
#define HAVE_LIBSUMOGUI  // if you are on Windows or have libsumo compiled yourself without GUI you should remove this line
#include <libsumo/libsumo.h>

using namespace libsumo;

int main(int argc, char* argv[]) {
    Simulation::start({"sumo", "-c", "test.sumocfg"});
    for (int i = 0; i < 5; i++) {
        Simulation::step();
    }
    Simulation::close();
}
```

--------------------------------

### GitHub Actions Workflow Configuration

Source: https://sumo.dlr.de/docs/Developer/Github_Actions_CI_Test.html

A complete YAML workflow example for CI testing, including environment setup, dependency installation, and test execution steps.

```yaml
name: linux-build  # workflow name as stated under your project's GitHub 'Actions' tab

on:  # define triggers on which to run this workflow
  push:
  pull_request:
  schedule:
    - cron:  '42 0 * * *'

jobs:  # define individual jobs to run
  build:  # ID of this job
    runs-on: ubuntu-latest  # VM type to run this job on
    env:  # define environment variables for this job
      OMNET_VERSION: 5.6.2
    strategy:  # define job variations
      fail-fast: false  # do not cancel all in-progress jobs if any job variation fails
      matrix:  # define variation parameters and their values
        sumo_build: [ubuntu, ppa, nightly]

    steps:  # define this job's individual steps
    - name: Cloning Veins  # this step's name
      uses: actions/checkout@v2  # predefined and reusable action for this step (see https://github.com/actions/checkout)
      with:  # set values for the predefined action's parameters
        path: src/veins

    - name: Cloning OMNeT++
      uses: actions/checkout@v2
      with:
        repository: omnetpp/omnetpp
        ref: omnetpp-${{ env.OMNET_VERSION }}  # evaluate the environment variable OMNET_VERSION defined above
        path: src/omnetpp

    - name: Preparing Build System
      run: |  # define a custom multi-line command (instead of a reusable action) for this step
        if [[ "${{ matrix.sumo_build }}" == "ppa" ]]; then sudo add-apt-repository ppa:sumo/stable; fi
        sudo apt-get update
        sudo apt-get install build-essential gcc g++ bison flex perl python3 libxml2-dev zlib1g-dev default-jre doxygen graphviz

    - name: Installing SUMO from repo
      if: matrix.sumo_build != 'nightly'  # only run this step if the condition is true
      run: |
        sudo apt-get install sumo sumo-tools
        echo "SUMO_HOME=/usr/share/sumo" >> $GITHUB_ENV

    - name: Installing SUMO from PyPI
      if: matrix.sumo_build == 'nightly'
      run: |
        python -m pip install --index-url https://test.pypi.org/simple/ eclipse-sumo
        python -c "import sumo; print('SUMO_HOME=' + sumo.SUMO_HOME)" >> $GITHUB_ENV

    - name: Adapting PATH
      run: |
        echo "PATH=$PWD/src/omnetpp/bin:$SUMO_HOME/bin:$PATH" >> $GITHUB_ENV
        cat $GITHUB_ENV

    - name: Building OMNeT
      run: |
        cd src/omnetpp
        cp configure.user.dist configure.user
        ./configure WITH_TKENV=no WITH_QTENV=no WITH_OSG=no WITH_OSGEARTH=no
        make -j4

    - name: Building Veins
      run: |
        cd src/veins
        ./configure
        make -j4

    - name: Running Veins Test
      run: |
        cd src/veins/examples/veins
        echo $SUMO_HOME; sumo
        ../../bin/veins_launchd -vv --daemon -L veins_launchd.log
        ./run -u Cmdenv

    - name: Upload Test log
      if: ${{ always() }}
      uses: actions/upload-artifact@v2  # see https://github.com/actions/upload-artifact
      with:
          name: veins-${{ matrix.sumo_build }}.log
          path: |
            src/veins/examples/veins/veins_launchd.log
```

--------------------------------

### Launch sumo-gui with configuration

Source: https://sumo.dlr.de/docs/sumo-gui.html

Command-line instruction to start the simulation using a specific configuration file.

```bash
sumo-gui -c example.sumocfg
```

--------------------------------

### Install SUMO via apt-get

Source: https://sumo.dlr.de/docs/Installing/index.html

Standard installation command for Debian and Ubuntu systems.

```bash
sudo apt-get install sumo sumo-tools sumo-doc
```

--------------------------------

### C# simulation example (Program.cs)

Source: https://sumo.dlr.de/docs/Libsumo.html

Example C# code to start a simulation, run five steps, and close it.

```csharp
using Eclipse.Sumo.Libsumo;

internal class Program
{
    static void Main(String[] args) {
        Simulation.start(new StringVector(new String[] {"sumo", "-c", "test.sumocfg"}));
        for (int i = 0; i < 5; i++) {
            Simulation.step();
        }
        Simulation.close();
    }
}
```

--------------------------------

### Java simulation example (Test.java)

Source: https://sumo.dlr.de/docs/Libsumo.html

Example Java code to start a simulation, run five steps, and close it. Includes library preloading for Windows compatibility.

```java
import org.eclipse.sumo.libsumo.Simulation;
import org.eclipse.sumo.libsumo.StringVector;

public class Test {
    public static void main(String[] args) {
        Simulation.preloadLibraries();
        Simulation.start(new StringVector(new String[] {"sumo", "-c", "test.sumocfg"}));
        for (int i = 0; i < 5; i++) {
            Simulation.step();
        }
        Simulation.close();
    }
}
```

--------------------------------

### Example viewsettings.xml structure

Source: https://sumo.dlr.de/docs/sumo-gui.html

A comprehensive example of a gui-settings file containing viewport, delay, decal, and breakpoint configurations.

```xml
    <viewsettings>
        <scheme name="...">
           ...
        </scheme>

        <viewport zoom="200" x="100" y="-100" angle="0.00"/>
        <delay value="42"/>
        <decal file="background.gif" centerX="550.00" centerY="1530.00" width="64.00" height="64.00" rotation="0.00"/>
        <breakpoint value="42"/>
        <breakpoint value="1337"/>
    </viewsettings>
```

--------------------------------

### Run Examples and Unit Tests

Source: https://sumo.dlr.de/docs/Installing/MacOS_Build.html

Trigger the creation of examples and execution of unit tests.

```bash
cd $SUMO_HOME
CTEST_OUTPUT_ON_FAILURE=1 cmake --build build --target examples test
```

--------------------------------

### Run SUMO with configuration file using -c

Source: https://sumo.dlr.de/docs/Basics/Using_the_Command_Line_Applications.html

Command to start the application with the configuration file using the -c option. Works with both configuration versions.

```bash
sumo.exe -c test.sumocfg
```

--------------------------------

### CMake Python 3.8 Output

Source: https://sumo.dlr.de/docs/Installing/MacOS_Build.html

Example output from CMake when detecting the Brew Python 3.8 installation.

```text
-- Found PythonInterp: /usr/local/bin/python3.8 (found version "3.8.6")
...
-- Found PythonLibs: /usr/local/Frameworks/Python.framework/Versions/3.8/lib/libpython3.8.dylib (found version "3.8.6")
```

--------------------------------

### Build SUMO on Ubuntu

Source: https://sumo.dlr.de/docs/Installing/Linux_Build.html

A sequence of commands to install Git, clone the repository, set the SUMO_HOME environment variable, install dependencies, and compile the project.

```bash
sudo apt-get install git
git clone --recursive https://github.com/eclipse-sumo/sumo
cd sumo
export SUMO_HOME="$PWD"
sudo build_config/install_dependencies.sh  # this will also add repositories for parquet, download and build jupedsim from source
cmake -B build .
cmake --build build -j$(nproc)
```

--------------------------------

### CMake Python 2.7 Output

Source: https://sumo.dlr.de/docs/Installing/MacOS_Build.html

Example output from CMake when detecting the default Python 2.7 installation.

```text
-- Found PythonInterp: /usr/bin/python (found version "2.7.16")
-- Found Python: /usr/bin/python
...
-- Found PythonLibs: /usr/lib/libpython2.7.dylib (found version "2.7.16")
```

--------------------------------

### Python libtraci basic usage

Source: https://sumo.dlr.de/docs/Libtraci.html

Basic example of starting a simulation, stepping, and closing using the libtraci library.

```python
import libtraci
libtraci.start(["sumo", "-c", "test.sumocfg"])
libtraci.simulationStep()
libtraci.close()
```

--------------------------------

### Install SUMO binaries

Source: https://sumo.dlr.de/docs/Installing/Linux_Build.html

Install the compiled binaries into the system path.

```bash
sudo cmake --install build
```
Tokens:
Raw