vissim2gmns.func_lib.vissim_inpx

vissim2gmns.func_lib.vissim_inpx(path_vissim_inpx: str, output_dir: str = '', **kwargs) → dict[source]

Convert vissim inpx file to geopandas dataframe.

Parameters:

  • path_vissim_inpx (str) – the path to the vissim inpx file.

  • output_dir (str) – the directory to save the output files. Defaults to “”.

  • **kwargs – other parameters for the conversion, such as isShp, isGeojson, isCsv.

Notes

  • output_dir: if not provide no data will be saved.

  • isShp: whether to save the output as shapefile. Default is False.

  • isGeojson: whether to save the output as geojson. Default is True.

  • isCsv: whether to save the output as csv. Default is True.

Example

>>> import vissim2gmns as vg
>>> path_vissim_inpx = "path/to/vissim.inpx"
>>> output_dir = "path/to/output"
>>> # get the inpx data as a dictionary without saving any output files
>>> inpx_dict = vg.vissim_inpx(path_vissim_inpx)
>>>
>>> # get the inpx data and save csv and geojson files (default) to the output_dir.
>>> inpx_dict = vg.vissim_inpx(path_vissim_inpx, output_dir=output_dir)
>>>
>>> # get the inpx data and control the output file format by setting isShp, isGeojson and isCsv parameters.
>>> inpx_dict = vg.vissim_inpx(path_vissim_inpx, output_dir=output_dir, isShp=True, isGeojson=True, isCsv=True)
Returns:

the inpx data as a dictionary.

Return type:

dict