hydromt_wflow.WflowModel¶
- class hydromt_wflow.WflowModel(root=None, mode='w', config_fn=None, data_libs=None, deltares_data=False, logger=<Logger hydromt_wflow.wflow (WARNING)>)[source]¶
This is the wflow model class
- __init__(root=None, mode='w', config_fn=None, data_libs=None, deltares_data=False, logger=<Logger hydromt_wflow.wflow (WARNING)>)[source]¶
Methods
__init__
([root, mode, config_fn, data_libs, …])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])Parse config from file.
Read forcing
read_intbl
(**kwargs)Read and intbl files at <root/intbl> and parse to xarray
Read results at <root/?/> and parse to dict of xr.DataArray/xr.Dataset
Read states at <root/?/> and parse to dict of xr.DataArray
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, split_dataset])Add data to results attribute which is a dictionary of xarray.DataArray and/or xarray.Dataset.
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_areamap
(area_fn, col2raster)Setup area map from vector data to save wflow outputs for specific area.
setup_basemaps
(region[, res, …])This component sets the
region
of interest andres
(resolution in degrees) of the model.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, …])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_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, ptf_ksatver])This component derives several (layered) soil parameters based on a database with physical soil properties using available point-scale (pedo)transfer functions (PTFs) from literature with upscaling rules to ensure flux matching across scales.
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
([fn_out, chunksize, decimals])write forcing at fn_out 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 at <root/?/> in model ready format
Write staticmaps at <root/staticgeoms> in model ready format
Write staticmaps
write_staticmaps_pcr
()Write staticmaps at <root/staticmaps> in PCRaster maps format.
Attributes
Returns a basin(s) geometry as a geopandas.GeoDataFrame.
bounds
Returns shape of staticmaps.
Returns parsed model configuration.
coords
Returns coordinates of staticmaps.
Returns coordinate reference system embedded in staticmaps.
dims
Returns spatial dimension names of staticmaps.
Returns the pyflwdir.FlwdirRaster object parsed from the wflow ldd.
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.
Returns geometry of region of the model area of interest.
Returns coordinates of staticmaps.
dict xarray.dataarray representation of model results
Returns a river geometry as a geopandas.GeoDataFrame.
Path to model folder.
shape
Returns shape of staticmaps.
dict xarray.dataarray representation of all states
geopandas.GeoDataFrame representation of all model geometries
xarray.Dataset representation of all static parameter maps
transform
Returns spatial transform staticmaps.
width
Returns width of staticmaps.