Data

Tools

Indexes

Applications

Experiments

Open Source Science

matsim-kyoto

The MATSim Open Kyoto Scenario

https://github.com/matsim-scenarios/matsim-kyoto

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.5%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

The MATSim Open Kyoto Scenario

Basic Info
  • Host: GitHub
  • Owner: matsim-scenarios
  • License: agpl-3.0
  • Language: Java
  • Default Branch: main
  • Size: 4.79 MB
Statistics
  • Stars: 0
  • Watchers: 8
  • Forks: 1
  • Open Issues: 1
  • Releases: 0
Created over 1 year ago · Last pushed 10 months ago
Metadata Files
Readme License Citation

README.md

Build Status license JDK

The MATSim Open Kyoto Scenario

Kyoto MATSim network and agents

About this project

This repository provides an open MATSim transport model for Kyoto and its surrounding area (Kansai region), provided by the Transport Systems Planning and Transport Telematics group of Technische Universität Berlin.

This scenario contains a 10pct sample of Kyoto and its surrounding area; road capacities are accordingly reduced. The scenario is calibrated taking into consideration the traffic counts, modal split and mode-specific trip distance distributions.

Licenses

The MATSim program code in this repository is distributed under the terms of the GNU Affero General Public License v3.0. 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. Creative Commons 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/jp/kyoto .

Simple things (without installing MATSim)

Use SimWrapper dashboards

  1. Open SimWrapper at https://vsp.berlin/simwrapper/ .
  2. Select Explore Data Sources -> VSP Public-SVN .
  3. Navigate to jp -> kyoto -> kyoto-v1.0-10pct (https://vsp.berlin/simwrapper/public/jp/kyoto/output/kyoto-v1.0-10pct).
  4. Enjoy the dashboards and visualizations.

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/jp/kyoto/ .
  3. Decide for a scenario that you find interesting (e.g. kyoto-v1.0-10pct) and go into that directory.
  4. Inside there, look for an output-* directory that you find interesting and go into that directory.
  5. 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 ...".
  6. 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.
  7. Run VIA and enjoy.

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 MATSim Kyoto 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-kyoto.git in the command line.

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

This will result in a new matsim-kyoto 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-berlin 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 MATSim Open Kyoto scenario ...

(Requires either cloning or downloading the repository.)

... using a runnable jar file

 1. Depending on the version of matsim-berlin you have selected, you might have to create the jar file yourself. 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` 1. or on Windows: `mvnw.cmd clean package -DskipTests=true` 1. Double-click on that .jar file (in a file system browser). Alternatively, try opening it with the following command:`` java -jar [FILENAME].jar `` 1. A simple GUI should open. 1. 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. 1. Increase memory in the GUI. 1. 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. 1. "Open" the output directory. You can drag files into VIA as was already done above. 1. "Edit..." (in the GUI) the config file. Re-run MATSim.

... using an IDE, e.g. Eclipse, IntelliJ - Alternative 1: use cloned/downloaded matsim-berlin repository

 1. Set up the project in your IDE. 1. Make sure the project is configured as maven project. 1. Run the JAVA class `src/main/java/org/matsim/run/RunOpenKyotoScenario.java`. 1. "Open" the output directory. You can drag files into VIA as was already done above. 1. 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/

Internal documentation

Internal documentation can be found here: https://docs.google.com/document/d/1G7YFVciCb7DRbZ690URcixgwsVfHNOziSVhCgTbyMEo/edit#heading=h.htwasp8iamei

Owner

  • Name: matsim-scenarios
  • Login: matsim-scenarios
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
title: MATSim Scenario Template (Adjust title)
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Christian
    family-names: Rakow
    email: rakow@vsp.tu-berlin.de
    affiliation: Technische Universität Berlin
    orcid: 'https://orcid.org/0000-0003-3760-2243'
  - given-names: Surname
    family-names: Name
    email: yourmail@somewhere.com

url: "https://github.com/matsim-scenarios/matsim-scenario-template"
date-released: 2023-01-01
year: 2023
version: 1.0
license: AGPL-3.0

GitHub Events

Total
  • Member event: 2
  • Push event: 11
  • Pull request event: 1
Last Year
  • Member event: 2
  • Push event: 11
  • Pull request event: 1

Dependencies

.github/workflows/build.yaml actions
  • actions/checkout v3 composite
  • actions/setup-java v3 composite
  • actions/upload-artifact v3 composite
.github/workflows/publish.yaml actions
  • actions/checkout v3 composite
  • actions/setup-java v3 composite
pom.xml maven
  • org.matsim.contrib:application 2025.0-PR3332
  • org.matsim.contrib:simwrapper 2025.0-PR3332
  • org.matsim:matsim 2025.0-PR3332
  • org.assertj:assertj-core test
  • org.junit.jupiter:junit-jupiter test
  • org.junit.jupiter:junit-jupiter-engine test
  • org.matsim:matsim 2025.0-PR3332 test