Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing issues #276 #278 #296 #297 #308

Merged
merged 12 commits into from
Feb 12, 2024
Binary file added _episodes/.10-debugging.md.swp
Binary file not shown.
2 changes: 2 additions & 0 deletions _episodes/03-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ and then modify it if needed:
nano ~/.esmvaltool/config-user.yml
~~~

Any other editor can be used, e.g.vim.

This file contains the information for:

- Output settings
Expand Down
2 changes: 1 addition & 1 deletion _episodes/04-recipe.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ esmvaltool run --config_file ./config-user.yml examples/recipe_python.yml
If everything is okay, you should see that ESMValTool is printing a lot of
output to the command line. The final message should be "Run was successful".
The exact output varies depending on your machine, but it should look something
like the example output below.
like the example log output on terminal below.

{% include example_output.txt %}

Expand Down
5 changes: 5 additions & 0 deletions _episodes/07-development-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,11 @@ nothing to commit, working tree clean

### 2 ESMValTool dependencies

Please don’t forget if an esmvaltool environment is already created
following the lesson
[Installation]({{ page.root }}{% link _episodes/02-installation.md %}),
we should choose another name for the new environment in this lesson.

ESMValTool now uses `mamba` instead of `conda` for the recommended installation.
For a minimal mamba installation, see section **Install Mamba** in lesson
[Installation]({{ page.root }}{% link _episodes/02-installation.md %}).
Expand Down
45 changes: 27 additions & 18 deletions _episodes/10-debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,12 @@ and then <kbd>ctrl</kbd> + <kbd>X</kbd> to exit ``nano``.
> # ESMValTool
> # recipe_python.yml
> ---
> # See https://docs.esmvaltool.org/en/latest/recipes/recipe_examples.html
> # for a description of this recipe.
>
> # See https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/overview.html
> # for a description of the recipe format.
> ---
> documentation:
> description: |
> Example recipe that plots a map and timeseries of temperature.
Expand All @@ -152,33 +158,36 @@ and then <kbd>ctrl</kbd> + <kbd>X</kbd> to exit ``nano``.
>
> datasets:
> - {dataset: BCC-ESM1, project: CMIP6, exp: historical, ensemble: r1i1p1f1, grid: gn}
> - {dataset: CanESM2, project: CMIP5, exp: historical, ensemble: r1i1p1}
> - {dataset: bcc-csm1-1, version: v1, project: CMIP5, exp: historical, ensemble: r1i1p1}
>
> preprocessors:
> # See https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/preprocessor.html
> # for a description of the preprocessor functions.
>
> select_january:
> extract_month:
> month: 1
> to_degrees_c:
> convert_units:
> units: degrees_C
>
> annual_mean_amsterdam:
> extract_point:
> latitude: 52.379189
> longitude: 4.899431
> extract_location:
> location: Amsterdam
> scheme: linear
> annual_statistics:
> operator: mean
> multi_model_statistics:
> statistics:
> - mean
> span: overlap
> convert_units:
> units: degrees_C
>
> annual_mean_global:
> area_statistics:
> operator: mean
> fx_variables:
> areacella:
> annual_statistics:
> operator: mean
> convert_units:
> units: degrees_C
>
> diagnostics:
>
Expand All @@ -191,14 +200,13 @@ and then <kbd>ctrl</kbd> + <kbd>X</kbd> to exit ``nano``.
> variables:
> tas:
> mip: Amon
> preprocessor: select_january
> start_year: 2000
> end_year: 2000
> preprocessor: to_degrees_c
> timerange: 2000/P1M
> caption: |
> Global map of {long_name} in January 2000 according to {dataset}.
> scripts:
> script1:
> script: examples/diagnostic.py
> write_netcdf: true
> output_file_type: pdf
> quickplot:
> plot_type: pcolormesh
> cmap: Reds
Expand All @@ -214,14 +222,14 @@ and then <kbd>ctrl</kbd> + <kbd>X</kbd> to exit ``nano``.
> short_name: tas
> mip: Amon
> preprocessor: annual_mean_amsterdam
> start_year: 1850
> end_year: 2000
> timerange: 1850/2000
> caption: Annual mean {long_name} in Amsterdam according to {dataset}.
> tas_global:
> short_name: tas
> mip: Amon
> preprocessor: annual_mean_global
> start_year: 1850
> end_year: 2000
> timerange: 1850/2000
> caption: Annual global mean {long_name} according to {dataset}.
> scripts:
> script1:
> script: examples/diagnostic.py
Expand All @@ -231,6 +239,7 @@ and then <kbd>ctrl</kbd> + <kbd>X</kbd> to exit ``nano``.
>
{: .solution}


## Keys and values in recipe settings

The [ESMValTool
Expand Down
Loading