Metadata-Version: 2.1
Name: net2cell
Version: 0.1.1
Summary: automatically build hybrid transportation networks
Home-page: https://github.com/jiawei92/net2cell
Author: Jiawei Lu, Xuesong Zhou
Author-email: jiaweil9@asu.edu, xzhou74@asu.edu
License: GPLv3+
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Requires-Dist: pandas (>=0.24.0)

NET2CELL
========

For any given networks that meet the `GMNS`_ standard, net2cell helps users automatically build
mesoscopic and lane-by-lane cell-based microscopic transportation networks to accommdate different
modelling needs. For a quick start, users are recommended to use `osm2gmns`_ to quickly
get a macroscopic from `OpenStreetMap`_ (OSM). osm2gmns helps users easily convert the OSM map data
to node and link network files in the GMNS format.

Installation
------------

.. code-block:: bash

    pip install net2cell


Simple example
--------------

Get hybrid networks

.. code:: python

    >>> import net2cell as nc

    >>> macro_net = nc.readMacroNet()
    >>> nc.generateHybridNets(macro_net)


Visualization
-------------

You can visualize generated networks using `NeXTA`_ or `QGis`_.


.. _`GMNS`: https://github.com/zephyr-data-specs/GMNS
.. _`OpenStreetMap`: https://www.openstreetmap.org
.. _`osm2gmns`: https://osm2gmns.readthedocs.io/
.. _`NeXTA`: https://github.com/xzhou99/NeXTA-GMNS
.. _`QGis`: https://qgis.org

