|
|
## Introduction
|
|
|
|
|
|
Auto-S2S is the GitLab repository for the ESS Verification Suite, a modular tool for subseasonal to seasonal to decadal forecast verification workflows. It is intended to have a modularized structure, where each module is a separate part of the code that performs a specific task, so that parts of the workflow can be skipped or reordered.
|
|
|
SUNSET is a modular tool for subseasonal to seasonal to decadal forecast verification workflows. It is intended to have a modularized structure, where each module is a separate part of the code that performs a specific task, so that parts of the workflow can be skipped or reordered.
|
|
|
|
|
|
The datasets, forecast horizon, time period, skill metrics to compute and other parameters are specified by the user in a configuration file, called "recipe".
|
|
|
|
|
|
After definining the recipe, the user can create a script using the functions available in the tool, which use apply the information in the recipe to do the desired computations. You an example script [in the Auto-S2S code Snippets](https://earth.bsc.es/gitlab/es/auto-s2s/-/snippets/111).
|
|
|
After definining the recipe, the user can create a script using the functions available in the tool, which use apply the information in the recipe to do the desired computations. You an example script [in the SUNSET code Snippets](https://earth.bsc.es/gitlab/es/sunset/-/snippets/111).
|
|
|
|
|
|
- Modules currently available: Loading, Calibration, Anomalies, Skill, Saving, Visualization
|
|
|
- Modules in development: Downscaling, Scorecards
|
... | ... | @@ -76,13 +76,13 @@ Analysis: |
|
|
Run:
|
|
|
Loglevel: INFO # Optional, str: 'DEBUG', 'INFO', 'WARN', 'ERROR' or 'FATAL'. Default 'INFO'.
|
|
|
Terminal: TRUE # Optional, bool: Whether to display log messages in the terminal. Default 'TRUE'.
|
|
|
output_dir: /esarchive/scratch/vagudets/repos/auto-s2s/out-logs/ # Mandatory, str: output directory
|
|
|
code_dir: /esarchive/scratch/vagudets/repos/auto-s2s/
|
|
|
output_dir: /esarchive/scratch/vagudets/repos/sunset/out-logs/ # Mandatory, str: output directory
|
|
|
code_dir: /esarchive/scratch/vagudets/repos/sunset/
|
|
|
```
|
|
|
|
|
|
## List of /esarchive/ datasets
|
|
|
|
|
|
Here is a list of the datasets that can currently be loaded by the tool. To request that an additional dataset be added, please [open an issue](https://earth.bsc.es/gitlab/es/auto-s2s/-/issues).
|
|
|
Here is a list of the datasets that can currently be loaded by the tool. To request that an additional dataset be added, please [open an issue](https://earth.bsc.es/gitlab/es/sunset/-/issues).
|
|
|
|
|
|
### Seasonal datasets
|
|
|
|
... | ... | @@ -138,14 +138,14 @@ Observations: |
|
|
|
|
|
## The first steps
|
|
|
|
|
|
In order to run the ESS Verification Suite, you need to load the necessary modules. To do this, you can run the command `source MODULES` in the terminal, from the main folder of the Auto-S2S repository.
|
|
|
In order to run the ESS Verification Suite, you need to load the necessary modules. To do this, you can run the command `source MODULES` in the terminal, from the main folder of the SUNSET repository.
|
|
|
|
|
|
Before calling the modules in your script or in the R console, you should run the `prepare_outputs()` function as shown in the [example script](https://earth.bsc.es/gitlab/es/auto-s2s/-/snippets/96), which will read your recipe and set up the directory for your outputs.
|
|
|
Before calling the modules in your script or in the R console, you should run the `prepare_outputs()` function as shown in the [example script](https://earth.bsc.es/gitlab/es/sunset/-/snippets/96), which will read your recipe and set up the directory for your outputs.
|
|
|
`prepare_outputs()` will perform a check on your recipe to detect potential errors. If you want to disable this check, you may set the argument `disable_checks = TRUE` when calling the function.
|
|
|
|
|
|
If you had a recipe named recipe-wiki.yml that looked like the example in this wiki, this directory might look something like this:
|
|
|
|
|
|
`/esarchive/scratch/vagudets/repos/auto-s2s/out-logs/recipe-wiki_20221025164151`
|
|
|
`/esarchive/scratch/vagudets/repos/sunset/out-logs/recipe-wiki_20221025164151`
|
|
|
|
|
|
Inside you will find a log file, a copy of your recipe, and your outputs from the Saving and Visualization modules.
|
|
|
|
... | ... | @@ -278,7 +278,7 @@ If fcst_year is empty: |
|
|
|
|
|
For example, in our example recipe, the final output directory will be:
|
|
|
|
|
|
`/esarchive/scratch/vagudets/repos/auto-s2s/out-logs/recipe-wiki_20221025164151/outputs/mse_min-monthly_mean/20201101/tas/`
|
|
|
`/esarchive/scratch/vagudets/repos/sunset/out-logs/recipe-wiki_20221025164151/outputs/mse_min-monthly_mean/20201101/tas/`
|
|
|
|
|
|
The structure of the names of the files is:
|
|
|
- Skill metrics: `<var>-skill_month<mm>.nc`
|
... | ... | |