diff --git a/include/evalhyd/evald.hpp b/include/evalhyd/evald.hpp index 4bcb3eda64db37b3e026be5b1f70c5ab6d426539..015828e09c739c6aa9d994cd903d919d174ad138 100644 --- a/include/evalhyd/evald.hpp +++ b/include/evalhyd/evald.hpp @@ -60,6 +60,20 @@ namespace evalhyd /// metrics: ``std::vector<std::string>`` /// The sequence of evaluation metrics to be computed. /// + /// q_thr: ``XD2``, optional + /// Streamflow exceedance threshold(s). If provided, *events* must + /// also be provided. + /// shape: (sites, thresholds) + /// + /// events: ``std::string``, optional + /// The type of streamflow events to consider for threshold + /// exceedance-based metrics. It can either be set as "high" when + /// flooding conditions/high flow events are evaluated (i.e. event + /// occurring when streamflow goes above threshold) or as "low" when + /// drought conditions/low flow events are evaluated (i.e. event + /// occurring when streamflow goes below threshold). It must be + /// provided if *q_thr* is provided. + /// /// transform: ``std::string``, optional /// The transformation to apply to both streamflow observations and /// predictions prior to the calculation of the *metrics*.