1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
OSMnx |version|
===============
**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.
OSMnx 2.0 is released: read the `migration guide`_.
.. _migration guide: https://github.com/gboeing/osmnx/issues/1123
Citation
--------
If you use OSMnx in your work, please cite the paper:
Boeing, G. (2025). `Modeling and Analyzing Urban Networks and Amenities with OSMnx`_. *Geographical Analysis*, published online ahead of print. doi:10.1111/gean.70009
.. _Modeling and Analyzing Urban Networks and Amenities with OSMnx: https://geoffboeing.com/publications/osmnx-paper/
Getting Started
---------------
First read the :doc:`getting-started` guide for an introduction to the package and FAQ.
Then work through the `Examples Gallery`_ for step-by-step tutorials and sample code.
.. _Examples Gallery: https://github.com/gboeing/osmnx-examples
Installation
------------
Follow the :doc:`installation` guide to install OSMnx.
Support
-------
If you have any trouble, consult the :doc:`user-reference`. The OSMnx repository is hosted on `GitHub`_. If you have a "how-to" or usage question, please ask it on `StackOverflow`_, as we reserve the repository's issue tracker for bug tracking and feature development.
.. _GitHub: https://github.com/gboeing/osmnx
.. _StackOverflow: https://stackoverflow.com/search?q=osmnx
License
-------
OSMnx is open source and licensed under the MIT license. OpenStreetMap's open data `license`_ requires that derivative works provide proper attribution. Refer to the :doc:`getting-started` guide for usage limitations.
.. _license: https://www.openstreetmap.org/copyright
User Guides
-----------
.. toctree::
:maxdepth: 1
installation
.. toctree::
:maxdepth: 1
getting-started
.. toctree::
:maxdepth: 1
user-reference
.. toctree::
:maxdepth: 1
internals-reference
.. toctree::
:maxdepth: 1
further-reading
Indices
-------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
