hydromt_wflow.wflow_sediment.WflowSedimentModel

class hydromt_wflow.wflow_sediment.WflowSedimentModel(root=None, mode='w', config_fn=None, data_libs=None, deltares_data=False, logger=<Logger hydromt_wflow.wflow_sediment (WARNING)>)

This is the wflow sediment model class, a subclass of WflowModel

__init__(root=None, mode='w', config_fn=None, data_libs=None, deltares_data=False, logger=<Logger hydromt_wflow.wflow_sediment (WARNING)>)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__([root, mode, config_fn, data_libs, …])	Initialize self.
build(region[, res, write, opt])	Single method to setup and write a full model schematization and configuration from scratch
clip_forcing([crs])	Return clippped forcing for subbasin.
clip_staticmaps(region[, buffer, align, crs])	Clip staticmaps to subbasin.
get_config(*args[, fallback, abs_path])	Get a config value at key(s).
read()	Method to read the complete model schematization and configuration from file.
read_config([config_fn])	Initialize default config and fill with config at <config_fn>
read_forcing()	Read forcing
read_intbl(**kwargs)	Read and intbl files at <root/intbl> and parse to xarray
read_results()	Read results at <root/?/> and parse to dict of xr.DataArray
read_states()	Read states at <root/?/> and parse to dict of xr.DataArray
read_staticgeoms()	Read and staticgeoms at <root/staticgeoms> and parse to geopandas
read_staticmaps(**kwargs)	Read staticmaps
read_staticmaps_pcr([crs])	Read and staticmaps at <root/staticmaps> and parse to xarray
set_config(*args)	Update the config dictionary at key(s) with values.
set_crs(crs)	Embed coordinate reference system staticmaps metadata.
set_flwdir([ftype])	Parse pyflwdir.FlwdirRaster object parsed from the wflow ldd
set_forcing(data[, name])	Add data to forcing attribute which is a dictionary of xarray.DataArray.
set_intbl(df, name)	Add intbl <pandas.DataFrame> to model.
set_results(data[, name])	Add data to results attribute which is a dictionary of xarray.DataArray.
set_root(root[, mode])	Initialized the model root.
set_states(data[, name])	Add data to states attribute which is a dictionary of xarray.DataArray.
set_staticgeoms(geom, name)	Add geom to staticmaps
set_staticmaps(data[, name])	Add data to staticmaps
setup_basemaps(region[, res, …])	This component sets the region of interest and res (resolution in degrees) of the model.
setup_canopymaps([canopy_fn])	Setup sediments based canopy height maps.
setup_config(**cfdict)	Update config with a dictionary
setup_constant_pars(**kwargs)	Setup constant parameter maps.
setup_gauges([gauges_fn, source_gdf, …])	This components sets the default gauge map based on basin outlets and additional gauge maps based on gauges_fn data.
setup_glaciers([glaciers_fn, min_area])	This component generates maps of glacier areas, area fraction and volume fraction, as well as tables with temperature thresohld, melting factor and snow-to-ice convertion fraction.
setup_laimaps([lai_fn])	This component sets leaf area index (LAI) climatoloy maps per month.
setup_lakes([lakes_fn, min_area])	This component generates maps of lake areas and outlets as well as parameters with average lake area, depth a discharge values.
setup_lulcmaps([lulc_fn, lulc_mapping_fn, …])	This component derives several wflow maps are derived based on landuse- landcover (LULC) data.
setup_precip_forcing([precip_fn, precip_clim_fn])	Setup gridded precipitation forcing at model resolution.
setup_reservoirs([reservoirs_fn, min_area, …])	This component generates maps of lake areas and outlets as well as parameters with average reservoir area, demand, min and max target storage capacities and discharge capacity values.
setup_riverbedsed([bedsed_mapping_fn])	Setup sediments based river bed characteristics maps.
setup_rivers([hydrography_fn, river_upa, …])	This component sets the river parameter maps including a boolean river mask, length, slope.
setup_riverwidth([predictor, fill, fit, …])	This component sets the river width parameter based on a power-lay relationship with a predictor.
setup_soilmaps([soil_fn, usleK_method])	Setup sediments based soil parameter maps.
setup_temp_pet_forcing([temp_pet_fn, …])	Setup gridded reference evapotranspiration forcing at model resolution.
test_model_api()	Test compliance to model API instances.
update([model_out, write, opt])	Single method to setup and write a full model schematization and configuration from scratch
write()	Method to write the complete model schematization and configuration to file.
write_config([config_name, config_root])	Write config to <root/config_fn>
write_forcing()	write forcing at <root/?/> in model ready format
write_intbl()	Write intbl at <root/intbl> in PCRaster table format.
write_results()	write results at <root/?/> in model ready format
write_states()	write states at <root/?/> in model ready format
write_staticgeoms()	Write staticmaps at <root/staticgeoms> in model ready format
write_staticmaps()	Write staticmaps
write_staticmaps_pcr()	Write staticmaps at <root/staticmaps> in PCRaster maps format.

Attributes

basins	Returns a basin(s) geometry as a geopandas.GeoDataFrame.
bounds	Returns shape of staticmaps.
config	Returns parsed model configuration.
coords	Returns coordinates of staticmaps.
crs	Returns coordinate reference system embedded in staticmaps.
dims	Returns spatial dimension names of staticmaps.
flwdir	Returns the pyflwdir.FlwdirRaster object parsed from the wflow ldd.
forcing	dict of xarray.dataarray representation of all forcing
height	Returns height of staticmaps.
intbl	Returns a dictionary of pandas.DataFrames representing the wflow intbl files.
region	Returns geometry of region of the model area of interest.
res	Returns coordinates of staticmaps.
results	dict xarray.dataarray representation of model results
rivers	Returns a river geometry as a geopandas.GeoDataFrame.
root	Path to model folder.
shape	Returns shape of staticmaps.
states	dict xarray.dataarray representation of all states
staticgeoms	geopandas.GeoDataFrame representation of all model geometries
staticmaps	xarray.dataset representation of all parameter maps
transform	Returns spatial transform staticmaps.
width	Returns width of staticmaps.