.set(+)
Initial Cost method
Initial Cost
Initial Cost implementation
Description
Reference documentation for the initial cost configuration. Initial costs can be configured across all available time periods, or specifically tied to a time period. PLANit will utilise the most specific initial costs available, meaning that it will first look for
- Initial costs for the current time period, these have the highest priority
If not available, PLANit will look for initial costs defined without a time period label;
- Generic initial costs for all time periods (if any), these are of secondary priority
If those are also not available, PLANit will not attempt to impose any initial costs at all.
Currently initial costs can only be provided on the link segment level.
Link Segment initial costs
PLANit-Python accepts earlier persisted link segment results as initial cost inputs. The only requirements are:
OutputProperty.LINK_COSTmust have been activated, i.e., the cost column is present in the results- Valid link segment identification method, i.e., each result row must be uniquely identifiable as a link segment
Supported Data formats
Initial costs can be parsed from output generated by the following output formatters:
Defaults
No defaults (yet)
Methods
Initial Costs exposes the following methods
| Name | Description |
|---|---|
.set(+) |
Set initial costs, by time period, or across time periods |
Properties
This class has no properties (yet):
Example 1
from planit import *
#create instance
planit_instance = PLANit()
#set initial costs for all periods
planit_instance.initial_costs.set("<path_to_initial_costs_csv>")
#override initial costs for time period 1 with more specific costs
planit_instance.initial_costs.set("<path_to_initial_costs_period_1_csv>", 1)
See also
Default Output Formatter implementation
link Output Configuration implementation
Source code
Class InitialCost in Initial_cost.py