Skip to content

Commit e7067d8

Browse files
authored
Update README.md
1 parent 93cb90b commit e7067d8

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,24 @@
22

33
[![GitHub tag](https://img.shields.io/github/v/tag/gboeing/osmnx-examples?label=Uses+OSMnx)](https://github.com/gboeing/osmnx)
44
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/gboeing/osmnx-examples/)
5-
[![Build Status](https://github.com/gboeing/osmnx-examples/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/gboeing/osmnx-examples/actions/workflows/tests.yml)
5+
[![Build Status](https://github.com/gboeing/osmnx-examples/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/gboeing/osmnx-examples/actions/workflows/ci.yml)
66

77
## Overview
88

99
[OSMnx](https://github.com/gboeing/osmnx) is a Python package to easily download, model, analyze, and visualize street networks and other geospatial features from OpenStreetMap. You can download and model walking, driving, or biking networks with a single line of code then analyze and visualize them. You can just as easily work with urban amenities/points of interest, building footprints, transit stops, elevation data, street orientations, speed/travel time, and routing.
1010

11-
OSMnx 2.0 is released: read the [migration guide](https://github.com/gboeing/osmnx/issues/1123).
12-
1311
## Usage
1412

1513
This gallery contains step-by-step usage tutorials and feature demonstrations as Jupyter notebooks. You can run these notebooks interactively online with [Colab](https://colab.research.google.com/github/gboeing/osmnx-examples/) or locally with the official OSMnx [Docker image](https://hub.docker.com/r/gboeing/osmnx). All of the examples are in this repo's [notebooks](notebooks) folder. Note that this repo's main branch generally tracks the functionality of the OSMnx repo's main branch. For examples corresponding to previously released versions of OSMnx, use this repo's tags to browse by release.
1614

15+
## Citation
16+
17+
If you use OSMnx in your work, please cite the paper:
18+
19+
Boeing, G. (2025). [Modeling and Analyzing Urban Networks and Amenities with OSMnx](https://doi.org/10.1111/gean.70009). *Geographical Analysis* 57 (4), 567-577. doi:10.1111/gean.70009
20+
1721
## More info
1822

1923
- [Documentation](https://osmnx.readthedocs.io/)
20-
- [Journal article and citation info](https://doi.org/10.1111/gean.70009)
24+
- [Journal article](https://doi.org/10.1111/gean.70009)
2125
- [Code repository](https://github.com/gboeing/osmnx)

0 commit comments

Comments
 (0)