Predefined methods#

Model methods#

These methods are used to build, preprocess, run and postprocess models. Currently the SFINCS hydrodynamic model, Wflow hydrological model, Delft-FIAT flood impact model are supported.

`fiat.fiat_build`	Build a FIAT model from scratch using hydromt_fiat.
`fiat.fiat_update`	Method for updating a FIAT model with hazard maps.
`fiat.fiat_run`	Method for running a FIAT model.
`fiat.fiat_visualize`	Method for visualizing FIAT model results.
`sfincs.sfincs_region`	Define a SFINCS model region based on hydrological subbasins.
`sfincs.sfincs_build`	Build a SFINCS model from scratch using hydromt_sfincs.
`sfincs.sfincs_update_forcing`	Method to update SFINCS forcing.
`sfincs.sfincs_run`	Method for running a SFINCS model.
`sfincs.sfincs_downscale`	Downscale SFINCS simulated waterlevels to high res water depths.
`sfincs.sfincs_postprocess`	Postprocess SFINCS netcdf maximum water level (zsmax) output to a regular grid geotiff file.
`wflow.wflow_build`	Build a Wflow model from scratch using hydromt_wflow.
`wflow.wflow_update_forcing`	Method to update the Wflow meteorological forcing.
`wflow.wflow_update_factors`	Downscale a climate change factor dataset to the resolution of a wflow model and add to settings file.
`wflow.wflow_run`	Wflow run method.
`flood_adapt.setup_flood_adapt`	Prepare FloodAdapt database builder.
`flood_adapt.prep_sfincs_models`	Prepare a SFINCS model for usage in FloodAdapt.

Historical, future and design event methods#

These methods are used to generate Event and Eventset data which are used as input for the hydrodynamic and impact models.

`coastal.coastal_design_events_from_rp_data`	Derive coastal design events from tide, surge timeseries and return period dataset.
`coastal.coastal_design_events`	Create hydrographs for coastal waterlevels.
`coastal.future_slr`	Derive future (climate) sea level (rise) events by applying a user-specified offset to an event.
`discharge.fluvial_design_events`	Derive fluvial design events from a discharge time series.
`historical_events.historical_events`	Method to derive historical events with one or more drivers from timeseries data.
`rainfall.future_climate_rainfall`	Method to deriving future climate rainfall by scaling an historical event using Clausius-Clapeyron (CC).
`rainfall.pluvial_design_events`	Pluvial design events method.
`rainfall.pluvial_design_events_GPEX`	Method for generating pluvial design events based on the GPEX global IDF dataset.

Data pre- and postprocessing methods#

These methods are used to download, preprocess or postprocess various data sources.

`catalog.merge_catalogs`	Merge multiple data catalogs into one method.
`climate.climatology`	Method for creating monthly climatology from gridded climate data.
`climate.change_factor`	Method for calculating future change factors.
`coastal.coastal_tidal_analysis`	Derive tide and surge from waterlevel timeseries based on a tidal analysis.
`coastal.get_coast_rp`	Method for fetching and processing COAST-RP dataset for a given region.
`coastal.get_gtsm_data`	Method for fetching GTSM waterlevel and surge timeseries for a given region.
`hazard_validation.floodmarks`	Validate simulated hazard based on floodmarks.
`rainfall.get_ERA5_rainfall`	Get ERA5 rainfall timeseries data for a region center point.
`raster.merge`	Merge multiple (climate) datasets into one using quantile reduction.

Python script methods#

Python scripts can directly be added to a workflow using the ScriptMethod class. For usage and limitations see Using python scripts as methods.

script.script_method

Method to run python script with HydroFlows.

Dummy methods#

These methods are used for documentation and testing purposes only.

`dummy.combine_dummy_events`	"Dummy methods for testing and user documentation.
`dummy.postprocess_dummy_event`	Dummy methods for testing and user documentation.
`dummy.prepare_dummy_events`	"Dummy methods for testing and user documentation.
`dummy.run_dummy_event`	"Dummy methods for testing and user documentation.