From bd8b00809e7d62abb8f8be06e021cd2377193770 Mon Sep 17 00:00:00 2001 From: Geoff Boeing Date: Fri, 17 May 2024 10:51:15 -0700 Subject: [PATCH 1/2] update docs --- docs/source/further-reading.rst | 4 ++-- docs/source/getting-started.rst | 8 ++++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/source/further-reading.rst b/docs/source/further-reading.rst index d46a21fe0..402ac01fc 100644 --- a/docs/source/further-reading.rst +++ b/docs/source/further-reading.rst @@ -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/ diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index 14cf40d5d..4e268fe79 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -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 --------- @@ -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 From b8bcadc44e037873008af852b76ec41359e9fd4c Mon Sep 17 00:00:00 2001 From: Geoff Boeing Date: Fri, 17 May 2024 11:12:45 -0700 Subject: [PATCH 2/2] update docs --- docs/source/installation.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index da53ac5a7..b0b5ca0c8 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -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/