hydromt_sfincs.plots.plot_basemap#

hydromt_sfincs.plots.plot_basemap(ds: ~xarray.core.dataset.Dataset | ~xugrid.core.wrap.UgridDataset, geoms: ~typing.Dict, variable: str = 'dep', shaded: bool = False, plot_bounds: bool = True, plot_region: bool = False, plot_geoms: bool = True, bmap: str = None, zoomlevel: int = 'auto', figsize: ~typing.Tuple[int] = None, geom_names: ~typing.List[str] = None, geom_kwargs: ~typing.Dict = {}, legend_kwargs: ~typing.Dict = {}, bmap_kwargs: ~typing.Dict = {}, logger=<Logger hydromt_sfincs.plots (WARNING)>, **kwargs)[source]#

Create basemap plot.

Parameters:

ds (xr.Dataset) – Dataset with model maps
geoms (Dict of geopandas.GeoDataFrame) – Model geometries
variable (str, optional) – Map of variable in ds to plot, by default ‘dep’
shaded (bool, optional) – Add shade to variable (only for variable = ‘dep’), by default False
plot_bounds (bool, optional) – Add waterlevel (mask=2) and open (mask=3) boundary conditions to plot.
plot_region (bool, optional) – If True, plot region outline.
plot_geoms (bool, optional) – If True, plot available geoms.
bmap (str, optional) – background map souce name, by default None Default image tiles “sat”, and “osm” are fetched from cartopy image tiles. If contextily is installed, xyzproviders tiles can be used as well.
zoomlevel (int, optional) – zoomlevel, by default ‘auto’
figsize (Tuple[int], optional) – figure size, by default None
geom_names (List[str], optional) – list of model geometries to plot, by default all model geometries
geom_kwargs (Dict of Dict, optional) – Model geometry styling per geometry, passed to geopandas.GeoDataFrame.plot method. For instance: {‘src’: {‘markersize’: 30}}.
legend_kwargs (Dict, optional) – Legend kwargs, passed to ax.legend method.

Returns:

Model fig and ax objects

Return type:

fig, axes