Commit 02f9b78b authored by Thibault Hallouin's avatar Thibault Hallouin
Browse files

add missing parameters q_thr/events to `evald`

1 merge request!3release v0.1.0
Pipeline #44802 failed with stage
in 3 minutes and 36 seconds
Showing with 14 additions and 0 deletions
+14 -0
...@@ -60,6 +60,20 @@ namespace evalhyd ...@@ -60,6 +60,20 @@ namespace evalhyd
/// metrics: ``std::vector<std::string>`` /// metrics: ``std::vector<std::string>``
/// The sequence of evaluation metrics to be computed. /// 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 /// transform: ``std::string``, optional
/// The transformation to apply to both streamflow observations and /// The transformation to apply to both streamflow observations and
/// predictions prior to the calculation of the *metrics*. /// predictions prior to the calculation of the *metrics*.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment