BBBikeDownloader.get_subregion_index¶

classmethod BBBikeDownloader.get_subregion_index(update=False, confirmation_required=True, verbose=False, raise_error=False)[source]¶

Get a catalogue for geographic (sub)regions.

Parameters:

update (bool) – whether to (check on and) update the prepacked data, defaults to False
confirmation_required (bool) – whether asking for confirmation to proceed, defaults to True
verbose (bool | int) – whether to print relevant information in console, defaults to False
raise_error (bool) – Whether to raise the provided exception; if raise_error=False (default), the error will be suppressed.

Returns:

catalogue for subregions of BBBike data

Return type:

pandas.DataFrame | None

Examples:

>>> from pydriosm.downloader import BBBikeDownloader
>>> bbd = BBBikeDownloader()
>>> # A BBBike catalogue of geographic (sub)regions
>>> subregion_index = bbd.get_subregion_index()
>>> subregion_index.shape
(238, 3)
>>> subregion_index.head()
          name  ...                                                url
0       Aachen  ...     https://download.bbbike.org/osm/bbbike/Aachen/
1       Aarhus  ...     https://download.bbbike.org/osm/bbbike/Aarhus/
2     Adelaide  ...   https://download.bbbike.org/osm/bbbike/Adelaide/
3  Albuquerque  ...  https://download.bbbike.org/osm/bbbike/Albuque...
4   Alexandria  ...  https://download.bbbike.org/osm/bbbike/Alexand...
[5 rows x 3 columns]
>>> subregion_index.columns.to_list()
['name', 'last_modified', 'url']