The MATSim Open Hamburg Scenario

About this project

This repository provides an open MATSim transport model for Hamburg, provided by the Transport Systems Planning and Transport Telematics group of Technische Universität Berlin.

Licenses

The MATSim program code in this repository is distributed under the terms of the GNU General Public License as published by the Free Software Foundation (version 2). 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 Non-Commercial 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.

Note

Handling of large files within git is not without problems (git lfs files are not included in the zip download; we have to pay; ...). In consequence, large files, both on the input and on the output side, reside at https://svn.vsp.tu-berlin.de/repos/public-svn/matsim/scenarios/countries/de/hamburg .

---

Simple things (without installing/running MATSim)

Run VIA on output files

1. Get VIA from https://www.simunto.com/via/. (There is a free license for a small number of agents; that will probably work but only display a small number of vehicles/agents.)
2. Go to https://svn.vsp.tu-berlin.de/repos/public-svn/matsim/scenarios/countries/de/hamburg/hamburg-v3/v3.0/output.
3. Inside there, decide for a scenario that you find interesting (e.g. baseCase) and go into that directory. look for an output-* directory that you find interesting and go into that directory.
4. Download *.output_network.xml.gz and *.output_events.xml.gz. Best make sure that they do not uncompress, e.g. by "Download linked file as ...". Note that for v3.0, these files are only provided for the baseCase.
5. Get these files into VIA. This can be achieved in various ways; one is to open VIA and then drag the files from a file browser into VIA.
6. Run VIA and enjoy.
7. You can also visit SimWrapper, an interactive visualisation platform. See https://vsp.berlin/simwrapper/public/de/hamburg/hamburg-v2/hamburg-v2.2/viz. Note that this corresponds to an older version of the model.

Downloading the repository alternative 1: Download ZIP

1. Click on Clone or download and then on Download ZIP.
2. Unzip the repository.
3. Go to "Run the scenario" below.

Downloading the repository alternative 2: Clone the repository

Initial stuff (needs to be done once)

1. Install git for the command line.
2. Type git clone https://github.com/matsim-scenarios/matsim-hamburg.git in the command line.

(Or use your IDE, e.g. Eclipse, IntelliJ, to clone the repository.)

This will result in a new matsim-hamburg directory. Memorize where you have put it. You can move it, as a whole, to some other place.

Update your local clone of the repository.

1. Go into the matsim-hamburg directory.
2. Type git pull

(Or use your IDE, e.g. Eclipse, IntelliJ, to update the repository.)

This will update your repository to the newest version.

Run the scenario

(Requires either cloning or downloading the repository.)

... using a runnable jar file (only available for releases)

1. You can build an executable jar-file by executing one of the following commands in the top directory. This will download all necessary dependencies (it might take a while the first time it is run) and dump the jar into the top directory.

   1. ./mvnw clean package -DskipTests=true
   2. or on Windows: mvnw.cmd clean package -DskipTests=true

2. Double-click on that .jar file (in a file system browser). Alternatively, try opening it with the following command:java -jar [FILENAME].jar

3. In the GUI, click on the "Choose" button for configuration file. Navigate to one of the scenario directories and load one of the configuration files.

4. Increase memory in the GUI.

5. Press the "Start MATSim" button. This should run MATSim. Note that MATSim accepts URLs as filenames in its config, so while the config files are part of the git repo, running them will pull additional material from our server.

6. "Open" the output directory. You can drag files into VIA as was already done above.

7. "Edit..." (in the GUI) the config file. Re-run MATSim.

... using an IDE, e.g. Eclipse, IntelliJ

1. Set up the project in your IDE.
2. Make sure the project is configured as maven project.
3. Run the JAVA class src/main/java/org/matsim/run/RunBaseCaseHamburgScenario.java or src/main/java/org/matsim/gui/MATSimGUI.java.
4. "Open" the output directory. You can drag files into VIA as was already done above.
5. Edit the config file or adjust the run class. Re-run MATSim.

More information

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

Acknowledgements

The travel demand data for the area of Hamburg is provided by Senozon Deutschland GmbH (https://senozon.com).

Internal documentation

Internal documentation can be found here: https://docs.google.com/document/d/14xNeAjfJEFKVPU66dkOO6UJdgtQ7V-evsy3W8QLTRqQ/edit#heading=h.duf90oovpyz5