Metadata-Version: 2.0
Name: osmnet
Version: 0.1.2
Summary: Tools for the extraction of OpenStreetMap street network data for use in Pandana accessibility analyses.
Home-page: https://github.com/UDST/osmnet
Author: UrbanSim Inc.
Author-email: UNKNOWN
License: AGPL
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.5
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Requires-Dist: Shapely (>=1.5)
Requires-Dist: geopandas (>=0.2.1)
Requires-Dist: numpy (>=1.10)
Requires-Dist: pandas (>=0.16.0)
Requires-Dist: requests (>=2.9.1)

OSMnet
======

|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.

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.

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

OSMnet is currently in a alpha release. 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
------------

pip and conda installations are forthcoming. OSMnet is currently in a
alpha release. As such, it is suggest to install using the ``develop``
command rather than ``install``. Make sure you are using the latest
version of the code base by using git’s ``git pull`` inside the cloned
repository.

To install OSMnet 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


