API Reference

UTDF2GMNS class

UTDF2GMNS(utdf_filename[, region_name, verbose])

UTDF2GMNS performs the data conversion from UTDF to different formats. The class includes functions such as: - geocode_utdf_intersections: geocode intersections.

Function Library: UTDF

func_lib.read_UTDF(path_utdf)

read the utdf.csv file and return a dictionary of dataframes

func_lib.cvt_lane_df_to_dict(df_lane)

Convert UTDF lane DataFrame to dictionary.

Function Library: GMNS

func_lib.cvt_utdf_to_signal_intersection(...)

Utilize sigma-X engine to process each signal intersection from Synchro UTDF file And save each signal intersection into a separate GMNS file.

func_lib.cvt_link_df_to_dict(df_link)

Reformat the UTDF link dataframe to a dictionary of links with intersection id as keys

Function Library: SUMO

func_lib.remove_sumo_U_turn(path_net)

Remove U-turns in the SUMO network.

func_lib.update_sumo_signal_from_utdf(...[, ...])

update sumo signal (.net.xml) from UTDF signal information

Visualization

func_lib.plot_net_mpl(net, *[, save_fig, ...])

Plot network

func_lib.plot_net_keplergl(net, *[, ...])

Plot network in keplergl

Utility Functions

util_lib.calculate_point2point_distance_in_km(...)

point1 and point2: a tuple of (longitude, latitude)

util_lib.time_unit_converter(value, ...[, ...])

Convert a time value between seconds, minutes, hours, days, years

util_lib.time_str_to_seconds(time_str[, ...])

Convert a time string to seconds