About Integrating Simwrapper files

[anujn08]

I am very new to MAT Sim and recently came across this beautiful visualization tool, "Sim wrapper.". I am able to run those examples files after downloading the example data. I want to know that if I want to visualize the output from my MATSIM scenario how I can achieve that?

[billyc]

Hi there! I'm glad you found SimWrapper!

The easiest way to get started using SimWrapper with MATSim is to use the official "SimWrapper Contrib" which is now part of the main matsim-libs library.

The short version:

1. Add the SimWrapper module to your Maven dependencies (it is present in pom.xml but commented out by default);
2. Add the following line to your main function which sets up your MATSim controler:

controler.addOverridingModule(new SimWrapperModule())

That's it! When you scenario finishes running, the SimWrapper dashboard files will be placed in the output folder. Open Chrome, go to simwrapper.github.io, and click "Open Folder..." to navigate to your output folder and see the dashboards.

Longer version:

MATSim has many "contribs" which are extensions to the core MATSim library. If you are using any recent (2024) build of MATSim, there is a contrib module which builds SimWrapper dashboards automatically when the scenario completes running. If you add the line shown above to your main() function, this happens automatically.

The default dashboard is focused on auto vehicle traffic but also includes mode share and other metrics. This is probably the right place to start since you are new to MATSim.

Full docs of the SimWrapper Contrib are here:

• https://github.com/matsim-org/matsim-libs/tree/master/contribs/simwrapper

And there is a complete main function as part of the Open Berlin Scenario, which you may also find helpful. Search for 'simwrapper' in this file:

• https://github.com/matsim-scenarios/matsim-berlin/blob/main/src/main/java/org/matsim/run/OpenBerlinScenario.java

I hope this is enough to get you started. Have fun!