User Guide

Inputs

To run RUBEM, several sets of input data are required. Check the specification and preprocessing of the model’s input files.

These input files are listed in a model configuration file that points to the locations of these input files and parameter sets that govern the simulation. Check a model configuration template file.

Model General Settings

Project Directories

Data Output Directory

Mandatory path to the output folder. Must be a valid path to an existing empty directory.

[DIRECTORIES]
output = /Dataset/UIGCRB/output/

Digital Elevation Map (DEM)

Mandatory path to Digital Elevation Map (DEM) file [masl] in PCRaster map format *.map: this map contains topographic ground elevation in meters. Must be a valid file path to a PCRaster map format *.map file. See more.

[RASTERS]
dem = /Dataset/UIGCRB/input/maps/dem/dem.map

Mask of Catchment (Clone)

Mandatory path to Mask of Catchment (Clone) file in PCRaster map format *.map. This map defines the basin area to simulate in the model. Must be a valid file path to a PCRaster boolean map format file. See more.

[RASTERS]
clone = /Dataset/UIGCRB/input/maps/clone/clone.map

Local Drain Direction (LDD)

Optional path to Local Drain Direction (LDD) file in PCRaster map format *.map. This map contains the local flow direction of each cell in the catchment. Must be a valid file path to a PCRaster map format *.map file. See more.

Warning

If not specified in the simulation configuration, it will be automatically generated using lddcreate from PCRaster.

In some circumstances, it may happen that PCRaster generates different LDDs each time the model runs (difference in value in a few pixels), so the stipulated demand zones may present different values between runs. In this case, it is recommended to use the same LDD for all runs.

[RASTERS]
ldd = /Dataset/UIGCRB/input/maps/ldd/ldd.map

Gauge Station Location Map

Export Results to Station Locations Map

Optional, if enabled, export time series data of selected output variables (comma-separated values *.csv files) for each valid pixel in stations maps. A station location map file must be defined.

[GENERATE_FILE]
tss = True

Stations Locations (Samples)

Mandatory if Export Results to Station Locations is enabled. Path to Stations file in PCRaster map format *.map and nominal format. This file is a nominal map with unique Ids for cells identified as being a location where time-series output is required. Non-station cells have a value of -9999. Must be a valid path to an existing PCRaster map format *.map file. See more.

[RASTERS]
samples = /Dataset/UIGCRB/input/maps/postosFlu/stationsFluCalib.map

Grid

Mandatory cell dimension value in meters. Value has to correspond to the pixel resolution of the dataset’s DEM map file.

[GRID]
grid = 500.0

Simulation Period

Warning

All dates must be valid and fall within between the time period of the dataset input time range.

Start Date

Mandatory date of the first time step of the simulation scenario (day, month and year of the start period of simulation scenario).

[SIM_TIME]
start = 01/01/2000

Warning

The start date must be less than the end date.

End Date

Mandatory date of the last time step of the simulation scenario (day, month and year of the last period of simulation scenario).

[SIM_TIME]
end = 01/08/2000

Warning

The end date must be greater than the start date.

Alignment Date

Optional date of the alignment time step of the simulation scenario (day, month and year of the alignment period of simulation scenario). If not specified, the alignment date will be the same as the start date.

[SIM_TIME]
alignment = 01/01/2000

Warning

The alignment date must be before the start date.

Note

In certain scenarios, modelers may need to initiate simulations from a date other than the one corresponding to file *.001. This will allow the transformation of time steps accordingly, ensuring alignment with the desired starting date for the simulation.

Soil Parameters

Soil Map

Mandatory path to Soil map in PCRaster map format *.map and nominal format. It represents the soil classes of the study area. The number of classes is defined by the user and is related to hydraulic properties. Must be a valid path to an existing PCRaster map format *.map file. See more.

[RASTER]
soil = /Dataset/UIGCRB/input/maps/soil/soil.map

Bulk Density

Mandatory path to a tabular file with values [g/cm³] of Bulk density for each soil class. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
bulk_density = /Dataset/UIGCRB/input/txt/soil/dg.txt

Saturated Hydraulic Conductivity (K_SAT)

Mandatory path to a tabular file with values [mm/month] of saturated hydraulic conductivity for each soil class. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
K_sat = /Dataset/UIGCRB/input/txt/soil/Tsat.txt

Field Capacity (θ_FC)

Mandatory path to a tabular file with values [θ (cm³/cm³)] of field capacity water content (θ) for each soil class. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
T_fcap = /Dataset/UIGCRB/input/txt/soil/Tcc.txt

Wilting Point (θ_WP)

Mandatory path to a tabular file with values [θ (cm³/cm³)] of Wilting Point for each soil class. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
T_wp = /Dataset/UIGCRB/input/txt/soil/Tw.txt

Saturated Content (θ_SAT)

Mandatory path to a tabular file with values [θ (cm³/cm³)] of saturated content for each soil class. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
T_sat = /Dataset/UIGCRB/input/txt/soil/Tsat.txt

Depth Rootzone

Mandatory path to a tabular file with values [cm] of depth rootzone for each soil class. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
rootzone_depth = /Dataset/UIGCRB/input/txt/soil/Zr.txt

Initial Soil Conditions

Initial Baseflow

Mandatory float value [mm] representing the baseflow (in the cell) at the beginning of the simulation. See Baseflow for more details.

\[BF_{ini} = \frac{Q \cdot t}{A \cdot N_{cell}} \cdot 10^{-3}\]

where:

\(BF_{ini}\) - Initial baseflow (mm);
\(t\) - Number of seconds in a month (86,400s);
\(Q\) - Mean discharge in the gauge station (m³/s);
\(A\)- Contribution area of the gauge station (m²);
\(N_{cell}\) - Number of cells of the contribution area (calculated by the ratio of \(A\) and the grid area (m²)).

[INITIAL_SOIL_CONDITIONS]
bfw_ini = 10.0

Baseflow Threshold

Mandatory float value [mm] representing the minimum water store in the saturated zone for generating Baseflow. See Baseflow for more details. It can be set using the minimum discharge at the gauge station by the relation:

\[BF_{thresh} = \frac{Q_{min} \cdot t}{A \cdot N_{cell}} \cdot 10^{-3}\]

where:

\(BF_{thresh}\) - Baseflow threshold(mm);
\(t\) - Number of seconds in a month (86,400s);
\(Q_{min}\) - Minimum discharge in the gauge station (m³/s);
\(A\)- Contribution area of the gauge station (m²);
\(N_{cell}\) - Number of cells of the contribution area (calculated by the ratio of \(A\) and the grid area (m²)).

[INITIAL_SOIL_CONDITIONS]
bfw_lim = 5.0

Initial Soil Moisture Content (θ_INI)

Mandatory float value [θ (cm³/cm³)] representing the Rootzone Soil Moisture Content value at the beginning of the simulation.

[INITIAL_SOIL_CONDITIONS]
T_ini = 0.5

Initial Saturated Zone Storage (S_SAT)

Mandatory Saturated Zone Moisture Content value [mm] at the beginning of the simulation.

Warning

To generate baseflow at the initial step this value must be much greater than the baseflow threshold (\(S_{sat} \gg BF_{thresh}\)), see Baseflow Threshold.

[INITIAL_SOIL_CONDITIONS]
S_sat_ini = 100.0

Land Use Parameters

Land Use Map-series

Note

The map-series consists of a spatial map for each time-step in the model. This means if the model has 100 monthly time-steps, 100 maps of land-use are mandatory.

A map-series in PCRaster always starts with the *.001 extension, corresponding with the start date of your model simulation period. According to PCRaster documentation the name of each of the files in the series should have eight characters before the dot, and 3 characters after the dot. The name of each map starts with a prefix, and ends with the number of the time step. All characters in between are filled with zeroes.

Mandatory path to a directory containing the land use map-series. The directory containing these files must contain the maps that representing the mean monthly LUC, where each map represents the variable’s value at a particular time step. If some file is missing, the map of the previous step will be used. Must be a valid path to an existing directory. Note that it is also necessary to indicate the prefix of the filenames of the series. See more.

[DIRECTORIES]
landuse = /Dataset/UIRB/input/maps/landuse/

[FILENAME_PREFIXES]
landuse_prefix = ldu

Normalized Difference Vegetation Index (NDVI)

NDVI Map-series

Note

The map-series consists of a spatial map for each time-step in the model. This means if the model has 100 monthly time-steps, 100 maps of NDVI are mandatory.

A map-series in PCRaster always starts with the *.001 extension, corresponding with the start date of your model simulation period. According to PCRaster documentation the name of each of the files in the series should have eight characters before the dot, and 3 characters after the dot. The name of each map starts with a prefix, and ends with the number of the time step. All characters in between are filled with zeroes.

Mandatory path to a directory containing the monthly Normalized Difference Vegetation Index (NDVI) map-series format. The directory containing these files must contain the maps representing the mean monthly NDVI, where each map represents the variable’s value at a particular time step. If some file is missing, the map of the previous step will be used. Must be a valid path to an existing directory. Note that it is also necessary to indicate the prefix of the filenames of the series. See more.

[FILES]
ndvi = /Dataset/UIRB/input/maps/ndvi/

[FILENAME_PREFIXES]
ndvi_prefix = ndvi

Maximum NDVI Map

Mandatory path to maximum NDVI file in PCRaster map format *.map. This file is a scalar pcraster map with values for each cell, representing the maximum value of NDVI in the historic series available for the cell. Must be a valid path to an existing PCRaster map format *.map file. See more.

[RASTERS]
ndvi_max = /Dataset/UIGCRB/input/maps/ndvi/ndvi_max.map

Minimum NDVI Map

Mandatory path to minimum NDVI file in PCRaster map format *.map. This file is a scalar pcraster map with values for each cell, representing the minimum value of NDVI in the historic series available for the cell. Must be a valid path to an existing PCRaster map format *.map file. See more.

[RASTERS]
ndvi_min = /Dataset/UIGCRB/input/maps/ndvi/ndvi_min.map

Manning’s Roughness Coefficient

Mandatory path to a tabular file with values of Manning’s roughness coefficient values for each land-use class. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
manning = /Dataset/UIGCRB/input/txt/landuse/manning.txt

Area Fractions

Impervious Area Fraction (ai)

Mandatory path to file with values of fraction of impervious surface area values for each land-use class. This file is a text file *.txt or comma-separated values (CSV) file *.csv with values, representing the fraction of impervious surface area for each land-use class. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
a_i = /Dataset/UIGCRB/input/txt/landuse/a_i.txt

Open Water Area Fraction (ao)

Mandatory path to file with values of fraction of open-water area values for each land-use class. This file is a text file *.txt or comma-separated values (CSV) file *.csv with values, representing the fraction of open-water area for each land-use class. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
a_o = /Dataset/UIGCRB/input/txt/landuse/a_o.txt

Bare Soil Area Fraction (as)

Mandatory path to file with values of fraction of bare soil area values for each land-use class. This file is a text file *.txt or comma-separated values (CSV) file *.csv with values, representing the fraction of bare soil area for each land-use class. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
a_s = /Dataset/UIGCRB/input/txt/landuse/a_s.txt

Vegetated Area Fraction (av)

Mandatory path to file with values of fraction of vegetated area values for each land-use class. This file is a text file *.txt or comma-separated values (CSV) file *.csv with values, representing the fraction of vegetated area for each land-use class. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
a_v = /Dataset/UIGCRB/input/txt/landuse/a_v.txt

Crop Coefficient (K_C)

Maximum K_C

Mandatory path to a tabular file with values of maximum crop coefficient for each land-use class. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
K_c_max = /Dataset/UIGCRB/input/txt/landuse/kcmax.txt

Minimum K_C

Mandatory path to a tabular file with values of minimum crop coefficient for each land-use class. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
K_c_min = /Dataset/UIGCRB/input/txt/landuse/kcmin.txt

Maximum Leaf Area Index (LAI_MAX)

Mandatory maximum float value [dimensionless quantity] that characterizes plant canopies. It is defined as the one-sided green leaf area per unit ground surface area.

\[1 \leq LAI_{MAX} \leq 12\]

[CONSTANTS]
lai_max = 12.0

Impervious Area Interception (I_I)

Mandatory float value [mm] that represents the rainfall interception in impervious areas.

\[1 < I_I < 3\]

[CONSTANTS]
i_imp = 2.5

Fraction Photosynthetically Active Radiation (FPAR)

\[0 \leq FPAR_{MAX} \leq 1\]

\[FPAR_{MAX} > FPAR_{MIN}\]

Maximum FPAR

Mandatory maximum float value [dimensionless quantity] of fraction photosynthetically active radiation. This parameter is related to the maximum Leaf Area Index and allows the calculation of canopy storage.

[CONSTANTS]
fpar_max = 0.95

Minimum FPAR

Mandatory minimum float value [dimensionless quantity] of fraction photosynthetically active radiation. This parameter is related to the minimum Leaf Area Index and allows the calculation of canopy storage.

[CONSTANTS]
fpar_min = 0.001

Climate Data Series

Note

The map-series consists of a spatial map for each time-step in the model. This means if the model has 100 monthly time-steps, 100 maps of rainfall/ET_P/K_P are mandatory.

A map-series in PCRaster always starts with the *.001 extension, corresponding with the start date of your model simulation period. According to PCRaster documentation the name of each of the files in the series should have eight characters before the dot, and 3 characters after the dot. The name of each map starts with a prefix, and ends with the number of the time step. All characters in between are filled with zeroes.

Monthly Rainfall (P_M)

Mandatory path to a directory containing the Monthly Rainfall map-series format [mm/month]. The directory containing these files must contain the maps representing the variable’s value at a particular time step the mean monthly P_M, where each map represents the variable’s value at a particular time step. If some file is missing, the map of the previous step will be used. Must be a valid path to an existing directory. Note that it is also necessary to indicate the prefix of the filenames of the series. See more.

[FILES]
prec = /Dataset/UIRB/input/maps/prec/

[FILENAME_PREFIXES]
prec_prefix = prec

Monthly Potential Evapotranspiration (ET_P)

Mandatory path to a directory containing the Monthly Potential Evapotranspiration map-series format [mm/month]. The directory containing these files must contain the maps representing the mean monthly ET_P, where each map represents the variable’s value at a particular time step. If some file is missing, the map of the previous step will be used. Must be a valid path to an existing directory. Note that it is also necessary to indicate the prefix of the filenames of the series. See more.

[FILES]
etp = /Dataset/UIRB/input/maps/etp/

[FILENAME_PREFIXES]
etp_prefix = etp

Class A Pan Coefficient (K_P)

Mandatory path to a directory containing the Class A Pan Coefficient map-series format[mm/month]. The directory containing these files must contain the maps representing the mean monthly K_P, where each map represents the variable’s value at a particular time step. If some file is missing, the map of the previous step will be used. Must be a valid path to an existing directory. Note that it is also necessary to indicate the prefix of the filenames of the series. See more.

[FILES]
kp = /Dataset/UIRB/input/maps/kp/

[FILENAME_PREFIXES]
kp_prefix = kp

Monthly Rainy Days

Mandatory path to a tabular file [days/month] with values representing the mean value of rainy days for each month of the simulation period. Must be a valid path to an existing text file *.txt or comma-separated values (CSV) file *.csv. See more.

[TABLES]
rainydays = /Dataset/UIGCRB/input/txt/rainydays.txt

Model Parameters

Interception Parameter (α)

Mandatory float value [dimensionless quantity] that affects the daily interception threshold that depends on land use.

\[0.01 \leq \alpha \leq 10\]

Surface runoff is directly related to interception, an optimal value can be obtained by calibration surface runoff against direct runoff separated from streamflow observations.

[CALIBRATION]
alpha = 4.5

Rainfall Intensity Coefficient (b)

Mandatory float exponent value [dimensionless quantity] that represents the effect of rainfall intensity in the runoff.

\[0.01 \leq b \leq 1\]

The value is higher for low rainfall intensities resulting in less surface runoff, and approaches to one for high rainfall intensities. If \(b = 1\), a linear relationship is assumed between rainfall excess and soil moisture.

[CALIBRATION]
b = 0.5

Regional Consecutive Dryness Level (RCD)

Mandatory float value [mm] that incorporates the intensity of rain and the number of consecutive days in runoff calculation.

\[1.0 \leq RCD \leq 10\]

\(RCD = 1.0\) can be used for very heavy or torrential rainfall and more than 10 consecutive rainy days/month, and \(RCD = 10.0\) for low regional intensity rainfall less than 2 consecutive rainy days per month.

[CALIBRATION]
rcd = 5.0

Flow Direction Factor (f)

Mandatory float value [dimensionless quantity] used to partition the flow out of the root zone between interflow and flow to the saturated zone.

\[0.01 \leq f \leq 1\]

\(f = 1.0\) corresponds to a 100% horizontal flow direction, and \(f = 0\) corresponds to a 100% vertical flow direction.

[CALIBRATION]
f = 0.5

Baseflow Recession Coefficient (α_GW)

Mandatory float value [dimensionless quantity] that relates the baseflow response to changes in groundwater recharge.

\[0.01 \leq \alpha_{GW} \leq 1\]

Therefore, lower values for \(\alpha_{GW}\) therefore correspond to areas that respond slowly to groundwater recharge, whereas higher values indicate areas that rapidly respond to groundwater recharge.

[CALIBRATION]
alpha_gw = 0.5

Flow Recession Coefficient (x)

Mandatory float value [dimensionless quantity] that incorporates a flow delay in the accumulated amount of water that flows out of the cell into its neighboring downstream cell.

\[0 \leq x \leq 1\]

\(x \approx 0\) corresponds to a fast responding catchment, and \(x \approx 1\) corresponds to a slow responding catchment.

[CALIBRATION]
x = 0.5

Weight Factors

Land Use (\(w_1\)), Soil Moisture (\(w_2\)) and Slope (\(w_3\)) are the weight factors for the three components contributing to the runoff coefficient for permeable areas, used in surface runoff formulation. Their sum must be equal to 1.

\[w_1 + w_2 + w_3 = 1\]

Land Use Factor Weight (w₁)

Mandatory float value [dimensionless quantity] that contributes to calculating permeables areas runoff, and is related to the Manning coefficient for each land use class. It measures the effect of the land use on the potential runoff produced.

[CALIBRATION]
w_1 = 0.333

Soil Factor Weight (w₂)

Mandatory float value [dimensionless quantity] that contributes to calculating permeables area runoff, and is related to wilting points for each soil class. It measures the effect of the soil class on the potential runoff produced.

[CALIBRATION]
w_2 = 0.333

Slope Factor Weight (w₃)

Mandatory float value [dimensionless quantity] that contributes to calculating of permeables areas runoff, and is related to pixel slope. It measures the effect of the slope on the potential runoff produced.

[CALIBRATION]
w_3 = 0.334

Model Output Formats

At least one of these two options must be set to True to define the format of the generated raster files. The default format option is PCRaster map format map_raster_series = True.

PCRaster Map Format

Default True boolean, the raster data generated by the model will be exported in PCRaster map format. See the related documentation for more information.

[RASTER_FILE_FORMAT]
map_raster_series = True

TIFF/GeoTIFF

Default True boolean, the raster data generated by the model will be exported in TIFF/GeoTIFF map format. See the related documentation for more information.

[RASTER_FILE_FORMAT]
tiff_raster_series = True

Model Output Parameters

Warning

At least one output variable must be enabled for the respective time series raster files to be generated.

Note

If genTss option is enabled and a valid samples raster is provided, a comma-separated values (CSV) file *.csv will be generated for each of the enabled options. The *.csv file is structured as follows: each row represents a time step and each column represents a measurement station, and the cell data represents the value of the respective pixel in the selected raster map.

Total Interception

Optional boolean value. If enabled, this option allows the generation of Total Interception (ITP) [mm] result maps in raster format for each of the time steps included in the simulation period. See more.

[GENERATE_FILE]
itp = True

Baseflow

Optional boolean value. If enabled, this option allows the generation of Baseflow (BFW) [mm] result maps in raster format for each of the time steps included in the simulation period. See more.

[GENERATE_FILE]
bfw = True

Surface Runoff

Optional boolean value. If enabled, this option allows the generation of Surface runoff (SRN) [mm] result maps in raster format for each of the time steps included in the simulation period. See more.

[GENERATE_FILE]
srn = True

Actual Evapotranspiration

Optional boolean value. If enabled, this option allows the generation of Actual Evapotranspiration (ETA) [mm] result maps in raster format for each of the time steps included in the simulation period. See more.

[GENERATE_FILE]
eta = True

Lateral Flow

Optional boolean value. If enabled, this option allows to generate the resulting maps of Lateral Flow (LFW) [mm] result maps in raster format for each of the time steps included in the simulation period. See more.

[GENERATE_FILE]
lfw = True

Recharge

Optional boolean value. If enabled, this option allows the generation of Recharge (REC) [mm] result maps in raster format for each of the time steps included in the simulation period. See more.

[GENERATE_FILE]
rec = True

Soil Moisture Content

Optional boolean value. If enabled, this option allows the generation of Soil Moisture Content (SMC) [mm] result maps in raster format for each of the time steps included in the simulation period. See more.

[GENERATE_FILE]
smc = True

Total Runoff

Optional boolean value. If enabled, this option allows the generation of Total Runoff (RNF) [mm] result maps in raster format for each of the time steps included in the simulation period. See more.

[GENERATE_FILE]
rnf = True

Accumulated Total Runoff

Optional boolean value. If enabled, this option allows the generation of Accumulated Total Runoff (ARN) [m³s^-1] result maps in raster format for each of the time steps included in the simulation period. See more.

[GENERATE_FILE]
arn = True

Configuration File Template

[SIM_TIME]
start = 01/01/2000
end = 01/02/2000

[DIRECTORIES]
input = /Dataset/UIRB/
output = /Dataset/UIRB/output/
etp = /Dataset/UIRB/input/maps/etp/
prec = /Dataset/UIRB/input/maps/prec/
ndvi = /Dataset/UIRB/input/maps/ndvi/
Kp = /Dataset/UIRB/input/maps/kp/
landuse = /Dataset/UIRB/input/maps/landuse/

[FILENAME_PREFIXES]
etp_prefix = etp
prec_prefix = prec
ndvi_prefix = ndvi
kp_prefix = kp
landuse_prefix = ldu

[RASTERS]
dem = /Dataset/UIRB/input/maps/dem/dem.map
clone = /Dataset/UIRB/input/maps/clone/clone.map
ndvi_max = /Dataset/UIRB/input/maps/ndvi/ndvi_max.map
ndvi_min = /Dataset/UIRB/input/maps/ndvi/ndvi_min.map
soil = /Dataset/UIRB/input/maps/soil/soil.map
samples = /Dataset/UIRB/input/maps/samples/samples.map

[TABLES]
rainydays = /Dataset/UIRB/input/tables/rainydays.txt
a_i = /Dataset/UIRB/input/tables/landuse/a_i.txt
a_o = /Dataset/UIRB/input/tables/landuse/a_o.txt
a_s = /Dataset/UIRB/input/tables/landuse/a_s.txt
a_v = /Dataset/UIRB/input/tables/landuse/a_v.txt
manning = /Dataset/UIRB/input/tables/landuse/manning.txt
bulk_density = /Dataset/UIRB/input/tables/soil/dg.txt
K_sat = /Dataset/UIRB/input/tables/soil/Kr.txt
T_fcap = /Dataset/UIRB/input/tables/soil/Tcc.txt
T_sat = /Dataset/UIRB/input/tables/soil/Tsat.txt
T_wp = /Dataset/UIRB/input/tables/soil/Tw.txt
rootzone_depth = /Dataset/UIRB/input/tables/soil/Zr.txt
K_c_min = /Dataset/UIRB/input/tables/landuse/kcmin.txt
K_c_max = /Dataset/UIRB/input/tables/landuse/kcmax.txt


[GRID]
grid = 500.0

[CALIBRATION]
alpha = 4.5
b = 0.5
w_1 = 0.333
w_2 = 0.333
w_3 = 0.334
rcd = 5.0
f = 0.5
alpha_gw = 0.5
x = 0.5

[INITIAL_SOIL_CONDITIONS]
T_ini = 1.0
bfw_ini = 10.0
bfw_lim = 5.0
S_sat_ini = 100.0

[CONSTANTS]
fpar_max = 0.95
fpar_min = 0.001
lai_max = 12.0
i_imp = 2.5

[GENERATE_FILE]
itp = True
bfw = True
srn = True
eta = True
lfw = True
rec = True
smc = True
rnf = True
arn = True
tss = True

[RASTER_FILE_FORMAT]
map_raster_series = True
tiff_raster_series = True

Running RUBEM

When running RUBEM without any arguments, you will see the following message on your console:

$ python rubem
usage: rubem [-h] -c CONFIGFILE [-V] [-s]
rubem: error: the following arguments are required: -c/--configfile

Command Line Options

Use -h or --help to get a brief description of RUBEM and each argument.

$ python rubem -h
usage: rubem [-h] -c CONFIGFILE [-V] [-s]

Rainfall rUnoff Balance Enhanced Model (RUBEM)

optional arguments:
-h, --help            show this help message and exit
-c CONFIGFILE, --configfile CONFIGFILE
                        path to configuration file
-V, --version         show version and exit
-s, --skip-inputs-validation
                        disable input files validation before running the model

RUBEM 0.2.3-beta.2 Copyright (C) 2020-2024 - LabSid/PHA/EPUSP -This program comes with ABSOLUTELY NO WARRANTY.This is free software, and you are welcome to redistribute it under
certain conditions.

Use -V or --version to get the version of the RUBEM.

$ python rubem --version
RUBEM v0.2.3-beta.2

Use -c or --configfile to set the path of the RUBEM configuration file.

$ python rubem --configfile project-config.ini
.## Timestep 1 of 24
.## Timestep 2 of 24
.## Timestep 3 of 24
.## Timestep 4 of 24
.## Timestep 5 of 24
.## Timestep 6 of 24
.## Timestep 7 of 24
.## Timestep 8 of 24
.## Timestep 9 of 24
.## Timestep 10 of 24
.## Timestep 11 of 24
.## Timestep 12 of 24
.## Timestep 13 of 24
.## Timestep 14 of 24
.## Timestep 15 of 24
.## Timestep 16 of 24
.## Timestep 17 of 24
.## Timestep 18 of 24
.## Timestep 19 of 24
.## Timestep 20 of 24
.## Timestep 21 of 24
.## Timestep 22 of 24
.## Timestep 23 of 24
.## Timestep 24 of 24

User Guide

Inputs

Model General Settings

Project Directories

Data Output Directory

Digital Elevation Map (DEM)

Mask of Catchment (Clone)

Local Drain Direction (LDD)

Gauge Station Location Map

Export Results to Station Locations Map

Stations Locations (Samples)

Grid

Simulation Period

Start Date

End Date

Alignment Date

Soil Parameters

Soil Map

Bulk Density

Saturated Hydraulic Conductivity (KSAT)

Field Capacity (θFC)

Wilting Point (θWP)

Saturated Content (θSAT)

Depth Rootzone

Initial Soil Conditions

Initial Baseflow

Baseflow Threshold

Initial Soil Moisture Content (θINI)

Initial Saturated Zone Storage (SSAT)

Land Use Parameters

Land Use Map-series

Normalized Difference Vegetation Index (NDVI)

NDVI Map-series

Maximum NDVI Map

Minimum NDVI Map

Manning’s Roughness Coefficient

Area Fractions

Impervious Area Fraction (ai)

Open Water Area Fraction (ao)

Bare Soil Area Fraction (as)

Vegetated Area Fraction (av)

Crop Coefficient (KC)

Maximum KC

Minimum KC

Maximum Leaf Area Index (LAIMAX)

Impervious Area Interception (II)

Fraction Photosynthetically Active Radiation (FPAR)

Maximum FPAR

Minimum FPAR

Climate Data Series

Monthly Rainfall (PM)

Monthly Potential Evapotranspiration (ETP)

Class A Pan Coefficient (KP)

Monthly Rainy Days

Model Parameters

Interception Parameter (α)

Rainfall Intensity Coefficient (b)

Regional Consecutive Dryness Level (RCD)

Flow Direction Factor (f)

Baseflow Recession Coefficient (αGW)

Flow Recession Coefficient (x)

Weight Factors

Land Use Factor Weight (w1)

Soil Factor Weight (w2)

Slope Factor Weight (w3)

Model Output Formats

PCRaster Map Format

TIFF/GeoTIFF

Model Output Parameters

Total Interception

Baseflow

Surface Runoff

Actual Evapotranspiration

Lateral Flow

Recharge

Soil Moisture Content

Total Runoff

Accumulated Total Runoff

Configuration File Template

Running RUBEM

Saturated Hydraulic Conductivity (K_SAT)

Field Capacity (θ_FC)

Wilting Point (θ_WP)

Saturated Content (θ_SAT)

Initial Soil Moisture Content (θ_INI)

Initial Saturated Zone Storage (S_SAT)

Crop Coefficient (K_C)

Maximum K_C

Minimum K_C

Maximum Leaf Area Index (LAI_MAX)

Impervious Area Interception (I_I)

Monthly Rainfall (P_M)

Monthly Potential Evapotranspiration (ET_P)

Class A Pan Coefficient (K_P)

Baseflow Recession Coefficient (α_GW)

Land Use Factor Weight (w₁)

Soil Factor Weight (w₂)

Slope Factor Weight (w₃)