Merge branch 'master' into analysis_blocked_road

matsim-scenarios · Oct 4, 2023 · c104ed1 · c104ed1
2 parents 3126dcf + 16d313e
commit c104ed1
Show file tree

Hide file tree

Showing 42 changed files with 1,483 additions and 661 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -94,4 +94,4 @@ jobs:
           path: staging
 
     env:
-      MAVEN_OPTS: -Xmx10G
+      MAVEN_OPTS: -Xmx512m
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -17,4 +17,4 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     env:
-      MAVEN_OPTS: -Xmx10G
+      MAVEN_OPTS: -Xmx512m
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,38 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: The MATSim Open Kelheim Scenario
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Tilmann
+    family-names: Schlenther
+    email: [email protected]
+    affiliation: Technische Universität Berlin
+    orcid: 'https://orcid.org/0000-0001-6781-6918'
+  - given-names: Chengqi
+    family-names: Lu
+    email: [email protected]
+    affiliation: Technische Universität Berlin
+  - given-names: Christian
+    family-names: Rakow
+    email: [email protected]
+    affiliation: Technische Universität Berlin
+  - given-names: Simon
+    family-names: Meinhardt
+    email: [email protected]
+    affiliation: Technische Universität Berlin
+  - given-names: Kai
+    family-names: Nagel
+    email: [email protected]
+    affiliation: Technische Universität Berlin
+    orcid: 'https://orcid.org/0000-0003-2775-6898'
+url: "https://github.com/matsim-scenarios/matsim-kelheim"
+doi: 10.5281/zenodo.8322240
+date-released: 2023-09-06
+year: 2023
+version: 3.0
+license: AGPL-3.0
diff --git a/README.md b/README.md
@@ -2,14 +2,19 @@
 
 [![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)
 ![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.vsp.tu-berlin.de) of [Technische Universität Berlin](http://www.tu-berlin.de).
+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).
 
 <a rel="TU Berlin" href="https://www.vsp.tu-berlin.de"><img src="https://svn.vsp.tu-berlin.de/repos/public-svn/ueber_uns/logo/TUB_Logo.png" width="15%" height="15%"/></a>
 
@@ -24,9 +29,11 @@ The **MATSim input files, output files, analysis data and visualizations** are l
 
 **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
+The input plans (person transport demand) for this project were generated based on data provided by [Senozon AG](https://senozon.com/).
+
+### Note (where to find input and output)
 
-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/kelheim .
+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 [the public matsim-kelheim data repo](https://svn.vsp.tu-berlin.de/repos/public-svn/matsim/scenarios/countries/de/kelheim).
 
 ----
 ### Run the MATSim Kelheim scenario
@@ -42,7 +49,8 @@ It can be used by using either of these methods:
 
 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/RunKelheimScenario.java` with the following program argument `run`. Add '--1pct' for test runs with a smaller sample size.
+1. Run the JAVA class `src/main/java/org/matsim/run/RunKelheimScenario.java` with the following program argument `run`.
+   1. Add '--1pct' for test runs with a smaller sample size. Be aware that the model is calibrated with 25 pct, and outputs for 1 pct might be a little off.
 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.
 
@@ -51,8 +59,26 @@ It can be used by using either of these methods:
 
 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. 
-3. There should be a file directly in the `matsim-kelheim` directory with name approximately as `matsim-kelheim-2.x.jar`.
-4. Run this file from the command line using `java -jar matsim-kelheim-2.x.jar --help` to see all possible options.
+3. There should be a file directly in the `matsim-kelheim` directory with name approximately as `matsim-kelheim-3.x-SNAPSHOT-<commitId>.jar`.
+4. Run this file from the command line using `java -jar matsim-kelheim-3.x-SNAPSHOT-<commitId>.jar --help` to see all possible options.
   1. For example, one can disable lanes or run smaller sample sizes using the available options
-5. Start this scenario using the default config by running `java -jar matsim-kelheim-2.x.jar`.
-6. "Open" the output directory.  You can drag files into VIA as was already done above.
+5. Start this scenario using the default config by running `java -jar matsim-kelheim-3.x-SNAPSHOT-<commitId>.jar`.
+   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.
+
+----
+### Results and analysis
+
+Here are the most common ways to analyse and visualize the results (and inputs):
+
+1. [Simunto VIA](https://www.simunto.com/via/)
+2. [SimWrapper](https://www.vsp.berlin/simwrapper) 
+   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)
+
+If you have questions, feel free to contact us [(VSP)](https://www.tu.berlin/vsp) any time  :)
+
diff --git a/input/shp/dilutionArea.cpg b/input/shp/dilutionArea.cpg
@@ -0,0 +1 @@
+UTF-8
diff --git a/input/shp/dilutionArea.dbf b/input/shp/dilutionArea.dbf
diff --git a/input/shp/dilutionArea.fix b/input/shp/dilutionArea.fix
diff --git a/input/shp/dilutionArea.prj b/input/shp/dilutionArea.prj
@@ -0,0 +1 @@
+PROJCS["ETRS_1989_UTM_Zone_32N",GEOGCS["GCS_ETRS_1989",DATUM["D_ETRS_1989",SPHEROID["GRS_1980",6378137.0,298.257222101]],PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]],PROJECTION["Transverse_Mercator"],PARAMETER["False_Easting",500000.0],PARAMETER["False_Northing",0.0],PARAMETER["Central_Meridian",9.0],PARAMETER["Scale_Factor",0.9996],PARAMETER["Latitude_Of_Origin",0.0],UNIT["Meter",1.0]]
diff --git a/input/shp/dilutionArea.qmd b/input/shp/dilutionArea.qmd
@@ -0,0 +1,27 @@
+<!DOCTYPE qgis PUBLIC 'http://mrcc.com/qgis.dtd' 'SYSTEM'>
+<qgis version="3.30.2-'s-Hertogenbosch">
+  <identifier></identifier>
+  <parentidentifier></parentidentifier>
+  <language></language>
+  <type>dataset</type>
+  <title></title>
+  <abstract></abstract>
+  <links/>
+  <dates/>
+  <fees></fees>
+  <encoding></encoding>
+  <crs>
+    <spatialrefsys nativeFormat="Wkt">
+      <wkt></wkt>
+      <proj4></proj4>
+      <srsid>0</srsid>
+      <srid>0</srid>
+      <authid></authid>
+      <description></description>
+      <projectionacronym></projectionacronym>
+      <ellipsoidacronym></ellipsoidacronym>
+      <geographicflag>false</geographicflag>
+    </spatialrefsys>
+  </crs>
+  <extent/>
+</qgis>
diff --git a/input/shp/dilutionArea.shp b/input/shp/dilutionArea.shp
diff --git a/input/shp/dilutionArea.shx b/input/shp/dilutionArea.shx
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		PROJCS["ETRS_1989_UTM_Zone_32N",GEOGCS["GCS_ETRS_1989",DATUM["D_ETRS_1989",SPHEROID["GRS_1980",6378137.0,298.257222101]],PRIMEM["Greenwich",0.0],UNIT["Degree",0.0174532925199433]],PROJECTION["Transverse_Mercator"],PARAMETER["False_Easting",500000.0],PARAMETER["False_Northing",0.0],PARAMETER["Central_Meridian",9.0],PARAMETER["Scale_Factor",0.9996],PARAMETER["Latitude_Of_Origin",0.0],UNIT["Meter",1.0]]