Read the v2 migration guide
- add type annotations to all public and private functions throughout package (#1107)
- remove all functionality previously deprecated in v1 (#1113 #1122 #1135 #1148)
- add Python 3.13 support (#1223)
- drop Python 3.8 support (#1106)
- bump minimum required numpy version to 1.22 for typing support (#1133 #1198)
- bump minimum required versions of geopandas to 1.0 and pandas to 1.4 for union_all support (#1179 #1198)
- replace gdal optional dependency with rio-vrt optional dependency (#1203)
- improve docstrings throughout package (#1116)
- improve logging and warnings throughout package (#1125)
- improve error messages throughout package (#1131)
- improve internal file handling context management (#1226 #1227)
- refactor features module for speed improvement and memory efficiency (#1157 #1205)
- refactor save_graph_xml function and _osm_xml module for speed improvement and bug fixes (#1135)
- make save_graph_xml function accept only an unsimplified MultiDiGraph as its input data (#1135)
- replace save_graph_xml function's edge_tag_aggs tuple parameter with way_tag_aggs dict parameter (#1135)
- add utils_geo.buffer_geometry helper function (#1214)
- add OSM junction and railway tags to the default settings.useful_tags_node (#1144)
- add node_attrs_include argument to simplification.simplify_graph function to flexibly relax strictness (#1145)
- add edge_attr_aggs argument to simplify_graph function to specify aggregation behavior (#1155)
- add node_attr_aggs argument to the consolidate_intersections function to specify aggregation behavior (#1155)
- allow per-node tolerance values for intersection consolidation (#1160)
- make consolidate_intersections function retain unique attribute values when consolidating nodes (#1144)
- make which_result function parameters consistently able to accept a list throughout package (#1113)
- handle implicit maxspeed values in add_edge_speeds function (#1153)
- change add_node_elevations_google default batch_size to 512 to match Google's limit (#1115)
- allow analysis of MultiDiGraph directional edge bearings and orientation (#1139)
- allow graph union queries through the custom_filter argument (#1204)
- fix graph projection creating useless lat and lon node attributes (#1144)
- fix bug in _downloader._save_to_cache function usage (#1107)
- fix bug in handling requests ConnectionError when querying Overpass status endpoint (#1113)
- fix minor bugs throughout to address inconsistencies revealed by type enforcement (#1107 #1114)
- make optional function parameters keyword-only throughout package (#1134)
- make dist function parameters required rather than optional throughout package (#1134)
- make utils_geo.bbox_from_point function return a tuple of floats for consistency with rest of package (#1113)
- make bounding box coordinate order consistently left, bottom, right, top (#1196)
- rename truncate.truncate_graph_dist max_dist argument to dist for consistency with rest of package (#1134)
- remove retain_all argument from all truncate module functions (#1148)
- remove settings module's deprecated and now replaced settings (#1129 #1136)
- rename osm_xml module to _osm_xml to make it private, as all its functions are private (#1113)
- rename private _downloader module to _http (#1114)
- remove unnecessary private _api module (#1114)
- pin maximum dependency versions for remaining v1 releases
- add warning to note that the order of bounding box coordinates will change in v2
- update the official package reference paper (#1169)
- rename network_types "all" -> "all_public" and "all_private" -> "all" for clarity (#1164)
- deprecate the obsolete "all_private" network_type name (#1164)
- deprecate and replace settings module's default_accept_language, default_referer, and default_user_agent settings (#1138)
- deprecate and replace settings module's memory, nominatim_endpoint, overpass_endpoint, and timeout settings (#1138)
- deprecate save_graph_xml function's renamed or obsolete parameters (#1138)
- deprecate graph_from_xml tags and polygon function parameters (#1146)
- deprecate simplify_graph function's endpoint_attrs argument and replace it with edge_attrs_differ (#1146)
- deprecate utils_graph.get_digraph function and replace it with covert.to_digraph function (#1146)
- deprecate utils_graph.get_undirected function and replace it with covert.to_undirected function (#1146)
- deprecate utils_graph.graph_to_gdfs function and replace it with covert.graph_to_gdfs function (#1146)
- deprecate utils_graph.graph_from_gdfs function and replace it with covert.graph_from_gdfs function (#1146)
- deprecate utils_graph.remove_isolated_nodes function (#1156)
- deprecate utils_graph.get_largest_component function and replace it with truncate.largest_component function (#1146)
- deprecate utils_graph.route_to_gdf function and replace it with routing.route_to_gdf function (#1146)
- deprecate speed module and move all of its functionality to the routing module (#1146)
- fix deprecation warning in simplification.simplify_graph function (#1126)
- add endpoint_attrs argument to simplification.simplify_graph function to flexibly relax strictness (#1117)
- fix a bug in the features module's polygon handling (#1104)
- update obsolete numpy random number generation (#1108)
- make deprecation warnings FutureWarnings (#1124)
- update warning messages to note that deprecated code will be removed in v2.0.0 (#1111)
- deprecate strict argument in simplification.simplify_graph function in favor of new endpoint_attrs argument (#1117)
- deprecate north, south, east, west arguments throughout package in favor of bbox tuple argument (#1112)
- deprecate return_coords argument in graph.graph_from_address function (#1105)
- deprecate return_hex argument in plot.get_colors function (#1109)
- deprecate address, point, network_type, edge_color, and smooth_joints arguments in plot.plot_figure_ground function (#1121)
- fix a bug arising from the save_graph_xml function (#1093)
- warn user if their query area is significantly larger than max query area size (#1101)
- refactor utils_geo module and deprecate quadrat_width and min_num function arguments (#1100)
- under-the-hood code clean-up (#1092 #1099 #1103)
- formally support Python 3.12 (#1082)
- fix Windows-specific character encoding issue when reading XML files (#1084)
- resolve pandas and gdal future warnings (#1089)
- use spawn instead of fork for multiprocessing to resolve Python 3.12 deprecation warning (#1089)
- rename add_node_elevations_google function's max_locations_per_batch parameter, with deprecation warning (#1088)
- move add_node_elevations_google function's url_template parameter to settings module, with deprecation warning (#1088)
- fix references to latitude and longitude parameters as lat and lon consistently across package (#1068 #1069)
- fix handling of dict and set attribute types when reloading GraphML files (#1075 #1077)
- improve automatic UTM handling in the projection module (#1059)
- add a to_latlong parameter to the projection.project_graph function for API consistency (#1057)
- workaround for pytest issue with printing to terminal window on Windows (#1064)
- refactor the distance module and add a new routing module (#1063)
- move shortest_path and k_shortest_paths functions to new routing module, with deprecation warning (#1063)
- rename great_circle_vec and euclidean_dist_vec functions to great_circle and euclidean, with deprecation warning (#1063)
- under-the-hood code clean-up (#1047)
- fix DNS resolution in Dask clusters (#1039)
- improve memory efficiency during features GeoDataFrame creation (#1043)
- handle the settings.cache_only_mode option in the features module (#1043)
- deprecate the buffer_dist and clean_periphery function parameters throughout package (#1044)
- add more descriptive exceptions: ResponseStatusCodeError and GraphSimplificationError (#1041)
- replace CacheOnlyModeInterrupt exception with CacheOnlyInterruptError exception (#1041)
- replace EmptyOverpassResponse exception with InsufficientResponseError exception (#1041)
- refactor elevation module (#1042 #1043)
- refactor the _downloader module and add new _overpass and _nominatim modules (#1043)
- under-the-hood code clean-up (#1036 #1037 #1038)
- improve memory efficiency during graph creation (#1021 #1029)
- improve log messaging (#1032)
- add version number to XML generator attribute in save_graph_xml (#1031)
- warn user if loading a .osm XML file generated by OSMnx itself (#1031)
- add style keyword argument to citation function (#1034)
- fix bug in save_graph_xml due to roundabout ways (#986 #999)
- fix GeoPandas future warning (#1012)
- make API key properly optional in elevation.add_node_elevations_google function (#999)
- rename geometries module as features module and deprecate geometries module (#1007 #1011)
- remove private _polygon_features module and move its data to features module (#994)
- make the internal downloader module private (#1010)
- deprecate interpolate parameter in distance.nearest_edges function (#1010)
- move save_graph_xml function to io module with deprecation warning in osm_xml module (#1017)
- migrate from setup.py, setup.cfg, and requirements.txt to pyproject.toml (#1002)
- pin optional dependencies to minimum required versions (#995)
- expand and reorganize the documentation (#993)
- verify edge weight attribute values before solving shortest paths (#967)
- provide consistent error when no data elements are returned from Overpass (#960)
- add route_to_gdf function to utils_graph module to return a GeoDataFrame of the edges in a path (#957)
- deprecate the get_route_edge_attributes function in favor of the new route_to_gdf function (#957)
- deprecate folium module in favor of using geopandas.GeoDataFrame.explore directly (#957)
- deprecate precision parameter in bearing, distance, elevation, and speed modules' functions (#981)
- deprecate utils_geo.round_geometry_coords function (#981)
- move plot_orientation function from bearing module to plot module (#956)
- make matplotlib an optional dependency required only for the plot module (#976)
- drop pyproj package dependency (#980)
- restore Python 3.8 compatibility (#965)
- improve DNS resolution when using proxies or on networks blocking DNS-over-HTTPS (#924 #953)
- improve processing of per-lane values when adding edge speeds (#944 #955)
- improve file writing in save_graph_xml function (#917 #961)
- ensure node coordinates are non-null and convertible to float in the add_edge_lengths function (#950)
- ignore ways tagged highway=no or highway=razed in built-in filters (#938)
- do not assume an edge with key=0 exists between each node pair when simplifying graph (#921)
- drop dateutil package dependency (#919)
- fully support Shapely 2.0 and drop support for Shapely 1.x (#900)
- drop RTree package dependency (#900)
- much faster nearest edges search using STRTree index (#900)
- allow using alternative Google Maps compatible elevation APIs, such as Open Topo Data (#901 #903)
- optionally track merged_edges as a new edge attribute in simplify_graph function (#892 #909)
- fix bug that added unsimplified edge geometry attributes when projecting
- hard code Google DNS IP address
- resolve matplotlib deprecation warning
- deprecate save_graph_shapefile function
- fix compatibility with rasterio 1.3
- fix API version when saving OSM XML
- resolve shapely deprecation warning
- fix rate limit checking and pausing on newest versions of Overpass API
- allow add_edge_lengths function to be run on a subset of edges
- resolve pandas deprecation warning
- add ability to load GraphML string data to the load_graphml function
- add "reversed" edge attribute to support node-order-dependent edge attributes
- add new edge_color and edge_linewidth arguments to plot_footprints function
- fix nearest_edges function selecting arbitrary edge when bounding boxes overlap
- fix get_digraph function's parallel edge handling
- fix pandas and geopandas version compatibility
- fix log output appearing in Jupyter notebooks on Unix-like systems
- remove old functions and arguments previously deprecated in v1.1
- deprecate utils.config function in favor of using settings module directly
- fix geocoding when no geojson is returned
- fix graph simplification to properly handle travel_time edge attributes
- fix streets per node not being calculated when clean_periphery=False
- allow user-defined aggregation function when imputing missing edge speeds
- allow user to configure requests package keyword arguments when connecting to APIs
- faster graph projection by calculating UTM zone number with a computationally cheaper method
- improve efficiency of quadrat-based geometry cutting
- fall back on google dns resolution when necessary if using a proxy
- move count_streets_per_node function to stats module
- resolve shapely and geopandas deprecation warnings
- fix overpass status endpoint checks with explicit IP address resolution
- fix slot management on local overpass instances by optionally disabling rate limiting
- parallelize shortest_path calculation for multiple origins/destinations
- add graph-constrained spatial sampling function
- add add_node_elevations_raster function to add node elevations from local raster file(s)
- add add_node_elevations_google function and deprecate old add_node_elevations function
- add faster streamlined nearest_nodes and nearest_edges functions to distance module
- deprecate old get_nearest_node, get_nearest_nodes, get_nearest_edge, and get_nearest_edges
- add utils_geo.interpolate_points function and deprecate redistribute_vertices in favor of it
- add vectorized calculate_bearing function and deprecate get_bearing in favor of it
- expose individual street network stats functions in stats module
- deprecate the extended_stats function in stats module
- add network orientation and entropy stats functions to bearing module
- add plot_orientation function to bearing module to polar histograms of graph edge bearings
- add route_linewidths parameter to plot_graph_routes function
- handle relations of type "boundary" in geometries module
- multi-index GeoDataFrames returned from geometries module by element type and osmid
- ensure all nodes have integer IDs after graph intersection consolidation
- vectorize add_edge_lengths, add_edge_grades, and add_edge_bearings functions
- improve save_graph_xml speed
- improve geocoder module error messages
- improve handling of node geometry when converting graph to/from GeoDataFrames
- fix network_type filters allowing ways tagged "bus_guideway"
- fix handling of boolean type conversion in load_graphml
- fix truncate_graph_dist retaining unreachable nodes
- fix bug in consolidate_intersections when pygeos is installed
- move add_edge_lengths function from utils_graph to distance module
- remove descartes dependency in line with geopandas
- fix network_type filters allowing ways tagged "planned"
- fix "drive" network_type allowing some alleys
- fix intersection consolidation for compatibility with v1.0 node ids/indexing
- fix python 3.6 compatibility
- deprecate folium polyline styling arguments
- set use_cache=True by default
- add ability to query a place by OSM ID in geocoder.geocode_to_gdf function
- add optional setting for download/cache-only mode
- replace md5 with sha1 for cache filename hashing
- replace streets_per_node graph attribute with equivalent street_count node attribute
- remove redundant osmid node attribute
- make graph_to_gdfs multi-index the edges GeoDataFrame by u, v, key
- refactor consolidate_intersections function for better speed and efficiency
- refactor count_streets_per_node function for better speed and efficiency
- refactor folium module for better speed and efficiency
- refactor get_undirected functionality for better speed and efficiency
- extract all private/internal .osm XML functionality into new osm_xml module
- deprecate io.save_graph_xml with warning (function moved to osm_xml module)
- remove internal _is_simplified function
- remove deprecated pois module
- remove deprecated footprints module
- remove deprecated utils_graph.induce_subgraph function
- remove deprecated node_type parameter from io.load_graphml function
- improve graph_from_gdfs speed and efficiency
- improve plot_route_folium speed and efficiency
- fix remove_isolated_nodes function mutating the passed-in graph
- fix gephi compatibility in save_graphml
- add customizable node/edge attribute data type arguments to load_graphml
- deprecate old node_type argument in load_graphml
- expose bidirectional_network_types via config function
- fix handling graphs with no intersections in consolidate_intersections
- fix consolidate_intersections returning GeoSeries without CRS attribute
- fix response caching to save only when status code is 200
- fix elevation module's grade absolute value calculation when grade is null
- move shortest path functions from utils_graph module to distance module
- new geometries module for creating GeoDataFrames from tag/value queries
- deprecate old pois and footprints modules (replaced by geometries module)
- auto-select first Polygon/MultiPolygon when geocoding with which_result=None
- new kshortest_paths function to solve _k shortest paths from origin to destination
- new shortest_path convenience function
- new get_digraph function to correctly convert MultiDiGraph to DiGraph
- miscellaneous performance improvements and optimizations
- deprecate induce_subgraph function
- remove deprecated boundaries module (replaced by geocoder module in v0.15.0)
- remove deprecated utils_geo.geocode function (replaced by geocoder.geocode function in v0.15.0)
- fix geopandas future warnings
- improve plotting defaults and streamline plot module speed and efficiency
- improve color handling in plot module
- improve route plotting
- plot_graph_routes function now accepts multiple route colors
- allow multiple elevation API providers
- consolidate_intersections replaces update_edge_lengths param with reconnect_edges param
- fix geopackage file saving after consolidating intersections
- add new geocoder module and move utils_geo.geocode function into it
- replace gdf_from_place/s functions with geocoder.geocode_to_gdf
- deprecate boundaries module
- remove deprecated timeout, memory, custom_settings, and max_query_area_size function params
- remove deprecated plotting params and plot_shape function
- fix simplification of graphs with long rural roads
- reduce memory footprint of graph simplification
- remove disconnected self-contained rings from graph by default when simplifying
- improve speed and efficiency of project_graph, graph_to_gdfs, and graph_from_gdfs
- improve attribute value conversion in load_graphml
- expose precision parameter for adding bearings, elevations, speeds, and travel times
- fix config function clobber behavior
- fix graph periphery cleaning when clean_periphery=True but simplify=False
- rename settings useful_tags_path to the more appropriate useful_tags_way
- deprecate the timeout, memory, custom_settings, and max_query_area_size function params
- the params above are now accessible via config function and settings module
- deprecate old plot params and plot_shape function
- remove previously deprecated infrastructure parameter in favor of custom_filter
- better geometry subdividing for huge OSM queries
- better handling of maxspeed list values for simplified graphs
- downloader only retrieves url response from cache if no server remark
- deprecate graph creation infrastructure parameter in favor of flexible custom_filter
- remove deprecated functions: graph_from_file, clean_intersections, gdfs_to_graph
- major refactor of entire package
- clean up API and namespace
- new consolidate_intersections function with topological option
- new speed module to calculate graph edge speeds and travel times
- generalize POIs module to query with a flexible tags dict
- allow folium functions to accept FeatureGroup and kwargs
- all graph saving functions now take a filepath argument instead of folder/filename
- save shapefiles in single folder containing both nodes and edges
- optionally return distance and/or geometry in nearest edge search
- expose timeout and memory parameters in pois and footprints modules
- define default crs via epsg code instead of proj4 string
- update and simplify logging with timestamps
- graph metadata: add creation date and version, remove name
- replace inconsistent distance parameters with consistent dist parameters
- deprecate old clean_intersections function in favor of new consolidate_intersections
- deprecate old gdfs_to_graph function in favor of graph_from_gdfs
- deprecate old graph_from_file function in favor of graph_from_xml
- rename save_as_osm function -> save_graph_xml for consistency
- rename save_load module -> io
- remove old save_gdf_shapefile function
- drop support for python 3.5 and lower
- fix handling relations with missing type tag
- fix save_graph_geopackage handling numeric attributes
- fix load_graphml handling elevation and grade attributes
- improve edge finding algorithms to return edge key
- more informative graph_from_file data load error message
- refactor url-in-cache checking
- add timestamp helper function
- documentation improvements
- add ability to save graph as geopackage file
- add truncate_by_edge implementation in truncate_graph_polygon
- allow flexible overpass settings (e.g., to query by date)
- better handling of invalid footprint geometries
- geocode function now uses nominatim_request function
- improve .osm xml output
- improve one-way street handling
- fix graph projection overwriting original lat/lng
- fix redistribute_vertices function for MultiLineStrings
- fix .osm xml output
- fix for pandas 1.0
- fix errant print statement
- fix .osm xml output
- fix geopandas future compatibility
- fix get_nearest_edges search when not using a spatial index
- drop formal python 2 support
- refactor all modules for cleaner package organization
- make stats betweenness centrality compatible with networkx>=2.4
- allow configurable overpass and nominatim endpoints
- allow gdf_from_places to take a which_result list argument
- handle zero-division in street grade calculation
- better footprint relation handling
- improve network type queries for better filtering
- fix pois_from_polygon returning points outside polygon
- remove deprecated buildings module
- filter steps ways out of bike queries
- convert CRS-handling to proj4 strings
- save graph to xml-formatted .osm file
- minor refactoring
- deprecate buildings module and replace with generalized footprints module
- improve handling of multipolygon footprints
- new function to find nearest edge(s), given coordinates
- add "search," "reverse," and "lookup" nominatim queries
- use unprojected graphs for figure-ground plotting functions
- allow non-integer osmid values for custom data
- improve get_route_edge_attributes function
- improve color mapping by node/edge attribute value
- make bidirectional network types explicit
- networkx compatibility fixes to resolve warnings
- add python 3.7 compatibility
- add convenience function to plot several routes over the same map
- optimize graph truncation to bounding box
- give self-loops a null bearing when calculating edge bearings
- make accept-language http header explicit and configurable
- add citation function
- refactor POI module
- add Gephi compatibility argument for saving GraphML
- handle square bracket encapsulated strings when loading GraphML
- add ability to retrieve points of interest
- improve performance for retrieving huge geographies' street networks
- fix building footprint retrieval query syntax
- minor bug fixes
- add fast nearest-nodes search
- allow custom network query filters
- allow create_graph to return graph with no edges
- improve figure_ground joint smoothing
- fix handling of parallel edges when making multidigraph undirected
- generalize same-geometry checker
- improve detection of prior topology simplification
- custom error types for finer-grained handling
- turn off x- and y-axes to improve plotting appearance
- make floating-point precision and rounding more sensible
- improve OS path handling cross-platform
- replace great-circle distance calculator with haversine
- add access filter as configurable setting
- improve performance of inducing subgraphs
- fix utils.get_largest_component for networkx 2.2 compatibility
- fix config settings namespacing
- compatibility with networkx 2.1
- fix documentation build
- ignore ways marked access=no
- ability to load a graph from a .osm file
- change datum from NAD83 to WGS84
- make roundabouts one-way
- conformal plotting for unprojected graphs
- fix folium web maps rendering
- migrate to the networkx 2.0 API
- add optional cleaned intersections count to basic stats
- allow circuity to be calculated for projected or unprojected networks
- various code clean-up and refactoring
- add requirements files to distribution
- add ability to download other infrastructures besides just roads/paths (e.g., rail lines, power lines, etc.)
- calculate graph edges' bearings
- add ability to get nearest node by great circle or euclidean distance
- move examples/demo notebooks to new repo: osmnx-examples
- fix docstrings
- fix building footprint downloads that require multiple calls for large areas
- fix missing MultiPolygon import in buildings module
- functionality to clean-up and consolidate complex intersections
- let save_gdf_shapefile save building footprint GeoDataFrames
- set node color correctly in figure-ground diagrams
- add elevation module to get node elevations and street grades
- new color sequence creation and conversion functions in plot module
- new function to get a path's edge attribute values
- gracefully handle subpolygons that are invalid or have zero area
- make truncate_graph_polygon work on projected graphs
- plot_shape accepts a color or a list of colors
- make all requests to Overpass API set custom user-agent and referer
- rewrite algorithms to convert multidigraphs to multigraphs
- fix load_graphml so we can save a graph again after loading it
- fix load_graphml so edge oneway attribute is not always set to True
- buildings module gets buildings stored in OSM as relations as well as ways
- fix figure-ground diagram saving to make perfect square and smooth joints
- add optional graph argument to plot_figure_ground
- suppress jupyter notebook deprecation warnings
- plot entire networks with folium
- plot routes on top of networks with folium
- vectorize all great circle calculations
- new geocode function in utils
- remove geopy dependency
- refactor modules
- simplify before truncating by distance when getting graph by point and network distance
- project geometries, GeoDataFrames, and graphs to a passed-in CRS
- clean up docstrings throughout
- remove network code vestiges from buildings.py
- add route plotting with folium
- add downloading and visualization of building footprints
- updates for compatibility with matplotlib 2.0
- fixes for compatibility with networkx 2.0's new API
- make png default image save format
- figure-ground plots collect street network from a wider area
- add license file to dist package
- refactor modules
- add graph to GDF and GDF to graph functions
- add encoding argument to save_graph_shapefile
- add unit tests and continuous integration
- add street width attribute for ways from OSM
- make simplification error messages explicit
- process land use and area tags from OSM
- make intersection error messages clear
- first pre-release