MatsimIntermodalWriterSettings

MatsimIntermodalWriterSettings instance

The MatsimIntermodalWriterSettings instance is accessible via the MatsimIntermodalWriter its .settings property. It allows the user to configure the MatsimIntermodalWriter. Its settings are subdivided in three categories, namely::

The network oriented settings are identical to the settings exposed by the MatsimNetworkWriter and are described in detail under MatsimNetworkWriterSettings. These settings configure everything related to the physical road and/or rail network.

The zoning (public transport) settings are additional settings for the physical infrastructure directly related to the intermodal aspect of the writer, i.e., the persistence of bus stops, train stations, platforms, etc. This information is extracted from PLANit’s intermodal zoning component, e.g., transfer zones, and connectoids (hence its categorisation under zones).

Minimum configuration requirements

All methods marked as Compulsory=YES in the Methods section are expected to be configured by the user explicitly.

Methods

A MatsimIntermodalWriterSettings instance exposes the following methods.

Name Compulsory Default Description
.set_country(+) NO Context dependent Set the country the intermodal network resides in, used to determine the coordinate reference system to apply
.set_output_directory(+) YES N/A Set the output directory to persist the MATSim output files to

Properties

This class exposes the following properties

Property Availability Description
.network_settings Always Settings specific to physical road infrastructure
.zoning_settings Always Settings specific to public transport transfer (zones) infrastructure
.pt_services_settings Always Settings specific to public transport service schedules

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

MatsimIntermodalWriter MATSim intermodal writer class these settings reside on

Source code

Class MatsimIntermodalWriterSettingsWrapper in converterwrappers.py

.network_settings

MatsimIntermodalWriterSettings property

.pt_services_settings

MatsimIntermodalWriterSettings property

.set_country(+)

MatsimIntermodalWriterSettings method

.set_output_directory(+)

MatsimIntermodalWriterSettings method

.zoning_settings

MatsimIntermodalWriterSettings property

MatsimPtServicesWriterSettings

MatsimPtServicesWriterSettings instance

MatsimZoningWriterSettings

MatsimZoningWriterSettings instance