This repository contains an epidemic simulation based on MATSim, provided by the Transport Systems Planning and Transport Telematics group of Technische Universität Berlin.

Dissemination of some scenarios and results produced with the methods in this repository can be found at https://matsim-vsp.github.io/covid-sim/.

In order perform an epidemic simulation you first need an MATSim events file. To get started you can also use a provided event file from the OpenBerlin Scenario.

It is best to run the scenarios with your IDE from the org.matsim.run package. In org.matsim.run.modules you can find example scenarios that you may adapt or use to create your own configuration.

To run them you can create a standalone jar file with:

mvn package

and run it with (where OpenBerlinScenario is the name of the scenario you want to run):

java -jar matsim-episim-1.0-SNAPSHOT.jar --modules OpenBerlinScenario

If you have a MATSim scenario you can also create your own event file to be used for an epidemic simulation. All that is needed is the population and the event file of one iteration.

Run DownSampleScenario to extract the necessary information:

java -jar matsim-episim-1.0-SNAPSHOT.jar scenarioCreation downSample 0.1 \
    --population <Path to plans.xml> --events <Path to events.xml>

This example will write a 10% sample into output that can be used in the subsequent steps.

The MATSim program code in this repository is distributed under the terms of the GNU Affero General Public License. The MATSim program code are files that reside in the src directory hierarchy and typically end with *.java.

The MATSim input files, output files, analysis data and visualizations are licensed under a Creative Commons Attribution 4.0 International License.
MATSim input files are those that are used as input to run MATSim. They often, but not always, have a header pointing to matsim.org. They typically reside in the scenarios directory hierarchy. MATSim output files, analysis data, and visualizations are files generated by MATSim runs, or by postprocessing. They typically reside in a directory hierarchy starting with output.

Other data files, in particular in original-input-data, have their own individual licenses that need to be individually clarified with the copyright holders.

For more information about the methodology and preliminary results, see VSP working paper https://dx.doi.org/10.14279/depositonce-9835 .

For more information about MATSim, see here: https://www.matsim.org/.