Skip to content

Commit 7f7748b

Browse files
author
BenMGeo
committed
include review suggetions
1 parent ad1c9ad commit 7f7748b

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

_episodes/first_example_recipe.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,15 @@ This episode describes how ESMValTool recipes work, how to run a recipe and how
2525
Recipes are the instructions that you give to ESMValTool that tell it what you want to do. This includes four main sections: datasets, preprocessors, diagnostics and description.
2626

2727
- datasets: what datasets you want to use, including
28-
- the time range and time resolution,
29-
- the MIP, ensemble member,
28+
- the time period and temporal resolution,
29+
- the MIP (Model Intercomparison Project, like atmospheric MIP monthly data: amon),
30+
- ensemble member,
3031
- the experiment (i.e. historical, ssp125, etc.),
31-
- and the grid type (CMIP6 only).
32+
- and the grid type (necessary for CMIP6 only).
3233

33-
- preprocessors: general operations applied to a dataset before handling it in a diagnostic, listing
34+
- preprocessors: general operations applied to a dataset before handling it in a diagnostic, defining
3435
- which preprocessor modules to apply,
35-
- the order to apply them,
36+
- the order in which they are applied,
3637
- and the preprocessor arguments.
3738

3839
This section can also be optional, if no preprocessing is needed.
@@ -42,17 +43,17 @@ Recipes are the instructions that you give to ESMValTool that tell it what you w
4243
- the desired diagnostic script to use,
4344
- and additional diagnostic script options or arguments, if needed.
4445

45-
Also include additional datasets beyond those included in the datasets section mentioned above, for instance variable specific observational data.
46+
It is possible to also include additional datasets beyond those included in the datasets section mentioned above, for instance variable specific observational data.
4647

4748
- description: a brief description of the recipe, including
4849
- who wrote the recipe and who maintains it,
49-
- which project is responsible for it,
50-
- and which publications, references are linked with the recipe.
50+
- which project the recipe was written for,
51+
- and which publications and references are linked with the recipe.
5152

52-
Note that the authors, publications and references are to be named in the config-references.yml
53+
Note that the authors, publications and references need to be included in the `config-references.yml` for the recipe to run successfully.
5354

5455
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.
55-
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).
56+
For additional reads, 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).
5657

5758
## How to run ESMValTool
5859

@@ -67,7 +68,7 @@ To try your hand with a basic recipe, please work through this episode.
6768
## Introduction to the example recipe
6869
The recipe presented here is a simple, basic recipe that takes a single dataset and produces a time series plot.
6970

70-
Please download the following recipe into your ESMValTool working area with the name: recipe_example.yml LINK
71+
Please download the following recipe into your ESMValTool working directory with the name: recipe_example.yml LINK
7172

7273
> ## recipe_example.yml
7374
> ~~~YAML
@@ -117,7 +118,7 @@ Please download the following recipe into your ESMValTool working area with the
117118
{: .solution}
118119
119120
> ## Explore the recipe
120-
> Use the command and investigate the sample recipe.
121+
> Use the following command and investigate the sample recipe.
121122
> ~~~bash
122123
> vim recipe_example.yml
123124
> ~~~
@@ -128,10 +129,10 @@ Please note the following sections:
128129
129130
The documentation consists of the following information:
130131
- description: a short description of the recipe
131-
- authors: a list of authors (linked to esmvaltool/config-references.yml)
132-
- maintainer: a list of maintainers (linked to esmvaltool/config-references.yml)
133-
- references: a list of references (linked to a bibtexfile in esmvaltool/references with the same name)
134-
- projects: a list of projects (linked to esmvaltool/config-references.yml)
132+
- authors: a list of authors (linked to `esmvaltool/config-references.yml`)
133+
- maintainer: a list of maintainers (linked to `esmvaltool/config-references.yml`)
134+
- references: a list of references (linked to a bibtexfile in `esmvaltool/references` with the same name)
135+
- projects: a list of projects (linked to `esmvaltool/config-references.yml`)
135136
136137
137138
- datasets: lines 22-23
@@ -144,7 +145,7 @@ Please note the following sections:
144145
- ensemble member (key: ensemble)
145146
- time range (e.g. key-value-pair: start_year: 1982, end_year: 1990)
146147
- model grid (for CMIP6 data only, key: grid)
147-
- alias (key: alias; use the alias for e.g. a more human readable name)
148+
- alias (key: alias; use the alias for e.g. a more human readable name for the dataset)
148149
149150
150151
- preprocessors: lines 25-28

0 commit comments

Comments
 (0)