Job Templates

Table of contents

Create a new Job Template for a fixed MATSim version
Create a new Job Template to execute arbitrary Jar-Files

Job Templates describe what versions of MATSim are available to users to run simulations, including customized versions that use specific MATSim contribs.

A job template consists of one or multiple files (e.g. jar-files) and a command to be executed (e.g. something like java -jar matsim.jar config.xml)

Create a new Job Template for a fixed MATSim version

You need to have administrator permissions to create a new Job Template.

Click on “Settings” in the left navigation bar, then click on “Job Templates”.
You will see the list of existing job templates.
Click on “Add Job Template”.
Provide a name for your job template

If you want to provide a job template for a standard MATSim version:

Select the proper MATSim version
Select the MATSim-Tramola integration matching your MATSim version
Select “MATSim with Tramola-integration” as a command and make sure the right versions are mentioned in the command.

If you want to provide a job template for a customized MATSim version:

Create a release of your customized MATSim version. If it consists of multiple files, it is easiest if you create a zip-file containing all the files.
Do not select any Tramola-integration library. This should be included in your custom MATSim release (see Integrating Tramola on how to achieve it).
Enter a proper command to be executed, make sure to get the jar-filename or the name of the main-class to be used correct. You can make use of placeholders to support customization by users, e.g. the amount of memory to be used ($Xmx) or the name of the config-file ($CONFIG).

Create a new Job Template to execute arbitrary Jar-Files

Instead of providing job templates for a specific MATSim release, it is possible to allow regular users to upload their own jar-files as part of a scenario and use this to run simulations.

Be aware of the security implications if you allow users to upload custom jar-files to be used to execute runs. You essentially allow them to run arbitrary code on your server(s). Check the administrative guide on setting up runners for more details.

To set up a job template that allows executing arbitrary jar-files, follow these steps. Please note that you also need to set up a runner that supports executing arbitrary jar-files.

Click on “Settings” in the left navigation bar, then click on “Job Templates”.
You will see the list of existing job templates.
Click on “Add Job Template”.
Provide a name for your job template
==TODO==