diff --git a/README.md b/README.md index 734b249..2072327 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,18 @@ [![Build Status](https://github.com/matsim-scenarios/matsim-kelheim/actions/workflows/build.yaml/badge.svg)](https://github.com/matsim-scenarios/matsim-kelheim/actions/workflows/build.yaml) ![license](https://img.shields.io/github/license/matsim-scenarios/matsim-kelheim.svg) [![DOI (v3.0)](https://zenodo.org/badge/360167859.svg)](https://zenodo.org/badge/latestdoi/360167859) +[![DOI (v3.1.1)](https://zenodo.org/badge/DOI/10.5281/zenodo.13132756.svg)](https://doi.org/10.5281/zenodo.13132756) ![JDK](https://img.shields.io/badge/JDK-17+-green.svg) ![Kelheim MATSim network and agents](visualization-kelheim.png "Kelheim MATSim network and agents") - - - - ### About this project This repository provides an open MATSim transport model for Kelheim, provided by the [Transport Systems Planning and Transport Telematics group](https://www.tu.berlin/vsp) of [Technische Universität Berlin](http://www.tu-berlin.de). +It is developed as part of the [KelRide](https://kelride.com/) project and thus funded by the [German Federal Minstery for Digital and Transport](https://bmdv.bund.de/DE/Home/home.html). - + This scenario contains a 25pct sample of Kelheim 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. @@ -58,7 +56,7 @@ It can be used by using either of these methods: (Requires either cloning or downloading the repository and java) 1. Open the cmd and go to your project directory -2. Build the scenario using `mvnw package`. Add the option `-Dskiptests=true` in order to skip tests and speed up the process. +2. Build the scenario using `./mvnw package`. Add the option `-DskipTests=true` in order to skip tests and speed up the process. 3. There should be a file directly in the `matsim-kelheim` directory with name approximately as `matsim-kelheim-3.x-SNAPSHOT-.jar`. 4. Run this file from the command line using `java -jar matsim-kelheim-3.x-SNAPSHOT-.jar --help` to see all possible options. 1. For example, one can disable lanes or run smaller sample sizes using the available options @@ -66,7 +64,7 @@ It can be used by using either of these methods: 1. If you want to run the scenario somewhere else, e.g. on a computation cluster, make sure to not only copy the jar but also the 'input' directory and put it right next to the jar. 6. "Open" the output directory. 1. You can drag files into VIA as was already done above. - 2. You can also browse the output directory on vsp.berlin/simwrapper and analyze some of your results with interactive dashboards. + 2. You can also browse the output directory on vsp.berlin/simwrapper and analyse some of your results with interactive dashboards. ---- ### Results and analysis @@ -78,7 +76,7 @@ Here are the most common ways to analyse and visualize the results (and inputs): 1. (use Google for the best experience) 2. Browse your local output directory or [the public matsim-kelheim data repo](https://vsp.berlin/simwrapper/public/de/kelheim) 2. Explore and create many interactive visualisations and dashboards -3. Analysis the output .csv tables using the R language and [the matsim-r package](https://github.com/matsim-vsp/matsim-r) +3. Analyse the output .csv tables using the R language and [the matsim-r package](https://github.com/matsim-vsp/matsim-r) If you have questions, feel free to contact us [(VSP)](https://www.tu.berlin/vsp) any time :) @@ -86,6 +84,7 @@ If you have questions, feel free to contact us [(VSP)](https://www.tu.berlin/vsp ## More information For more information about MATSim, see here: https://www.matsim.org/ + ## Internal documentation Internal documentation can be found here: