Contents

Use MATSim as a programmer out of an IDE.

Use the MATSim GUI.

Use MATSim as a maven plugin.

About releases.

Benchmark.

 

Use MATSim as a programmer out of an IDE

This approach targets programmers who are comfortable with Java and an IDE (e.g. Eclipse or IntelliJ). This will automatically download MATSim, allow you to browse the source code, and keep you up-to-date with releases or snapshots.

You will not be able to modify the existing MATSim source code – which, in most cases, should not be necessary. It is preferred that you contact the developers in such situations and we will try to help or implement missing extension points.

  1. (optional but recommended) Fork matsim-example-project.
  2. Clone matsim-example-project into local directory.
  3. Import as maven project into IDE.
    1. IntelliJ: Import project –> browse to dir –> maven –> Next, Next, Next
    2. Eclipse: Import … –> … as maven project –> browse to dir –> accept, accept, accept

    Maven will sort out the dependencies. No need to download the MATSim main repository. Sources are available.

  4. Run MATSimGUI .
    1. An example config file is in scenarios/equil.
    2. Press Run to run MATSim.
  5. Run RunMATSim directly from the IDE.
  6. (optional but recommended) Connect your forked repo to travis.

Code examples are in matsim-code-examples on github.

 

Use the MATSim GUI

The “Standalone” version is targeted to users who want to use MATSim by editing the input files, including config.xml directly. A basic GUI is provided.

Latest Stable Release

Version 0.10.1 “Summer 2018”, released August 2018

Development Version

These versions are typically less stable and don’t come with up-to-date documenation, but may contain new features.

 

Use MATSim as a maven plugin

The “Maven” version is targeted to programmers who know about Maven, and want to include MATSim into an already existing Maven project. Similar to the “MATSim example project” above, the Maven approach will maven-download MATSim, allow you to browse the source code, and keep you up-to-date with releases or snapshots (depending on your pom.xml).

It will not allow you to modify the existing MATSim code – which, in most cases, also should not be necessary: it is preferred that you contact the developers in such situations and we will try to help or implement missing extension points.

(Pre-)Release

<repositories>
  <repository>
    <id>matsim</id>
    <name>MATSim release repository</name>
    <url>http://dl.bintray.com/matsim/matsim</url>



  </repository>
</repositories>
<dependencies>
  <dependency>
    <groupId>org.matsim</groupId>
    <artifactId>matsim</artifactId>
    <version>11.0</version>
  </dependency>
</dependencies>

The example project on GitHub contains a valid pom.xml.

Extensions can be added in the same way; see the pom.xml in the code examples on GitHub

Automatic snapshot of development version

<repositories>
  <repository>
    <id>ojo-snapshots</id>
    <name>MATSim snapshot repository</name>
    <url>http://oss.jfrog.org/libs-snapshot</url>
    <snapshots>
      <enabled>true</enabled>
    </snapshots>
  </repository>
</repositories>
<dependencies>
  <dependency>
    <groupId>org.matsim</groupId>
    <artifactId>matsim</artifactId>
    <version>12.0-SNAPSHOT</version>
  </dependency>
</dependencies>

These versions are typically less stable and don’t come with up-to-date documenation, but may contain new features.

 

About releases

We normally release together with our summer term class taught at TU Berlin:

  1. A pre-release in march/april.
  2. Possible bugfix versions while the class is running.
  3. In june/july, the last bugfix version becomes the stable release.

In consequence, the “latest (pre-)release” may be more modern than the “latest stable release”.

 

  Benchmark

Download Benchmark ZIP, ca. 35MB

More information about the MATSim Benchmark.