diff --git a/README.md b/README.md index b7175d68..a68c4e78 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ This repository provides an open MATSim transport model for Berlin, provided by Currently, there are multiple versions of the MATSim Open Berlin model: -### 25pct scenario (`input/v6.0`) +### 10pct scenario (`input/v6.0`) This scenario contains a 25pct sample of the Greater Berlin population; road capacities are accordingly reduced. The scenario is calibrated taking into consideration the traffic counts, modal split and mode-specific trip distance distributions. @@ -34,12 +34,12 @@ Handling of large files within git is not without problems (git lfs files are no ---- ## Simple things (without installing/running MATSim) -### Movies +### Use SimWrapper dashboards -1. Go to https://svn.vsp.tu-berlin.de/repos/public-svn/matsim/scenarios/countries/de/berlin/ -1. Decide for a scenario that you find interesting (e.g. `berlin-v6.0`) and go into that directory. -1. Inside there, look for an `output-*` directory that you find interesting and go into that directory. -1. Inside there, look for `movie-*` files. You can't watch them directly, but there are various ways to download them. You can watch them then. Try that. +1. Open SimWrapper at https://simwrapper.github.io/site/ . +1. Select Explore Data Sources -> VSP Public-SVN . +1. Navigate to de -> berlin -> berlin-v6.0 (https://simwrapper.github.io/site/public/de/berlin/berlin-v6.0). +1. Enjoy the dashboards and visualizations. ### Run VIA on output files @@ -80,17 +80,16 @@ This will update your repository to the newest version. ---- ## Run the MATSim Berlin scenario ... + +(Requires either cloning or downloading the repository.) +

... using a runnable jar file

-
-(Requires either cloning or downloading the repository.) + -1. Depending on the version of matsim-berlin you have selected, you might have to create the jar file yourself. - 1. **For version v5.4 or earlier:**
- There should be a file directly in the `matsim-berlin` directory with name approximately as `matsim-berlin-5.x-jar-with-dependencies.jar`. - 1. **For version v5.5 or later:**
- You can build an executable jar-file by executing one of the following commands in the top directory. +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` @@ -110,7 +109,6 @@ java -jar [FILENAME].jar

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

-(Requires either cloning or downloading the repository.) 1. Set up the project in your IDE. 1. Make sure the project is configured as maven project. @@ -118,49 +116,10 @@ java -jar [FILENAME].jar 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.
-
-

... using an IDE, e.g. Eclipse, IntelliJ - Alternative 2: use matsim-berlin as a maven dependency

- -1. Clone the matsim-example-project: https://github.com/matsim-org/matsim-example-project -2. Add a maven dependency to the open berlin project by writing the following to the pom file: - -```xml - - jitpack.io - https://jitpack.io - -``` - -```xml - - com.github.matsim-scenarios - matsim-berlin - 5.6 - -``` - -3. Write your own run class and make sure to execute the required public methods in RunBerlinScenario: - -``` -Config config = RunBerlinScenario.prepareConfig( args ) ; -// possibly modify config here - -Scenario scenario = RunBerlinScenario.prepareScenario( config ) ; -// possibly modify scenario here - -Controler controler = RunBerlinScenario.prepareControler( scenario ) ; -// possibly modify controler here, e.g. add your own module - -controler.run - -``` -
--- ## More information -For more information about the scenario generation, see VSP working paper # 19-01 under https://www.vsp.tu-berlin.de/publications/vspwp . - For more information about MATSim, see here: https://www.matsim.org/ ## Internal documentation diff --git a/input/v6.0/berlin-v6.0.config.xml b/input/v6.0/berlin-v6.0.config.xml index 6091e633..162aa48e 100644 --- a/input/v6.0/berlin-v6.0.config.xml +++ b/input/v6.0/berlin-v6.0.config.xml @@ -8,7 +8,7 @@ - + @@ -54,8 +54,8 @@ - - + + @@ -86,7 +86,7 @@ - + diff --git a/pom.xml b/pom.xml index aa2be0cd..e6b59f6e 100644 --- a/pom.xml +++ b/pom.xml @@ -348,7 +348,7 @@ shade - ${project.basedir}/${project.build.finalName}.jar + ${project.basedir}/${project.build.finalName}-${git.commit.id.describe-short}.jar