... | ... | @@ -385,6 +385,27 @@ For example, if the extremes ([1/10, 9/10]) are requested, the output will be: |
|
|
save: 'percentiles_only' # Options: 'all', 'none', 'bins_only', 'percentiles_only' (Mandatory, str)
|
|
|
```
|
|
|
|
|
|
## Statistics module
|
|
|
|
|
|
The Statistics module is the part of the workflow that computes the statistics of the experimental and observational datasets. It accepts the output of the Calibration module as input, and also requires the recipe.
|
|
|
|
|
|
The function **Statistics()** computes the statistics metrics requested in `Workflow:Statistics:metric`. The following statistics are currently available:
|
|
|
|
|
|
- `cov`: Covariance
|
|
|
- `var`: Variance
|
|
|
- `std`: Standard Deviation
|
|
|
- `n_eff`: Effective Sample Size
|
|
|
|
|
|
The output of `Statistics()` is a list containing one or more arrays with the same dimensions as the Skill metrics. If the statistics metrics are saved in the output directory; `outputs:Statistics`. When the output format in the recipe is `S2S4E` then the metrics are all saved in one netCDF file. If instead the output format in the recipe is set to `scorecards` then each statistic metric is saved in a separate netCDF file.
|
|
|
|
|
|
### Recipe template:
|
|
|
|
|
|
```yaml
|
|
|
Statistics:
|
|
|
metric: cov std n_eff # Statistics metrics separated by spaces or commas. (Mandatory, str)
|
|
|
save: 'all' # Options: 'all', 'none' (Mandatory, str)
|
|
|
```
|
|
|
|
|
|
## Scorecards module
|
|
|
|
|
|
The Scorecards module takes the output netCDF files that are saved from the Skill module when SUNSET is run, and creates [Scorecard visualizations](https://earth.bsc.es/gitlab/ess/csscorecards) for the different systems and variables that were requested in the recipe.
|
... | ... | |