.initial_costs

Description

The .initial_costs property allows you access to the initial costs configuration instance.

The benefit of using initial costs is to provide (link segment) generalised costs to be used for the traffic assignment’s first iteration’s path choice or shortest path calculation. By doing so you no longer have to revert to - for example - free flow travel times which are generally considered inaccurate in all but the most simplistic applications. Instead, a more representative cost is adopted, obtained from any data source (earlier simulation run, real-world data sources, etc.).

This more representative cost ideally results in quicker convergence and/or more realistic results in earlier iterations than otherwise would be the case.

Initial costs can be provided for a specific time period, or for all time periods at once, depending on the user’s available data resources or preferences.

Return type

Class InitialCost instance

Example 1

from planit import *

# Create instance and access in-memory network instance
planit_instance = Planit()
planit_instance.project.initial_costs.set("<path_to_initial_costs>")

See also

InitialCost implementation of the initial cost class

Source code

Class PlanitProject in project.py