OSMnx

https://osmnx.readthedocs.io/en/stable
Admin
OSMnx is a Python package for downloading, modeling, analyzing, and visualizing street networks and...
Tokens:28,822
Snippets:334
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install OSMnx via Conda

Source: https://osmnx.readthedocs.io/en/stable/installation.html

Creates a new conda environment and installs OSMnx using the conda-forge channel.

```bash
conda create --strict-channel-priority -c conda-forge -n ox osmnx
```

--------------------------------

### Install OSMnx with Pip

Source: https://osmnx.readthedocs.io/en/stable/_sources/installation.rst.txt

Install OSMnx using pip into a virtual environment. This method is simple if dependencies are already met, but may require manual compilation if precompiled binaries are unavailable.

```shell
pip install osmnx
```

--------------------------------

### Install OSMnx with Conda

Source: https://osmnx.readthedocs.io/en/stable/_sources/installation.rst.txt

Use this command to create a new conda environment named 'ox' and install OSMnx from the conda-forge channel. Add other desired packages after 'osmnx'.

```shell
conda create --strict-channel-priority -c conda-forge -n ox osmnx
```

--------------------------------

### osmnx.routing.k_shortest_paths

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Solve k shortest paths from an origin node to a destination node using Yen’s algorithm.

```APIDOC
## osmnx.routing.k_shortest_paths(G, orig, dest, k, weight='length')

### Description
Solve k shortest paths from an origin node to a destination node using Yen’s algorithm.

### Parameters
- **G** (MultiDiGraph) - Required - Input graph.
- **orig** (int) - Required - Origin node ID.
- **dest** (int) - Required - Destination node ID.
- **k** (int) - Required - Number of shortest paths to solve.
- **weight** (str) - Optional - Edge attribute to minimize when solving shortest paths.

### Returns
- **path** (Iterator[list[int]]) - The node IDs constituting the next-shortest path.
```

--------------------------------

### osmnx.utils module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the utility functions available in the osmnx.utils module.

```APIDOC
## osmnx.utils module

This module contains general utility functions for OSMnx.
```

--------------------------------

### osmnx.routing.shortest_path(G, orig, dest, weight='length', cpus=None)

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Solves the shortest path between origin and destination nodes in a MultiDiGraph using Dijkstra's algorithm.

```APIDOC
## shortest_path(G, orig, dest, weight, cpus)

### Description
Calculates the shortest path between nodes in a graph using Dijkstra's algorithm. If orig and dest are single node IDs, it returns a list of nodes. If they are lists of node IDs, it returns a list of lists of nodes. If a path cannot be solved, it returns None.

### Parameters
- **G** (networkx.MultiDiGraph) - Required - The input graph.
- **orig** (int | Iterable[int]) - Required - Origin node ID or list of origin node IDs.
- **dest** (int | Iterable[int]) - Required - Destination node ID or list of destination node IDs.
- **weight** (str) - Optional - Edge attribute to minimize when solving the shortest path.
- **cpus** (int | None) - Optional - Number of CPU cores to use for multiprocessing. If None, uses all available cores.

### Returns
- **path** (list[int] | None | list[list[int] | None]) - The node IDs constituting the shortest path, or a list of paths if multiple pairs were provided.
```

--------------------------------

### osmnx.settings module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions and variables available in the osmnx.settings module, which are used for configuring OSMnx's behavior.

```APIDOC
## osmnx.settings module

This module allows users to configure and manage OSMnx settings.
```

--------------------------------

### osmnx.utils.log(message, level=None, name=None, filename=None)

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Writes a message to the logger based on current configuration settings.

```APIDOC
## osmnx.utils.log(message, level=None, name=None, filename=None)

### Description
Logs a message to file and/or the console, depending on the current configuration of settings.log_file and settings.log_console.

### Parameters
- **message** (str) - Required - The message to log.
- **level** (int | None) - Optional - One of the Python logger.level constants. If None, uses settings.log_level.
- **name** (str | None) - Optional - The name of the logger. If None, uses settings.log_name.
- **filename** (str | None) - Optional - The name of the log file, without file extension. If None, uses settings.log_filename.

### Returns
- **None**
```

--------------------------------

### osmnx.utils.citation(style='bibtex')

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Prints the OSMnx package citation information in the specified format.

```APIDOC
## osmnx.utils.citation(style='bibtex')

### Description
Prints the OSMnx package’s citation information to the console.

### Parameters
- **style** (str) - Optional - The citation format, either 'apa', 'bibtex', or 'ieee'. Defaults to 'bibtex'.

### Returns
- **None**
```

--------------------------------

### osmnx.graph.graph_from_bbox

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Downloads and creates a graph within a specified latitude-longitude bounding box.

```APIDOC
## osmnx.graph.graph_from_bbox(bbox, *, network_type='all', simplify=True, retain_all=False, truncate_by_edge=False, custom_filter=None)

### Description
Download and create a graph within a lat-lon bounding box using the Overpass API.

### Parameters
- **bbox** (tuple) - Required - The bounding box coordinates.
- **network_type** (str) - Optional - {'all', 'all_public', 'bike', 'drive', 'drive_service', 'walk'} Defaults to 'all'.
- **simplify** (bool) - Optional - If True, simplify graph topology.
- **retain_all** (bool) - Optional - If True, return the entire graph even if not connected.
- **truncate_by_edge** (bool) - Optional - If True, retain nodes outside bounding box if at least one neighbor is inside.
- **custom_filter** (str | list[str] | None) - Optional - A custom ways filter to be used instead of network_type presets.
```

--------------------------------

### osmnx.graph.graph_from_place

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Downloads and creates a graph within the boundaries of specified place(s). The query must be geocodable and have polygon boundaries in OpenStreetMap.

```APIDOC
## osmnx.graph.graph_from_place

### Description
Download and create a graph within the boundaries of some place(s). This function uses filters to query the Overpass API to retrieve street networks.

### Parameters
- **query** (str | dict | list) - Required - The query or queries to geocode to retrieve place boundary polygon(s).
- **network_type** (str) - Optional - {“all”, “all_public”, “bike”, “drive”, “drive_service”, “walk”} What type of street network to retrieve if custom_filter is None.
- **simplify** (bool) - Optional - If True, simplify graph topology with the simplify_graph function.
- **retain_all** (bool) - Optional - If True, return the entire graph even if it is not connected.
- **truncate_by_edge** (bool) - Optional - If True, retain nodes outside the place boundary polygon(s) if at least one of the node’s neighbors lies within the polygon(s).
- **which_result** (int | None | list) - Optional - Which geocoding result to use.
- **custom_filter** (str | list | None) - Optional - A custom ways filter to be used instead of the network_type presets.

### Returns
- **G** (networkx.MultiDiGraph) - The resulting MultiDiGraph.
```

--------------------------------

### osmnx.utils_geo.bbox_from_point

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Creates a bounding box around a (lat, lon) point at a specified distance in meters.

```APIDOC
## osmnx.utils_geo.bbox_from_point(point, dist, project_utm=False, return_crs=False)

### Description
Creates a bounding box some distance (in meters) in each direction (top, bottom, right, and left) from the center point and optionally project it.

### Parameters
- **point** (tuple[float, float]) - Required - The (lat, lon) center point to create the bounding box around.
- **dist** (float) - Required - Bounding box distance in meters from the center point.
- **project_utm** (bool) - Optional - If True, return bounding box as UTM-projected coordinates.
- **return_crs** (bool) - Optional - If True, and project_utm is True, then return the projected CRS too.

### Returns
- **bbox or bbox, crs** (tuple[float, float, float, float] | tuple[tuple[float, float, float, float], Any]) - (left, bottom, right, top) or ((left, bottom, right, top), crs).
```

--------------------------------

### osmnx.io module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.io module, which are used for input and output operations, such as saving and loading graph data.

```APIDOC
## osmnx.io module

This module contains functions for reading from and writing to various file formats.
```

--------------------------------

### osmnx.stats.basic_stats(G, area=None, clean_int_tol=None)

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Calculates basic descriptive geometric and topological measures of a graph.

```APIDOC
## osmnx.stats.basic_stats(G, area=None, clean_int_tol=None)

### Description
Calculate basic descriptive geometric and topological measures of a graph. Density measures are only calculated if area is provided and clean intersection measures are only calculated if clean_int_tol is provided.

### Parameters
- **G** (MultiDiGraph) - Required - Input graph.
- **area** (float | None) - Optional - If not None, calculate density measures and use area (in square meters) as the denominator.
- **clean_int_tol** (float | None) - Optional - If not None, calculate consolidated intersections count and use this tolerance value.

### Returns
- **dict[str, Any]** - Dictionary containing various network statistics including circuity, intersection counts, densities, and node degrees.
```

--------------------------------

### osmnx.simplification module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.simplification module, which are used for simplifying network geometries.

```APIDOC
## osmnx.simplification module

This module contains functions for simplifying the geometry of network edges.
```

--------------------------------

### osmnx.convert module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.convert module, which are used for converting between different data formats and structures.

```APIDOC
## osmnx.convert module

This module contains functions for converting data between various formats.
```

--------------------------------

### osmnx.utils.ts(style='datetime', template=None)

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Returns the current local timestamp as a formatted string.

```APIDOC
## osmnx.utils.ts(style='datetime', template=None)

### Description
Returns the current local timestamp as a string.

### Parameters
- **style** (str) - Optional - Format the timestamp with a built-in style: 'datetime', 'iso8601', 'date', or 'time'.
- **template** (str | None) - Optional - If provided, formats the timestamp with this format string instead of a built-in style.

### Returns
- **timestamp** (str) - The current timestamp.
```

--------------------------------

### osmnx.graph.graph_from_polygon

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Downloads and creates a graph within the boundaries of a provided (Multi)Polygon.

```APIDOC
## osmnx.graph.graph_from_polygon(polygon, *, network_type='all', simplify=True, retain_all=False, truncate_by_edge=False, custom_filter=None)

### Description
Download and create a graph within the boundaries of a (Multi)Polygon using the Overpass API.

### Parameters
- **polygon** (object) - Required - The (Multi)Polygon defining the boundaries.
- **network_type** (str) - Optional - {'all', 'all_public', 'bike', 'drive', 'drive_service', 'walk'} Type of street network to retrieve.
- **simplify** (bool) - Optional - If True, simplify graph topology.
- **retain_all** (bool) - Optional - If True, return the entire graph even if not connected.
- **truncate_by_edge** (bool) - Optional - If True, retain nodes outside the boundary if a neighbor is inside.
- **custom_filter** (str | list[str]) - Optional - A custom Overpass QL ways filter.

### Returns
- **G** (networkx.MultiDiGraph) - The resulting graph.
```

--------------------------------

### osmnx.graph.graph_from_point

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Downloads and creates a graph within a specified distance of a latitude-longitude point.

```APIDOC
## osmnx.graph.graph_from_point(center_point, dist, *, dist_type='bbox', network_type='all', simplify=True, retain_all=False, truncate_by_edge=False, custom_filter=None)

### Description
Download and create a graph within some distance of a lat-lon point. This function uses filters to query the Overpass API.

### Parameters
- **center_point** (tuple[float, float]) - Required - The (lat, lon) center point in unprojected latitude-longitude degrees (EPSG:4326).
- **dist** (float) - Required - Retain only those nodes within this many meters of center_point.
- **dist_type** (str) - Optional - {'bbox', 'network'} Method for measuring distance.
- **network_type** (str) - Optional - {'all', 'all_public', 'bike', 'drive', 'drive_service', 'walk'} Type of street network to retrieve.
- **simplify** (bool) - Optional - If True, simplify graph topology.
- **retain_all** (bool) - Optional - If True, return the entire graph even if not connected.
- **truncate_by_edge** (bool) - Optional - If True, retain nodes outside the bounding box if a neighbor is inside.
- **custom_filter** (str | list[str]) - Optional - A custom Overpass QL ways filter.

### Returns
- **G** (networkx.MultiDiGraph) - The resulting graph.
```

--------------------------------

### osmnx.projection module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.projection module, which are used for managing and transforming coordinate reference systems.

```APIDOC
## osmnx.projection module

This module contains functions for handling coordinate reference system transformations.
```

--------------------------------

### osmnx.features.features_from_place

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Downloads OSM features within the boundaries of a specified place.

```APIDOC
## osmnx.features.features_from_place(query, tags, *, which_result=None)

### Description
Download OSM features within the boundaries of some place(s).

### Parameters
- **query** (str) - Required - The place name to geocode.
- **tags** (dict) - Required - Tags for finding elements.
- **which_result** (int, optional) - Optional - Used to select a different geocode result if multiple are found.
```

--------------------------------

### osmnx.graph.graph_from_address

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Downloads and creates a graph within a specified distance of a given address.

```APIDOC
## osmnx.graph.graph_from_address(address, dist, *, dist_type='bbox', network_type='all', simplify=True, retain_all=False, truncate_by_edge=False, custom_filter=None)

### Description
Download and create a graph within some distance of an address. This function uses filters to query the Overpass API.

### Parameters
- **address** (str) - Required - The address to geocode and use as the central point.
- **dist** (float) - Required - Retain only those nodes within this many meters of center_point.
- **dist_type** (str) - Optional - {'network', 'bbox'} Defaults to 'bbox'.
- **network_type** (str) - Optional - {'all', 'all_public', 'bike', 'drive', 'drive_service', 'walk'} Defaults to 'all'.
- **simplify** (bool) - Optional - If True, simplify graph topology.
- **retain_all** (bool) - Optional - If True, return the entire graph even if not connected.
- **truncate_by_edge** (bool) - Optional - If True, retain nodes outside bounding box if at least one neighbor is inside.
- **custom_filter** (str | list[str] | None) - Optional - A custom ways filter to be used instead of network_type presets.

### Returns
- **G** (networkx.MultiDiGraph) - The resulting MultiDiGraph.
```

--------------------------------

### osmnx.bearing module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.bearing module, which are related to calculating bearings between points.

```APIDOC
## osmnx.bearing module

This module contains functions for calculating bearings between geographic points.
```

--------------------------------

### osmnx.features.features_from_bbox

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Downloads OSM features within a specified latitude-longitude bounding box.

```APIDOC
## osmnx.features.features_from_bbox(bbox, tags)

### Description
Download OSM features within a lat-lon bounding box.

### Parameters
- **bbox** (tuple[float, float, float, float]) - Required - Bounding box as (left, bottom, right, top) in EPSG:4326.
- **tags** (dict) - Required - Tags for finding elements. Keys are OSM tags, values can be True, a string, or a list of strings.

### Returns
- **gdf** (geopandas.GeoDataFrame) - The features, multi-indexed by element type and OSM ID.
```

--------------------------------

### osmnx.features.features_from_polygon(polygon, tags)

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Download OSM features within the boundaries of a (Multi)Polygon.

```APIDOC
## osmnx.features.features_from_polygon(polygon, tags)

### Description
Download OSM features within the boundaries of a (Multi)Polygon. This function searches for features using tags.

### Parameters
- **polygon** (Polygon | MultiPolygon) - Required - The geometry within which to retrieve features. Coordinates should be in unprojected latitude-longitude degrees (EPSG:4326).
- **tags** (dict[str, bool | str | list[str]]) - Required - Tags for finding elements in the selected area.

### Returns
- **gdf** (geopandas.GeoDataFrame) - The features, multi-indexed by element type and OSM ID.
```

--------------------------------

### osmnx.features.features_from_point(center_point, tags, dist)

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Download OSM features within a specified distance of a latitude-longitude point.

```APIDOC
## osmnx.features.features_from_point(center_point, tags, dist)

### Description
Download OSM features within some distance of a lat-lon point. This function searches for features using tags.

### Parameters
- **center_point** (tuple[float, float]) - Required - The (lat, lon) center point around which to retrieve the features. Coordinates should be in unprojected latitude-longitude degrees (EPSG:4326).
- **tags** (dict[str, bool | str | list[str]]) - Required - Tags for finding elements in the selected area.
- **dist** (float) - Required - Distance in meters from center_point to create a bounding box to query.

### Returns
- **gdf** (geopandas.GeoDataFrame) - The features, multi-indexed by element type and OSM ID.
```

--------------------------------

### osmnx.bearing.orientation_entropy(G, num_bins=36, min_length=0, weight=None)

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Calculates the Shannon entropy of a graph's edge bearings.

```APIDOC
## osmnx.bearing.orientation_entropy(G, num_bins=36, min_length=0, weight=None)

### Description
Calculates the graph's orientation entropy, which is the Shannon entropy of the edges' bearings across evenly spaced bins.

### Parameters
- **G** (nx.MultiGraph | nx.MultiDiGraph) - Required - Unprojected graph with bearing attributes on each edge.
- **num_bins** (int) - Optional - Number of bins (default 36).
- **min_length** (float) - Optional - Ignore edges with length attributes less than this value.
- **weight** (str | None) - Optional - Attribute name to weight bearings by, or None for equal weight.

### Returns
- **entropy** (float) - The orientation entropy of the graph.
```

--------------------------------

### osmnx.utils_geo module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the geospatial utility functions available in the osmnx.utils_geo module.

```APIDOC
## osmnx.utils_geo module

This module contains utility functions specifically for geospatial operations.
```

--------------------------------

### osmnx.features.features_from_xml(filepath, *, polygon=None, tags=None, encoding='utf-8')

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Create a GeoDataFrame of OSM features from data in an OSM XML file.

```APIDOC
## osmnx.features.features_from_xml(filepath, *, polygon=None, tags=None, encoding='utf-8')

### Description
Create a GeoDataFrame of OSM features from data in an OSM XML file. Because this function creates a GeoDataFrame from an already downloaded file, the polygon and tags arguments are optional.

### Parameters
- **filepath** (str) - Required - Path to the OSM XML file.
- **polygon** (Polygon | MultiPolygon) - Optional - The geometry to filter features.
- **tags** (dict[str, bool | str | list[str]]) - Optional - Tags to filter features.
- **encoding** (str) - Optional - File encoding, defaults to 'utf-8'.
```

--------------------------------

### osmnx.elevation module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.elevation module, which are used for retrieving and working with elevation data.

```APIDOC
## osmnx.elevation module

This module contains functions for accessing and processing elevation data.
```

--------------------------------

### osmnx.graph.graph_from_xml

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Creates a network graph from data stored in an OSM XML file.

```APIDOC
## osmnx.graph.graph_from_xml

### Description
Create a graph from data in an OSM XML file. Do not load an XML file previously generated by OSMnx.

### Parameters
- **filepath** (str | Path) - Required - Path to file containing OSM XML data.
- **bidirectional** (bool) - Optional - If True, create bidirectional edges for one-way streets.
- **simplify** (bool) - Optional - If True, simplify graph topology with the simplify_graph function.
- **retain_all** (bool) - Optional - If True, return the entire graph even if it is not connected.
- **encoding** (str) - Optional - The OSM XML file’s character encoding.

### Returns
- **G** (networkx.MultiDiGraph) - The resulting MultiDiGraph.
```

--------------------------------

### osmnx.stats module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.stats module, which are used for calculating various statistics on street networks.

```APIDOC
## osmnx.stats module

This module provides functions for calculating network statistics.
```

--------------------------------

### osmnx.utils.ts

Source: https://osmnx.readthedocs.io/en/stable/internals-reference.html

Returns the current local timestamp as a formatted string.

```APIDOC
## osmnx.utils.ts(style='datetime', template=None)

### Description
Generates a timestamp string using a built-in style or a custom format template.

### Parameters
- **style** (str) - Optional - The timestamp style: "datetime", "iso8601", "date", or "time".
- **template** (str | None) - Optional - A custom format string for the timestamp.

### Returns
- **timestamp** (str) - The current local timestamp.
```

--------------------------------

### osmnx.io.save_graph_xml

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Saves a graph to disk as an OSM XML file.

```APIDOC
## osmnx.io.save_graph_xml(G, filepath=None, *, way_tag_aggs=None, encoding='utf-8')

### Description
Save graph to disk as an OSM XML file. This function has specific constraints and is intended for applications requiring OSM XML format.

### Parameters
- **G** (MultiDiGraph) - Required - Unsimplified, unprojected graph to save.
- **filepath** (str | Path | None) - Optional - Path to the saved file including extension.
- **way_tag_aggs** (dict[str, Any] | None) - Optional - Keys are OSM way tag keys and values are aggregation functions.
- **encoding** (str) - Optional - The character encoding of the saved OSM XML file.
```

--------------------------------

### osmnx.io.load_graphml

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Loads an OSMnx-saved GraphML file from disk or a GraphML string, converting attributes to specified data types.

```APIDOC
## osmnx.io.load_graphml(filepath=None, *, graphml_str=None, node_dtypes=None, edge_dtypes=None, graph_dtypes=None)

### Description
Load an OSMnx-saved GraphML file from disk or GraphML string. This function converts node, edge, and graph-level attributes to their appropriate data types.

### Parameters
- **filepath** (str | Path | None) - Optional - Path to the GraphML file.
- **graphml_str** (str | None) - Optional - Valid and decoded string representation of a GraphML file’s contents.
- **node_dtypes** (dict[str, Any] | None) - Optional - Dict of node attribute names:types to convert values’ data types.
- **edge_dtypes** (dict[str, Any] | None) - Optional - Dict of edge attribute names:types to convert values’ data types.
- **graph_dtypes** (dict[str, Any] | None) - Optional - Dict of graph-level attribute names:types to convert values’ data types.

### Returns
- **G** (networkx.MultiDiGraph) - The loaded MultiDiGraph.
```

--------------------------------

### osmnx.routing module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.routing module, which are used for finding routes within street networks.

```APIDOC
## osmnx.routing module

This module provides algorithms and functions for finding routes in network graphs.
```

--------------------------------

### osmnx.features module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.features module, which are used for retrieving and querying features from OpenStreetMap.

```APIDOC
## osmnx.features module

This module provides functions to download and query features from OpenStreetMap.
```

--------------------------------

### osmnx.stats.streets_per_node_counts(G)

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Calculate the frequency distribution of streets per node.

```APIDOC
## osmnx.stats.streets_per_node_counts(G)

### Description
Calculate streets-per-node counts.

### Parameters
- **G** (MultiDiGraph) - Required - Input graph.

### Returns
- **spnc** (dict[int, int]) - Dictionary keyed by count of streets incident on each node, and with values of how many nodes in the graph have this count.
```

--------------------------------

### osmnx.stats.streets_per_node_proportions(G)

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Calculate the proportions of nodes having a specific number of incident streets.

```APIDOC
## osmnx.stats.streets_per_node_proportions(G)

### Description
Calculate streets-per-node proportions.

### Parameters
- **G** (MultiDiGraph) - Required - Input graph.

### Returns
- **spnp** (dict[int, float]) - Dictionary keyed by count of streets incident on each node, and with values of what proportion of nodes in the graph have this count.
```

--------------------------------

### osmnx.plot.plot_graph_routes

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Visualizes multiple paths along a graph.

```APIDOC
## osmnx.plot.plot_graph_routes(G, routes, route_colors='r', route_linewidths=4, **pgr_kwargs)

### Description
Visualize multiple paths along a graph.
```

--------------------------------

### osmnx.projection.project_graph

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Projects a graph from its current CRS to another.

```APIDOC
## osmnx.projection.project_graph(G, *, to_crs=None, to_latlong=False)

### Description
Project a graph from its current CRS to another. If to_latlong is True, it projects to the default CRS. If to_crs is None, it projects to an appropriate UTM zone.

### Parameters
- **G** (MultiDiGraph) - Required - The graph to be projected.
- **to_crs** (Any | None) - Optional - The target CRS. If None, projects to an appropriate UTM zone.
- **to_latlong** (bool) - Optional - If True, projects to settings.default_crs and ignores to_crs.

### Returns
- **networkx.MultiDiGraph** - The projected graph.
```

--------------------------------

### osmnx.graph module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.graph module, which are used for creating, manipulating, and analyzing street networks.

```APIDOC
## osmnx.graph module

This module provides core functionalities for downloading, creating, and working with street network graphs.
```

--------------------------------

### osmnx.convert.to_digraph

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Converts a MultiDiGraph to a DiGraph by selecting parallel edges based on a weight attribute.

```APIDOC
## osmnx.convert.to_digraph(G, *, weight='length')

### Description
Convert MultiDiGraph to DiGraph. Chooses between parallel edges by minimizing the specified weight attribute value.

### Parameters
- **G** (MultiDiGraph) - Required - Input graph.
- **weight** (str) - Optional - Attribute value to minimize when choosing between parallel edges.

### Returns
- **D** (networkx.DiGraph) - The converted DiGraph.
```

--------------------------------

### osmnx.truncate module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.truncate module, which are used for truncating or clipping network graphs.

```APIDOC
## osmnx.truncate module

This module contains functions for truncating or clipping network graphs to specific boundaries.
```

--------------------------------

### osmnx.io.save_graphml

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Saves a graph to disk as a GraphML file.

```APIDOC
## osmnx.io.save_graphml(G, filepath=None, *, gephi=False, encoding='utf-8')

### Description
Save graph to disk as GraphML file.

### Parameters
- **G** (MultiDiGraph) - Required - The graph to save.
- **filepath** (str | Path | None) - Optional - Path to the saved file.
- **gephi** (bool) - Optional - Whether to format for Gephi.
- **encoding** (str) - Optional - The character encoding.
```

--------------------------------

### osmnx.distance module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.distance module, which are used for calculating distances between geographic points.

```APIDOC
## osmnx.distance module

This module contains functions for calculating distances between geographic locations.
```

--------------------------------

### osmnx.stats.circuity_avg(Gu)

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Calculates the average street circuity using edges of an undirected graph.

```APIDOC
## osmnx.stats.circuity_avg(Gu)

### Description
Calculate average street circuity using edges of undirected graph. Circuity is the sum of edge lengths divided by the sum of straight-line distances between edge endpoints.

### Parameters
- **Gu** (MultiGraph) - Required - Undirected input graph.

### Returns
- **float | None** - The graph's average undirected edge circuity.
```

--------------------------------

### osmnx.projection.project_geometry

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Projects a Shapely geometry from its current CRS to another.

```APIDOC
## osmnx.projection.project_geometry(geom, *, crs=None, to_crs=None, to_latlong=False)

### Description
Project a Shapely geometry from its current CRS to another. If to_latlong is True, it projects to the default CRS. If to_crs is None, it projects to an appropriate UTM zone.

### Parameters
- **geom** (Geometry) - Required - The geometry to be projected.
- **crs** (Any | None) - Optional - The initial CRS of the geometry. Defaults to settings.default_crs if None.
- **to_crs** (Any | None) - Optional - The target CRS. If None, projects to an appropriate UTM zone.
- **to_latlong** (bool) - Optional - If True, projects to settings.default_crs and ignores to_crs.

### Returns
- **tuple[shapely.Geometry, Any]** - The projected geometry and its new CRS.
```

--------------------------------

### osmnx.geocoder module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.geocoder module, which are used for geocoding and reverse geocoding addresses and places.

```APIDOC
## osmnx.geocoder module

This module contains functions for geocoding and reverse geocoding locations.
```

--------------------------------

### osmnx.utils_geo.sample_points

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Randomly samples points constrained to a spatial graph.

```APIDOC
## osmnx.utils_geo.sample_points(G, n)

### Description
Randomly sample points constrained to a spatial graph. This method accounts for the graph’s geometry and guarantees uniform randomness.

### Parameters
- **G** (MultiGraph) - Required - Graph from which to sample points. Should be undirected and projected.
- **n** (int) - Required - How many points to sample.

### Returns
- **points** (MultiIndex) - The sampled points, multi-indexed by (u, v, key) of the edge from which each point was sampled.
```

--------------------------------

### osmnx.plot module

Source: https://osmnx.readthedocs.io/en/stable/_sources/user-reference.rst.txt

This section details the functions available in the osmnx.plot module, which are used for visualizing street networks and related data.

```APIDOC
## osmnx.plot module

This module provides functions for plotting and visualizing network data.
```

--------------------------------

### osmnx.projection.project_gdf

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Projects a GeoDataFrame from its current CRS to another.

```APIDOC
## osmnx.projection.project_gdf(gdf, *, to_crs=None, to_latlong=False)

### Description
Project a GeoDataFrame from its current CRS to another. If to_latlong is True, it projects to the default CRS. If to_crs is None, it projects to an appropriate UTM zone.

### Parameters
- **gdf** (GeoDataFrame) - Required - The GeoDataFrame to be projected.
- **to_crs** (Any | None) - Optional - The target CRS. If None, projects to an appropriate UTM zone.
- **to_latlong** (bool) - Optional - If True, projects to settings.default_crs and ignores to_crs.

### Returns
- **geopandas.GeoDataFrame** - The projected GeoDataFrame.
```

--------------------------------

### osmnx.stats.streets_per_node_avg(G)

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Calculate the average number of streets per node in a graph.

```APIDOC
## osmnx.stats.streets_per_node_avg(G)

### Description
Calculate graph's average count of streets per node.

### Parameters
- **G** (MultiDiGraph) - Required - Input graph.

### Returns
- **spna** (float) - Average count of streets per node.
```

--------------------------------

### osmnx.stats.intersection_count(G, min_streets=2)

Source: https://osmnx.readthedocs.io/en/stable/user-reference.html

Counts the number of intersections in a graph based on a minimum number of incident streets.

```APIDOC
## osmnx.stats.intersection_count(G, min_streets=2)

### Description
Count the intersections in a graph. Intersections are defined as nodes with at least min_streets number of streets incident on them.

### Parameters
- **G** (MultiDiGraph) - Required - Input graph.
- **min_streets** (int) - Required - A node must have at least min_streets incident on them to count as an intersection.

### Returns
- **int** - Count of intersections in graph.
```
Tokens:
Raw