Confusing find_path_for_agents( )

[asu-trans-ai-lab]

The input to network.find_path_for_agents() is not clear. Consider adding the input_demand_file field.

I think this function is finding shortest path between each OD pair (from o_zone_id to d_zone_id) based on demand.csv rather than shortest paths from o_node_id to d_node_id. This is a source of confusion.

[jdlph]

We will deprecate this function, which leads to a lot of confusion, in a later release. The functionality of finding shortest path between each OD pair can be equivalently done through perform_column_generation() by setting column_gen_num as 1 and column_update_num as 0. The full sample code can be found below.

import path4gmns as pg

network = pg.read_network()
pg.read_zones(network)
pg.load_demand(network)

column_gen_num = 1
column_update_num = 0

pg.perform_column_generation(column_gen_num, column_update_num, network)

pg.output_columns(network)
pg.output_link_performance(network)

[jdlph]

find_path_for_agents( ) is officially deprecated under v0.9.3.