/emissions-analysis

MATSim air pollution emission analysis based on HBEFA

Primary LanguageJavaGNU General Public License v2.0GPL-2.0

MATSim air pollution emission analysis based on HBEFA

About this project

This repository provides a tool to compute air pollution emissions based on HBEFA (https://www.hbefa.net/) emission factors and simulated traffic with MATSim (https://www.matsim.org). The tool was tested with the MATSim Open Berlin model (release v5.4) which is provided here: https://github.com/matsim-scenarios/matsim-berlin.

Currently, there are two versions of the MATSim Open Berlin model:

10pct scenario (scenarios/berlin-v5.x-10pct)

This scenario contains a 10pct 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.

1pct scenario (scenarios/berlin-v5.x-1pct)

This scenario contains a 1pct sample of the Greater Berlin population; road capacities are accordingly reduced. This scenario was not (!) calibrated and should only be used for testing purposes or pre-studies.

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 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/de/berlin .


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 analysis" 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/ikaddoura/emissions-analysis.git in the command line.

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

This will result in a new emissions-analysis 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 emissions-analysis 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 analysis

... using a runnable jar file

(Requires either cloning or downloading the repository.)

  1. There should be a jar file directly in the emissions-analysis directory (*.jar).
  2. Double-click on that file (in a file system browser). A simple GUI should open.
  3. In the GUI, click on the "Choose" button for configuration file. Navigate to the scenarios directory and load a configuration file.
  4. Increase memory in the GUI.
  5. Press the "Start MATSim" button. This should run the MATSim anaylsis. 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 - Alternative 1: use cloned/downloaded matsim-berlin repository

(Requires either cloning or downloading the repository.)

  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/analysis/RunOfflineAirPollutionAnalysis.java or src/main/java/org/matsim/gui/RunGUI.java.
  4. "Open" the output directory.
  5. Edit the config file or adjust the run class. Re-run the analysis.

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