rain2flow
A collection of conceptual rainfall runoff models
- rain2flow.hbv(pcp: ndarray, temp: ndarray, evap: ndarray, parameters: Dict[str, float], initialize: bool = True, routing: bool = False) ndarray[source]
HBV hydrological model implementation in numpy
Parameters
- pcpnp.ndarray
array of precipitation values (mm/day)
- tempnp.ndarray
array of temperature values (°C)
- evapnp.ndarray
array of potential evapotranspiration values (mm/day)
- parametersDict[str, float]
dictionary of model parameters:
‘BETA’: Shape coefficient for soil moisture accounting
‘FC’: Field capacity of the soil (mm)
‘K0’: Recession coefficient for quick runoff component (1/day)
‘K1’: Recession coefficient for upper groundwater zone (1/day)
‘K2’: Recession coefficient for lower groundwater zone (1/day)
‘LP’: Evapotranspiration correction factor
‘MAXBAS’: Routing parameter (days)
‘PERC’: Percolation rate from upper to lower groundwater zone (mm/day)
‘UZL’: Threshold for upper groundwater zone (mm)
‘PCORR’: Precipitation correction factor
‘TT’: Temperature threshold for snow/rain separation (°C)
‘CFMAX’: Degree-day factor for snowmelt (mm/°C/day)
‘SFCF’: Snowfall correction factor
‘CFR’: Refreezing coefficient
‘CWH’: Water holding capacity of snowpack
- routingbool
whether to apply routing to the simulated runoff or not
- initializebool
whether to initialize the model by running it once with the whole input data or not
Returns
- np.ndarray
array of simulated discharge values (mm/day)
- rain2flow.hbv_nb(prec: ndarray, temp: ndarray, pet: ndarray, parameters: Dict[str, float], initialize: bool = True, routing: bool = True) ndarray[source]
Same as hbv function in :py:module:`rain2flow._hbv._main` but compatible with numba!
- parametersdict
a dictionary of 15 model parameters
- routingbool
whether to apply triangular routing to the output or not
- initializebool
whether to initialize the model by running it once with the whole input data or not
Returns
- np.ndarray
array of simulated discharge values (mm/day)
Examples