Metadata-Version: 2.2
Name: osm2gmns
Version: 1.0.0
Summary: convert map data from OpenStreetMap to network files in GMNS format
Author-Email: Jiawei Lu <lujiaweiwk@gmail.com>, "Xuesong (Simon) Zhou" <xzhou74@asu.edu>
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Project-URL: Source Code, https://github.com/jiawlu/OSM2GMNS
Project-URL: Bug Tracker, https://github.com/jiawlu/OSM2GMNS/issues
Requires-Python: >=3.8
Description-Content-Type: text/x-rst

osm2gmns
====================================
| **Authors**: `Jiawei Lu`_, `Xuesong (Simon) Zhou`_
| **Email**: lujiaweiwk@gmail.com, xzhou74@asu.edu


osm2gmns is a high-performance Python package designed to convert `OpenStreetMap`_ (OSM) 
data into standardized transportation networks. Leveraging a C++ core wrapped in an 
intuitive Python interface, osm2gmns offers both computational speed and ease of use. 
**It empowers researchers and practitioners to generate detailed, multi-modal networks (driving, cycling, walking, railway, aeroway) for any region worldwide with minimal coding effort**.

The package outputs networks primarily in the `GMNS`_ (General Modeling Network Specification) 
format, promoting interoperability and simplifying data exchange within the transportation 
modeling community.

.. code-block:: python

    >>> import osm2gmns as og
    >>> net = og.getNetFromFile('map.osm')
    >>> og.outputNetToCSV(net)


*This v1.x version introduces significant architectural changes, performance improvements, and new features compared to* `v0.x`_, *and is not fully backward compatible*.

- *We encourage users to adopt v1.x for the latest capabilities and ongoing development*.
- *v0.x will only receive critical bug fixes moving forward*.
- *Functionality like Multi-Resolution Modeling (MRM), currently available only in v0.x, is planned for future v1.x releases*.


Citation
====================================

If osm2gmns contributes to your research, please cite the following publication:

Lu, J., & Zhou, X.S. (2023). Virtual track networks: A hierarchical modeling framework and 
open-source tools for simplified and efficient connected and automated mobility (CAM) system 
design based on general modeling network specification (GMNS). Transportation Research 
Part C: Emerging Technologies, 153, 104223. [`link`_]


User's guide
====================================

Users are referred to `user's guide`_ for a detailed introduction of osm2gmns.



.. _`Jiawei Lu`: https://www.linkedin.com/in/jiawlu/
.. _`Xuesong (Simon) Zhou`: https://www.linkedin.com/in/xzhou/
.. _`OpenStreetMap`: https://www.openstreetmap.org
.. _`GMNS`: https://github.com/zephyr-data-specs/GMNS
.. _`v0.x`: https://osm2gmns.readthedocs.io/en/v0.x
.. _`link`: https://doi.org/10.1016/j.trc.2023.104223
.. _`user's guide`: https://osm2gmns.readthedocs.io