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 in beta: 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. (2024). `Modeling and Analyzing Urban Networks and Amenities with OSMnx`_. Working paper. https://geoffboeing.com/publications/osmnx-paper/ .. _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 OSMnx `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 Documentation ------------- .. toctree:: :maxdepth: 1 getting-started .. toctree:: :maxdepth: 1 installation .. toctree:: :maxdepth: 1 user-reference .. toctree:: :maxdepth: 1 internals-reference .. toctree:: :maxdepth: 1 further-reading Indices ------- * :ref:`genindex` * :ref:`modindex` * :ref:`search`