utdf2gmns.func_lib.read_UTDF

utdf2gmns.func_lib.read_UTDF(path_utdf: str) → dict[source]

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

Parameters:: path_utdf (str) – path to the utdf.csv file

Example

>>> import utdf2gmns as ug
>>> path_utdf = "your utdf file, in csv format"
>>> utdf_dict = ug.read_UTDF(path_utdf)
>>> utdf_dict.keys()
dict_keys(['Network', 'Nodes', 'Links', 'Lanes', 'Timeplans', 'Phases', 'phase_timeplans'])

Returns:: a dictionary of dataframes with keys are Network, Nodes, Links, Lanes, Timeplans, Phases
Return type:: dict