You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _episodes/first_example_recipe.md
+20-13Lines changed: 20 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ objectives:
16
16
keypoints:
17
17
- "A recipe does not break by fiddling with it"
18
18
- "Log information is useful when interpreting the first warnings/errors"
19
-
- "The dataset section in the recipe relates to Understanding the directory structure of CMIP data on your server/disk and knowing how to use data from different experiments such as CMIP/ScenarioMIP."
19
+
- "The dataset section resembles the filename or directory structure (e.g. CMIP subdirectories)."
20
20
21
21
---
22
22
@@ -29,7 +29,7 @@ Recipes are the instructions that you give to ESMValTool that tell it what you w
29
29
- datasets: what datasets you want to use, including
30
30
- the time range and time resolution,
31
31
- the MIP, ensemble member,
32
-
- the experiment (i.e. historical, ssp125 etc...),
32
+
- the experiment (i.e. historical, ssp125, etc.),
33
33
- and the grid type (CMIP6 only).
34
34
35
35
- preprocessors: general operations applied to a dataset before handling it in a diagnostic, listing
@@ -44,7 +44,7 @@ Recipes are the instructions that you give to ESMValTool that tell it what you w
44
44
- the desired diagnostic script to use,
45
45
- and additional diagnostic script options or arguments, if needed.
46
46
47
-
Also Include additional datasets beyond those included in the datasets section mentioned above, for instance variable specific observational data.
47
+
Also include additional datasets beyond those included in the datasets section mentioned above, for instance variable specific observational data.
48
48
49
49
- description: a brief description of the recipe, including
50
50
- who wrote the recipe and who maintains it,
@@ -53,7 +53,8 @@ Recipes are the instructions that you give to ESMValTool that tell it what you w
53
53
54
54
Note that the authors, publications and references are to be named in the config-references.yml
55
55
56
-
This information ...
56
+
The information you provide in the recipe is not only affecting the processes you are starting, but also the directory names your output will be structured in.
57
+
For additional reeds, please have a look at the recipe format description in the [ESMValTool manual](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/overview.html#recipe-section-diagnostics).
57
58
58
59
## How to run ESMValTool
59
60
@@ -67,9 +68,9 @@ To try your hand with a basic recipe, please work through this episode.
67
68
68
69
69
70
## Introduction to the example recipe
70
-
Threcipe presented here is a simple, basic recipe that takes a single dataset and produces a time series plot.
71
+
The recipe presented here is a simple, basic recipe that takes a single dataset and produces a time series plot.
71
72
72
-
Please copy and paste the following recipe into your ESMValTool working area with the name: recipe_example.yml
73
+
Please download the following recipe into your ESMValTool working area with the name: recipe_example.yml LINK
73
74
74
75
>## recipe_example.yml
75
76
>~~~YAML
@@ -205,7 +206,7 @@ Each time you run the ESMValTool, it will produce a new output directory within
205
206
- plots
206
207
207
208
> ## Inspect the output:
208
-
> Now that you have ran the esmvaltool command for the first time, please locate your output directory.
209
+
> Now that you have run the esmvaltool command for the first time, please locate your output directory.
209
210
> If you’re missing the preproc directory, then your config-user.yml file has the value remove_preproc_dir set to true (this is used to save disk space). Please set this value to false and run the recipe again.
210
211
>
211
212
{: .challenge}
@@ -230,16 +231,18 @@ Each time you run the ESMValTool, it will produce a new output directory within
230
231
> - the dataset:
231
232
> - mip, start_year, end_year
232
233
> - the preprocessor:
233
-
> - These fields are all 2D fields, but thetaga was a 0D field. This means that we need to take the average over the latitude and longitude dimensions. To do this, add the area_statistics to the preprocessor.
234
+
> - These fields are all 2D fields, but thetaoga was a 0D field. This means that we need to take the average over the latitude and longitude dimensions. To do this, add the area_statistics to the preprocessor.
234
235
> - the diagnostic
235
236
> - change the short_name value (thetaoga) for another:
236
237
> - Land surface average temperature (tsland)
237
238
> - Atmospheric surface average temperature (tas)
238
239
> - Ocean surface average temperature (tos)
239
-
> ### Advanced:
240
+
{: .challenge}
241
+
242
+
> ## Advanced:
240
243
> If you want to add a different field, please have a look here:
@@ -248,22 +251,26 @@ Each time you run the ESMValTool, it will produce a new output directory within
248
251
> Can you run the command “esmvaltool -h”. If no, then it’s possible that the conda environment isn’t activated. Please return to the installation section, episode #2 LINK.
249
252
{: .solution}
250
253
251
-
> ## ESMValTool can’t locate the data. The error message is “esmvalcore._recipe_checks.RecipeError: Missing data”
254
+
> ## ESMValTool can’t locate the data. The error message is `esmvalcore._recipe_checks.RecipeError: Missing data`
252
255
> Which computing machine are you using? Does your user-config.yml file reflect your machine's settings? Is the dataset’s name in the correct order?
253
256
{: .solution}
254
257
258
+
255
259
> ## Diagnostic path problems
256
260
> The directory path to your diagnostics code is set relative to the esmvaltool/diag_scripts subdirectory. Is the code placed in this subdirectory? Is it spelled correctly?
257
261
{: .solution}
258
262
263
+
259
264
> ## FX files not found
260
-
>
265
+
> There is no FX file for your corresponding dataset. Are your datasets’ names spelled correctly? Is there a FX file for this dataset?
261
266
{: .solution}
262
267
268
+
263
269
> ## The preprocessor works but the diagnostic fails
264
270
> If your preprocessor works fine but your diagnostic script fails, congratulations! A failed diagnostic means that you won’t need to re-run the preprocessor. In your “run/main_log.txt” run output, you should see a line that reads: “To re-run this diagnostic script, run:”, followed by a line with a command that will allow you to re-run your diagnostic script only. Append this line with the “-i” option after the python script you call to re-run your diagnostic.
265
271
{: .solution}
266
272
267
-
> ## Your recipe’s name/project/reference isn’t recognised by ESMValTool. Error message is “ValueError: Tag 'NAME' does not exist in section 'authors' of path/esmvaltool/config-references.yml”
273
+
274
+
> ## Your recipe’s name/project/reference isn’t recognised by ESMValTool. Error message is `ValueError: Tag 'NAME' does not exist in section 'authors' of path/esmvaltool/config-references.yml`
268
275
> Most likely, you added your own name to the recipe in the description section, but didn’t add it to the esmvaltool/config-references.yml file, where the names are linked to an email address, institute, and ORCID Identity.
0 commit comments