OSMnet
======

|Build Status|  |Coverage Status|  |Appveyor Build Status|

Tools for the extraction of OpenStreetMap (OSM) street network data.
Intended to be used in tandem with Pandana and UrbanAccess libraries to
extract street network nodes and edges.

Project scope and status
------------------------

**Status:** Deprecated / Migration

**Mission:** OSMnet provides the legacy OpenStreetMap network-acquisition
functionality used by existing Pandana and UrbanAccess workflows while those
projects migrate to maintained OSM libraries.

The project is retained to support:

* existing Pandana and UrbanAccess integrations;
* compatibility needed during the migration period;
* documentation of established OSMnet workflows; and
* orderly transition of downstream users.

New applications should use actively maintained OSM libraries such as OSMnx
or Pyrosm for OpenStreetMap network acquisition.

OSMnet will be archived after dependent UDST projects no longer require it.
Development during the migration period is limited primarily to critical
compatibility and migration support.

See the `UDST Project Directory
<https://github.com/UDST/.github/blob/main/PROJECTS.md>`__ for
organization-wide project status and policy.

Overview
========

OSMnet offers tools to download street network data from OpenStreetMap
and extract a graph network comprised of nodes and edges to be used in
`Pandana`_ street network accessibility calculations and or `UrbanAccess`_
to connect GTFS transit networks to road networks.

Let us know what you are working on or if you think you have a great use case
by tweeting us at ``@urbansim``.

Library Status
--------------

*Forthcoming improvements:*

* Tutorial/demo

Reporting bugs
--------------

Please report any bugs you encounter via `GitHub issues`_.

Contributing to OSMnet
----------------------

If you have improvements or new features you would like to see in OSMnet:

1. Open a feature request via `GitHub issues`_.
2. Contribute your code from a fork or branch by using a Pull Request and request a review so it can be considered as an addition to the codebase.

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

conda
^^^^^

OSMnet is available on conda and can be installed with:

``conda install osmnet --channel conda-forge``

It is recommended to install via conda and the conda-forge channel especially if you find you are having issues installing some of the spatial dependencies.

pip
^^^

OSMnet can be installed via PyPI:

``pip install osmnet``

Development Installation
^^^^^^^^^^^^^^^^^^^^^^^^

To install OSMnet from source code, follow these steps:

1. Git clone the `OSMnet repo`_
2. in the cloned directory run: ``python setup.py develop``

To update to the latest version:

Use ``git pull`` inside the cloned repository

Documentation
-------------

Documentation for OSMnet can be found `here`_.

Related UDST libraries
----------------------

-  `Pandana`_
-  `UrbanAccess`_

.. _Pandana: https://github.com/UDST/pandana
.. _GitHub issues: https://github.com/UDST/osmnet/issues
.. _OSMnet repo: https://github.com/udst/osmnet
.. _here: https://udst.github.io/osmnet/index.html
.. _UrbanAccess: https://github.com/UDST/urbanaccess

.. |Build Status| image:: https://travis-ci.org/UDST/osmnet.svg?branch=master
   :target: https://travis-ci.org/UDST/osmnet

.. |Appveyor Build Status| image:: https://ci.appveyor.com/api/projects/status/acuoygyy3l0lqnpv/branch/master?svg=true
   :target: https://ci.appveyor.com/project/pksohn/osmnet

.. |Coverage Status| image:: https://coveralls.io/repos/github/UDST/osmnet/badge.svg?branch=master
   :target: https://coveralls.io/github/UDST/osmnet?branch=master