From 77676e630f7d0cbb783491cc9537202424402f58 Mon Sep 17 00:00:00 2001 From: Sijia Wang Date: Tue, 30 Jul 2024 12:25:02 -0400 Subject: [PATCH] update documentation --- tm2py/components/network/highway/highway_assign.py | 1 + tm2py/config.py | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/tm2py/components/network/highway/highway_assign.py b/tm2py/components/network/highway/highway_assign.py index 8e942fcb..ee699845 100644 --- a/tm2py/components/network/highway/highway_assign.py +++ b/tm2py/components/network/highway/highway_assign.py @@ -426,6 +426,7 @@ def __init__(self, class_config, time_period, iteration, warmstart): class_config (_type_): _description_ time_period (_type_): _description_ iteration (_type_): _description_ + warmstart (bool): True if assigning warmstart demand """ self.class_config = class_config self.time_period = time_period diff --git a/tm2py/config.py b/tm2py/config.py index fbddd243..b960a547 100644 --- a/tm2py/config.py +++ b/tm2py/config.py @@ -87,8 +87,9 @@ class WarmStartConfig(ConfigItem): Note that the components will be executed in the order listed. Properties: - warmstart: Boolean indicating whether warmstart demand matrices are used. If set to True, do not assign zero demand in iteration 0. - If set to False, assign zero demand in iteration 0. + warmstart: Boolean indicating whether warmstart demand matrices are used. + If set to True, the global iteration 0 will either assign warmstart demand for highway and transit, or skip the assignment and just use warmstart skims. + If set to False, the global iteration 0 will assign zero demand for highway and transit. warmstart_skim: Boolean indicating whether to use warmstart skims. If set to True, then skips warmstart assignment in iteraton 0. warmstart_demand: Boolean indicating whether to use warmstart demand. If set to True, then runs warmstart assignment in iteration 0. warmstart_check: if on, check that demand matrix files exist.