hydromt_sfincs.SfincsModel.plot_basemap#

SfincsModel.plot_basemap(fn_out: str = None, variable: str | DataArray = 'elevation', shaded: bool = False, plot_bounds: bool = True, plot_region: bool = False, plot_geoms: bool = True, bmap: str = None, zoomlevel: int = 'auto', figsize: Tuple[int] = None, geom_names: List[str] = None, geom_kwargs: Dict = {}, legend_kwargs: Dict = {}, **kwargs)[source]#

Create basemap plot.

Parameters:

fn_out (str, optional) – Path to output figure file, by default None. If a basename is given it is saved to <model_root>/figs/<fn_out> If None, no file is saved.
variable (str, xr.DataArray, optional) – Map of variable in ds to plot, by default ‘dep’ Alternatively, provide a xr.DataArray
shaded (bool, optional) – Add shade to variable (only for variable = ‘dep’ and non-rotated grids), 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