hydromt_sfincs.workflows.create_topobathy_tiles#

hydromt_sfincs.workflows.create_topobathy_tiles(root: str | ~pathlib.Path, region: ~geopandas.geodataframe.GeoDataFrame, elevation_list: ~typing.List[dict] | None = None, data_catalog=None, index_path: str | ~pathlib.Path = None, zoom_range: int | ~typing.List[int] = [0, 13], z_range: ~typing.List[int] = [-20000.0, 20000.0], fmt: str = 'bin', write_html_viewer: bool = True, max_workers: int | None = None, logger: ~logging.Logger = <Logger hydromt_sfincs.workflows.tiling (WARNING)>) → None[source]#

Create webmercator topobathy tiles for a given region.

Parameters:

  • root (Union[str, Path]) – Directory where the topobathy tiles will be stored.

  • region (gpd.GeoDataFrame) – GeoDataFrame defining the region for which the tiles will be created.

  • elevation_list (List[dict], optional) – List of dictionaries containing the bathymetry dataarrays. If None, falls back to data_catalog (all sources in the catalog are treated as elevation datasets).

  • data_catalog (hydromt.DataCatalog, optional) – Fallback data catalog used to build an elevation_list when elevation_list is None. Explicit elevation_list entries always win.

  • index_path (Union[str, Path], optional) – Directory where index tiles are stored, by default None

  • zoom_range (Union[int, List[int]], optional) – Range of zoom levels for which tiles are created, by default [0, 13]

  • z_range (List[int], optional) – Range of valid elevations, by default [-20000.0, 20000.0]

  • fmt (str, optional) – The desired output format of the topobathy tiles, by default “bin”. Also “png” and “tif” are supported.

  • write_html_viewer (bool, optional) – If True (default), also write an index.html Leaflet viewer alongside the tiles so they can be previewed in a browser.

On this page