MatsimIntermodalWriter

The MatsimIntermodalWriter class instance can be created via the IntermodalConverter. It provides the functionality to persist an (intermodal) network with partial public transport support (transfer zones, connectoids) in the MATSim format.

Using this intermodal writer the outputs can be used to perform a MATSim simulation with simulated private modes (car) as well as adding teleported public transport modes (where trips between transfer points, e.g. stops, platforms, etc., are conducted by as-the-crow-flies teleportation with a fixed speed without utilising the underlying network)

All configuration of this writer is performed via its .settings property, providing access to the MatsimIntermodalWriterSettings.

Defaults in MATSim Intermodal Writer

The MATSim intermodal writer relies on defaults whenever no explicit user setting is provided. The defaults regarding the network infrastructure follow the MatsimNetworkWriter Defaults. Defaults specific to the intermodal aspects of this writer, i.e., transfer zones, connectoids representing the public transport infrastructure can be found in the description of the MatsimZoningWriterSettings methods.

If, after reading the documentation, you are still unsure what defaults are adopted, have a look at the generated logs when using the reader. PLANit will log the majority of the adopted defaults in its output when performing the MATSim intermodal network writing.

Minimum configuration requirements

The user is required to explicitly configure at least the following settings on a MatsimIntermodalWriter:

• set an output directory via .settings.set_output_directory(+)

Methods

N/A

Properties

This class exposes the following properties:

Example 1 - Minimum required settings

from planit import *

# create a network converter
planit_instance = Planit()
intermodal_converter = planit_instance.converter_factory.create(ConverterType.INTERMODAL)

# Open Street Map (OSM) intermodal reader        
osm_reader = intermodal_converter .create_reader(IntermodalReaderType.OSM, "<country_name>")
osm_reader.settings.set_input_file("<path_to_input_file>")

# MATSIM intermodal writer
matsim_writer = intermodal_converter.create_writer(IntermodalWriterType.MATSIM)
matsim_writer.settings.set_output_directory("<path_to_output_dir>")

# perform conversion
intermodal_converter.convert(osm_reader,matsim_writer)

See also

MatsimIntermodalWriterSettings for configuration of the MATSim intermodal writer
ConverterFactory for the converter factory to create other types of converters
IntermodalReaderType for the supported intermodal reader types
IntermodalWriterType for the supported intermodal writer types
MatsimNetworkWriter defaults detailing MATSim network writer defaults

Source code

Class MatsimIntermodalWriterWrapper in converterwrappers.py