Run MATSim with Tramola integration

Learn how to start MATSim outside of Tramola, but have the run report to Tramola.

Download the Tramola Client library

In order for your MATSim to reports its data to Tramola, a small integration library is needed.

Click on “Runs” in the left navigation bar, then click on “Learn how to add runs”. An information box appears with some guidelines. As first point, it lists links to the Tramola client library for MATSim. Download the appropriate version matching your MATSim version.

Adapt your MATSim configuration

Then, add the following section to youf config.xml:

<module name="tramola">
    <param name="url" value="https://tramola.io" />
    <param name="apiKey" value="your-api-key" />
</module>

Adapt the URL to point to your installation (probably http://localhost:3471 if you run Tramola locally). You find your API-Key when clicking on My Profile in the left navigation, and clicking on API-Keys next.

Start your run

Now it’s time to start your run!

On Windows, start your MATSim run with:

java -cp matsim.jar;tramola-matsim12.jar com.simunto.tramola.matsim.Run config.xml

On Linux or macOS, start your MATSim run with:

java -cp matsim.jar:tramola-matsim12.jar com.simunto.tramola.matsim.Run config.xml

As you see, it uses com.simunto.tramola.matsim.Run instead of the regular org.matsim.run.Controler to start the run. This is necessary to load the tramola-integration into MATSim. If you are interested in the detailed code, the source code of this Tramola integration library is available as open-source software.

Your run in Tramola

After you have started your run, switch to Tramola and click on “Runs” in the left navigation. You should see your just-started run in the list.