From 686baf0bc83003bee4a768e502fda9bf91a022ea Mon Sep 17 00:00:00 2001 From: Geoff Boeing Date: Sun, 29 Oct 2023 16:04:07 -0700 Subject: [PATCH] update docs to refer to server usage limitations --- README.md | 2 +- docs/source/getting-started.rst | 6 +++++- docs/source/index.rst | 2 +- osmnx/features.py | 2 ++ osmnx/graph.py | 9 ++++++++- 5 files changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 68a7f0e2a..4c31e4b71 100644 --- a/README.md +++ b/README.md @@ -31,4 +31,4 @@ If you have any trouble, consult the [User Reference](https://osmnx.readthedocs. ## License -OSMnx is open source and licensed under the MIT license. OpenStreetMap's open data [license](https://www.openstreetmap.org/copyright/) requires that derivative works provide proper attribution. +OSMnx is open source and licensed under the MIT license. OpenStreetMap's open data [license](https://www.openstreetmap.org/copyright/) requires that derivative works provide proper attribution. Refer to the [Getting Started](https://osmnx.readthedocs.io/en/stable/getting-started.html) guide for usage limitations. diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst index 2c3e7cb8a..0c6d6da54 100644 --- a/docs/source/getting-started.rst +++ b/docs/source/getting-started.rst @@ -47,7 +47,7 @@ The `OSMnx Examples`_ gallery contains tutorials and demonstrations of all these Configuration ^^^^^^^^^^^^^ -You can configure OSMnx using the :code:`settings` module. Here you can adjust logging behavior, caching, server endpoints, and more. You can also configure OSMnx to retrieve historical snapshots of OpenStreetMap data as of a certain date. +You can configure OSMnx using the :code:`settings` module. Here you can adjust logging behavior, caching, server endpoints, and more. You can also configure OSMnx to retrieve historical snapshots of OpenStreetMap data as of a certain date. Refer to the FAQ below for server usage limitations. Geocoding and Querying ^^^^^^^^^^^^^^^^^^^^^^ @@ -130,6 +130,8 @@ 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. + .. _OSMnx Examples: https://github.com/gboeing/osmnx-examples .. _GeoPandas: https://geopandas.org .. _NetworkX: https://networkx.org @@ -150,3 +152,5 @@ Frequently Asked Questions .. _Changelog: https://github.com/gboeing/osmnx/blob/main/CHANGELOG.md .. _projects: https://geoffboeing.com/2018/03/osmnx-features-roundup .. _StackOverflow: https://stackoverflow.com/search?q=osmnx +.. _Nominatim Usage Policy: https://operations.osmfoundation.org/policies/nominatim/ +.. _Overpass Commons: https://dev.overpass-api.de/overpass-doc/en/preface/commons.html diff --git a/docs/source/index.rst b/docs/source/index.rst index 4c6a50f77..a85863949 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -40,7 +40,7 @@ If you have any trouble, consult the :doc:`user-reference`. The OSMnx repository License ------- -OSMnx is open source and licensed under the MIT license. OpenStreetMap's open data `license`_ requires that derivative works provide proper attribution. +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 diff --git a/osmnx/features.py b/osmnx/features.py index 2155a4483..4440fbc00 100644 --- a/osmnx/features.py +++ b/osmnx/features.py @@ -9,6 +9,8 @@ For more details, see https://wiki.openstreetmap.org/wiki/Map_features and https://wiki.openstreetmap.org/wiki/Elements + +Refer to the Getting Started guide for usage limitations. """ import logging as lg diff --git a/osmnx/graph.py b/osmnx/graph.py index 55177786e..c85d4e27d 100644 --- a/osmnx/graph.py +++ b/osmnx/graph.py @@ -1,4 +1,11 @@ -"""Download and create graphs from OpenStreetMap data.""" +""" +Download and create graphs from OpenStreetMap data. + +This module uses filters to query the Overpass API: you can either specify a +built-in network type or provide your own custom filter with Overpass QL. + +Refer to the Getting Started guide for usage limitations. +""" import itertools from warnings import warn