Skip to content

Commit

Permalink
Merge pull request #1176 from gboeing/docs
Browse files Browse the repository at this point in the history
update docs
  • Loading branch information
gboeing authored May 17, 2024
2 parents d9c0541 + b8bcadc commit a99fc4d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs/source/further-reading.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Further Reading
===============

Boeing, G. (2024). `Modeling and Analyzing Urban Networks and Amenities with OSMnx`_. Working paper. https://geoffboeing.com/publications/osmnx-paper/
Boeing, G. (2024). `Modeling and Analyzing Urban Networks and Amenities with OSMnx`_. Working paper.

This is the official citation for the project.
This is the official reference paper and citation for the project.

.. _Modeling and Analyzing Urban Networks and Amenities with OSMnx: https://geoffboeing.com/publications/osmnx-paper/

Expand Down
8 changes: 6 additions & 2 deletions docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,12 @@ Visualization

You can plot graphs, routes, network figure-ground diagrams, building footprints, and street network orientation rose diagrams (aka, polar histograms) with the :code:`plot` module. You can also explore street networks, routes, or geospatial features as interactive `Folium`_ web maps.


Usage Limits
^^^^^^^^^^^^

Refer to the `Nominatim Usage Policy`_ and `Overpass Commons`_ documentation for usage limitations and restrictions to which you must adhere. If you use an alternative Nominatim/Overpass instance, ensure you understand and follow their usage policies. If you need to exceed these limitations, consider installing your own hosted instance and setting OSMnx to use it.

More Info
---------

Expand All @@ -128,8 +134,6 @@ Frequently Asked Questions

*I have a usage question.* Please ask it on `StackOverflow`_.

*Are there any usage limitations?* Yes. Refer to the `Nominatim Usage Policy`_ and `Overpass Commons`_ documentation for usage limitations and restrictions that you must adhere to at all times. If you use an alternative Nominatim/Overpass instance, ensure you understand and obey their usage policies. If you need to exceed these limitations, consider installing your own hosted instance and setting OSMnx to use it.

.. _Examples Gallery: https://github.com/gboeing/osmnx-examples
.. _GeoPandas: https://geopandas.org
.. _NetworkX: https://networkx.org
Expand Down
4 changes: 2 additions & 2 deletions docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ You can run OSMnx + JupyterLab directly from the official OSMnx `Docker`_ image.
Pip
---

You may be able to install OSMnx with `pip`_ (in a virtual environment) but this is not officially supported. OSMnx is written in pure Python and its installation alone is thus trivially simple if you already have its dependencies installed and tested on your system. OSMnx depends on other packages written in C, and installing those dependencies with pip is sometimes challenging depending on your specific system's configuration. Therefore, if you're not sure what you're doing, just follow the conda instructions above to avoid installation problems.
You may be able to install OSMnx with `pip`_ (in a virtual environment) but this is not officially supported. OSMnx is written in pure Python and its installation alone is thus trivially simple if you already have its dependencies installed and tested on your system. OSMnx depends on packages that in turn depend on C/C++ libraries, and installing those dependencies with pip is sometimes challenging depending on your specific system's configuration. If you're not sure what you're doing, just follow the conda instructions above to avoid installation problems.

.. _conda: https://conda.io/
.. _conda-forge: https://conda-forge.org/
.. _Docker: https://hub.docker.com/r/gboeing/osmnx
.. _pip: https://pypi.org/project/osmnx/
.. _pip: https://pip.pypa.io/

0 comments on commit a99fc4d

Please sign in to comment.