Run R-Abimo, the R-implementation of Water Balance Model Abimo

Usage

run_rabimo(data, config, controls = define_controls(), silent = FALSE)

Arguments

data: data frame similar to rabimo_inputs_2025$data
config: configuration object (list) similar to rabimo_inputs_2025$config
controls: list of settings that control how the function should behave. Use define_controls to define such a list. The default is the list returned by define_controls().
silent: logical indicating whether to suppress console outputs, the default is FALSE

Value

data frame with columns as returned by Abimo

Examples

# Get input data and config for Berlin (version 2020)
inputs_2020 <- kwb.rabimo::rabimo_inputs_2020

# Randomly select 1000 blocks (to reduce runtime)
data <- inputs_2020$data
data <- data[sample(seq_len(nrow(data)), size = 1000L), ]

# Run R-Abimo
results_2020 <- kwb.rabimo::run_rabimo(data, inputs_2020$config)
#> Collecting climate related data ... ok. (0.00 secs) 
#> Preparing soil property data for all block areas ... ok. (0.02 secs) 
#> Precalculating actual evapotranspirations for impervious areas ... ok. (0.13 secs) 
#> Precalculating actual evapotranspirations for waterbodies or pervious areas ... ok. (0.03 secs) 

# Get input data and config for Berlin (version 2025)
inputs_2025 <- kwb.rabimo::rabimo_inputs_2025

# Crop a box (to reduce runtime)
data <- crop_box(inputs_2025$data)
#> Warning: attribute variables are assumed to be spatially constant throughout all geometries

# Run R-Abimo
results_2025 <- kwb.rabimo::run_rabimo(data, inputs_2025$config)
#> Collecting climate related data ... ok. (0.00 secs) 
#> Preparing soil property data for all block areas ... ok. (0.18 secs) 
#> Precalculating actual evapotranspirations for impervious areas ... ok. (0.27 secs) 
#> Precalculating actual evapotranspirations for waterbodies or pervious areas ... ok. (0.05 secs) 
  
plot(results_2025[, -1L])