Documentation

 

Mailing lists

We also provide different mailing lists according to the level of involvement (user, api-user, developer) to query and discuss different topics of using MATSim.

To the mailing lists

If you are new to MATSim, we suggest that you have a look at the tutorials, especially at the "in 8 lessons" tutorial. It will teach you the basics of MATSim and give you an introduction to the code. After that, there are the following options:

  • Use matsim as a "user". For this, you need to prepare scenario data, modify the config file, and interpret matsim output. Look under "user's guide".
  • Develop code using the matsim api. This means that you program, but your calls to matsim are restricted to "stable" calls to the matsim api. This is particularly interesting to people who want to use some matsim infrastructure for initial demand generation, but it may also be useful for people writing "modules" such as alternative mobility simulations or alternative behavioral modules.
  • Develop code as a matsim developer. Since we do frequent refactorings of matsim, for this you need to be made part of the matsim repository. Please talk to us.

 

User's Guide

Fri, 2008-07-18 23:15 — matsim

The "tutorial" section contains "reduced" information about how to find your way into matsim.

This "user's guide" section contains additional information, concentrating on features and details that are not explained in the tutorials.  Clearly, there may be overlap.

API-User's Guide

Wed, 2009-07-15 17:28 — matsim

Information relevant to API-Users.  Relevant for people who want to program against MATSim without being part of the regular refactorings.

Developer's Guide

Wed, 2006-11-01 15:24 — matsim

The developer guide

  • provides specification of key-aspects of MATSim (e.g. file formats, simulation events, ...)
  • lists some guidelines for developers (e.g. coding conventions) to keep MATSim maintainable.
  • gives information about certain packages, how to (programmatically) use them and what features they offer.
  • offers additional pieces of information that may/should be of interest to developers (e.g. how to use Eclipse for development, or some Java-tips)

Choose a topic of interest to read more:

Tutorials

Extensions

MATSim can be extended with additional functionality. Have a look at the available extensions and learn how to use them.

FAQ

Have a look at frequently asked questions, and their answers.

Optimization / Benchmarks

Wed, 2009-06-03 11:12 — matsim

A collection of benchmark results and findings regarding code optimization.

User Meetings and Tutorials

Mon, 2010-07-26 07:55 — anhorni

Here you can find information and documenation from the annual MATSim user meeting and MATSim tutorials. The user meeting and a preceding overview tutorial takes place annually, alternatingly in Zurich and Berlin. Special tutorials are held upon request.

© 2012 matsim.org - Login