Skip to content

Commit

Permalink
add doc for congested assign max iter
Browse files Browse the repository at this point in the history
  • Loading branch information
i-am-sijia committed Aug 26, 2024
1 parent 404b6d6 commit 788a80d
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions tm2py/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -1289,11 +1289,15 @@ class CongestedTransitMaxIteration(ConfigItem):
Properties:
time_period: time period string
max_iteration: max iteration integer
max_iteration: max iteration specific to time period. In the design of tm2py,
congested assignment is run only for AM and PM. For EA, MD, and EV, we run
extended assignment. See code here: tm2py/components/network/transit/transit_assign.py#L465-L466
Therefore, `max_iteration` here does not impact EA, MD, and EV, this setting
is only meaningful for AM and PM.
"""

time_period: str = Field(max_length=4)
max_iteration: int = Field(ge=1)
max_iteration: int = Field(ge=1, default=1)


@dataclass(frozen=True)
Expand Down

0 comments on commit 788a80d

Please sign in to comment.