https://github.com/gboeing/osmnx
Tip revision: d4a6900b30ccd87f179defd332f5854e53027f2d authored by Geoff Boeing on 16 June 2022, 02:38:53 UTC
version bump
version bump
Tip revision: d4a6900
README.md
[](https://badge.fury.io/py/osmnx)
[](https://badge.fury.io/py/osmnx)
[](https://anaconda.org/conda-forge/osmnx)
[](https://osmnx.readthedocs.io/)
[](https://github.com/gboeing/osmnx/actions?query=workflow%3A%22tests%22)
[](https://codecov.io/gh/gboeing/osmnx)
# OSMnx
**OSMnx** is a Python package that lets you download geospatial data from OpenStreetMap and model, project, visualize, and analyze real-world street networks and any other geospatial geometries. You can download and model walkable, drivable, or bikeable urban networks with a single line of Python code then easily analyze and visualize them. You can just as easily download and work with other infrastructure types, amenities/points of interest, building footprints, elevation data, street bearings/orientations, and speed/travel time.
If you use OSMnx in your work, please cite the journal article.
**Citation info**: Boeing, G. 2017. "[OSMnx: New Methods for Acquiring, Constructing, Analyzing, and Visualizing Complex Street Networks](https://geoffboeing.com/publications/osmnx-complex-street-networks/)." *Computers, Environment and Urban Systems* 65, 126-139. doi:10.1016/j.compenvurbsys.2017.05.004
## Getting Started
*How do I install OSMnx?* Follow the [installation](https://osmnx.readthedocs.io/en/stable/#installation) instructions.
*How do I use OSMnx?* Check out the usage examples/tutorials in the [examples](https://github.com/gboeing/osmnx-examples) repo.
*How does this or that function work?* Read its [documentation](https://osmnx.readthedocs.io/).
*What can I do with OSMnx?* Check out recent [projects](https://geoffboeing.com/2018/03/osmnx-features-roundup/) and blog posts that use OSMnx.
*I have a usage question.* Please ask it on [StackOverflow](https://stackoverflow.com/search?q=osmnx).
## Features
OSMnx is built on top of GeoPandas, NetworkX, and matplotlib and interacts with OpenStreetMap's APIs to:
* Download and model street networks or other networked infrastructure anywhere in the world with a single line of code
* Download any other spatial geometries, place boundaries, building footprints, or points of interest as a GeoDataFrame
* Download by city name, polygon, bounding box, or point/address + network distance
* Download drivable, walkable, bikeable, or all street networks
* Download node elevations and calculate edge grades (inclines)
* Impute missing speeds and calculate graph edge travel times
* Simplify and correct the network's topology to clean-up nodes and consolidate intersections
* Fast map-matching of points, routes, or trajectories to nearest graph edges or nodes
* Save networks to disk as shapefiles, GeoPackages, and GraphML
* Save/load street network to/from a local .osm XML file
* Conduct topological and spatial analyses to automatically calculate dozens of indicators
* Calculate and visualize street bearings and orientations
* Calculate and visualize shortest-path routes that minimize distance, travel time, elevation, etc
* Visualize street networks as a static map or interactive Leaflet web map
* Visualize travel distance and travel time with isoline and isochrone maps
* Plot figure-ground diagrams of street networks and building footprints
All of these features are demonstrated in the [examples](https://github.com/gboeing/osmnx-examples) repo and documented in the [documentation](https://osmnx.readthedocs.io/). Feature development details are in the change log. Read the [journal article](https://geoffboeing.com/publications/osmnx-complex-street-networks/) for further technical details.
