Metadata-Version: 1.0
Name: osm2gmns
Version: 0.0.5
Summary: build network with gmns format using .osm file from openstreetmap
Home-page: https://github.com/jiawei92/OSM2GMNS
Author: Jiawei Lu, Xuesong Zhou
Author-email: jiaweil9@asu.edu, xzhou74@asu.edu
License: UNKNOWN
Description: OSM2GMNS
        ========
        
        OSM2GMNS is an open-source python package which can help users easily convert networks 
        from `OpenStreetMap <https://www.openstreetmap.org/>`_ to .csv files with 
        standard `GMNS <https://github.com/zephyr-data-specs/GMNS>`_ format for visualization, 
        traffic simulation and planning purpose.
        
        Install
        -------
        
        Install OSM2GMNS via pip::
        
            $ pip install osm2gmns
        
        Simple example
        --------------
        
        Get network from map.osm file and consolidate complex intersections
        
        .. code:: python
        
            >>> import networkx as nx
            >>> net = og.getNetFromOSMFile('map.osm')
            >>> og.outputNetToCSV(net)
            # check and modify (if necessary) network files before complex intersection consolidation
            >>> net = og.getNetFromCSV()
            >>> og.consolidateComplexIntersections(net)
            >>> og.outputNetToCSV(net, output_folder='consolidated')
        
        Visualization
        -------------
        
        You can visualize generated networks using `NeXTA <https://github.com/xzhou99/NeXTA-GMNS>`_ 
        or `QGis <https://qgis.org/>`_.
        
Platform: UNKNOWN
