merge latest changes from main

ESMValGroup · Aug 22, 2022 · 362c857 · 362c857
2 parents aec60fc + 5f13e54
commit 362c857
Show file tree

Hide file tree

Showing 23 changed files with 536 additions and 312 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,3 +1,7 @@
+---
+layout: page
+title: "Contributor Code of Conduct"
+---
 # Contributor Code of Conduct
 
 As contributors and maintainers of this tutorial,

diff --git a/README.md b/README.md
@@ -1,8 +1,10 @@
 # ESMValTool Tutorial
 
-[![Join the chat at
-https://gitter.im/ESMValGroup/Tutorial](https://badges.gitter.im/ESMValGroup/Tutorial.svg)](https://gitter.im/ESMValGroup/Tutorial?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3974592.svg)](https://doi.org/10.5281/zenodo.3974592)
+[![Join the chat at https://gitter.im/ESMValGroup/Tutorial](
+https://badges.gitter.im/ESMValGroup/Tutorial.svg)](
+https://gitter.im/ESMValGroup/Tutorial)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3974592.svg)](
+https://doi.org/10.5281/zenodo.3974592)
 
 
 [ESMValTool Tutorial][tutorial-site] is an open-source project in

diff --git a/_episodes/00-introduction.md b/_episodes/00-introduction.md
@@ -64,7 +64,8 @@ documentation:
     - lastname_firstname
 
 datasets:
-  - {dataset: HadGEM2-ES, project: CMIP5, exp: historical, mip: Amon, ensemble: r1i1p1, start_year: 1960, end_year: 2005}
+  - {dataset: HadGEM2-ES, project: CMIP5, exp: historical, mip: Amon, 
+     ensemble: r1i1p1, start_year: 1960, end_year: 2005}
 
 preprocessors:
   global_mean:
@@ -88,8 +89,9 @@ diagnostics:
 >
 > > ## Solution
 > > The keys are explained in the ESMValTool documentation, in the `Recipe 
->>  section `, under
-> [datasets](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/overview.html#recipe-section-datasets)
+> >  section `, under
+> [datasets](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/
+overview.html#recipe-section-datasets)
 > {: .solution}
 {: .challenge}
 

diff --git a/_episodes/02-installation.md b/_episodes/02-installation.md
@@ -30,15 +30,18 @@ depending on your level of expertise or involvement with ESMValTool and
 associated software such as GitHub and Mamba.
 
 1. If you have access to a server where ESMValTool is already installed
-as a module, for e.g., the [CEDA JASMIN](https://help.jasmin.ac.uk/article/4955-community-software-esmvaltool)
+as a module, for e.g., the [CEDA JASMIN](https://help.jasmin.ac.uk/article
+/4955-community-software-esmvaltool)
 server, you can simply load the module with the following command:
 ~~~bash
 module load esmvaltool
 ~~~
-After loading ``esmvaltool``, we can start using ESMValTool right away. Please see the [next lesson]({{ page.root }}{% link _episodes/03-configuration.md %}). 
+After loading ``esmvaltool``, we can start using ESMValTool right away. Please
+ see the [next lesson]({{ page.root }}{% link _episodes/03-configuration.md %}). 
 2. If you would like to install ESMValTool as a mamba package, then this lesson
 will tell you how!
-3. If you would like to start experimenting with existing diagnostics or contributing to ESMvalTool, please see the instructions for 
+3. If you would like to start experimenting with existing diagnostics or 
+contributing to ESMvalTool, please see the instructions for 
 source installation in the lesson [Development and
 contribution]({{ page.root }}{% link _episodes/07-development-setup.md %}) and
 in the [documentation](https://docs.esmvaltool.org/en/latest/quickstart/installation.html).
@@ -62,7 +65,8 @@ in the [documentation](https://docs.esmvaltool.org/en/latest/quickstart/installa
 ESMValTool is distributed using [Mamba](https://mamba.readthedocs.io/en/latest/index.html).
 To install mamba on ``Linux`` or ``MacOSX``, follow the  instructions below:
 
-1.  Please download the installation file for the latest Mamba version [here](https://github.com/conda-forge/miniforge#mambaforge).
+1.  Please download the installation file for the latest Mamba version 
+[here](https://github.com/conda-forge/miniforge#mambaforge).
 
 2.  Next, run the installer from the place where you downloaded it:
 
@@ -98,7 +102,8 @@ To install mamba on ``Linux`` or ``MacOSX``, follow the  instructions below:
     This should show the path to your mamba executable, e.g. `~/mambaforge/bin/mamba`.
 
 For more information about installing mamba,
-see [the mamba installation documentation](https://docs.esmvaltool.org/en/latest/quickstart/installation.html#mamba-installation).
+see [the mamba installation documentation](https://docs.esmvaltool.org/en
+/latest/quickstart/installation.html#mamba-installation).
 
 ### Install the ESMValTool package
 
@@ -121,18 +126,22 @@ mamba create --name esmvaltool esmvaltool 'python=3.10'
 ```
 
 On MacOSX ESMValTool functionalities in Julia, NCL, and R are not supported. To install
-a Mamba environment on MacOSX, please refer to specific [information](https://docs.esmvaltool.org/en/latest/quickstart/installation.html#installation-on-macosx).
+a Mamba environment on MacOSX, please refer to specific [information](https://
+docs.esmvaltool.org/en/latest/quickstart/installation.html#installation-on-
+macosx).
 
 This will create a new [Mamba
-environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)
+environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks
+/manage-environments.html)
 called `esmvaltool`, with the ESMValTool package and all of its dependencies
 installed in it.
 
 
 > ## Common issues
 >
 > You find a list of common installation problems and their solutions in the 
-> [documentation](https://docs.esmvaltool.org/en/latest/quickstart/installation.html#common-installation-problems-and-their-solutions).
+> [documentation](https://docs.esmvaltool.org/en/latest/quickstart/installation
+.html#common-installation-problems-and-their-solutions).
 >
 {: .callout}
 
@@ -219,8 +228,8 @@ to display the command line help.
 > > {: .bash}
 > > The version of ESMValTool installed should be displayed on the screen as:
 > > ~~~
-> > ESMValCore: 2.5.0
-> > ESMValTool: 2.5.0
+> > ESMValCore: 2.6.0
+> > ESMValTool: 2.6.0
 > > ~~~
 > > {: .output}
 > {: .solution}

diff --git a/_episodes/03-configuration.md b/_episodes/03-configuration.md
@@ -140,7 +140,8 @@ file are mentioned below. For example, CMIP is used for a dataset from
 the Climate Model Intercomparison Project whereas OBS may be 
 used for an observational dataset.
 More information about the projects used in ESMValTool is available in the 
-[documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/quickstart/find_data.html).
+[documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/
+quickstart/find_data.html).
 When using ESMValTool on your own machine, you can create a directory to download 
 climate model data or observation data sets and let the tool use data from there. 
 It is also possible to ask 
@@ -222,7 +223,8 @@ removing the machine specific lines should be sufficient to access input data.
 >>```
 >>
 >> - For more information about setting the rootpath, see also the ESMValTool
->> [documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/quickstart/find_data.html).
+>> [documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/
+quickstart/find_data.html).
 > {: .solution}
 {: .challenge}
 
@@ -236,7 +238,8 @@ The ``drs`` setting describes the file structure for several projects (e.g.
 CMIP6, CMIP5, obs4mips, OBS6, OBS) on several key machines
 (e.g. BADC, CP4CDS, DKRZ, ETHZ, SMHI, BSC). For more
 information about ``drs``, you can visit the ESMValTool documentation on
-[Data Reference Syntax (DRS)](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/quickstart/find_data.html#cmor-drs).
+[Data Reference Syntax (DRS)](https://docs.esmvaltool.org/projects/esmvalcore/
+en/latest/quickstart/find_data.html#cmor-drs).
 
 > ## Set the correct drs
 >
@@ -299,7 +302,9 @@ information about ``drs``, you can visit the ESMValTool documentation on
 >> 2. Observational data are organized in Tiers depending on their level of
 >>    public availability. Therefore the default directory must be structured
 >>    accordingly with sub-directories `TierX` e.g. Tier1, Tier2 or Tier3, even
->>    when `drs: default`. More details can be found in the [documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/quickstart/find_data.html#observational-data).
+>>    when `drs: default`. More details can be found in the 
+[documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/
+quickstart/find_data.html#observational-data).
 >>
 > {: .solution}
 {: .challenge}
@@ -319,7 +324,8 @@ if you want to feed some additional data (e.g. shape files) to your recipe.
 > auxiliary_data_dir: ~/auxiliary_data
 > ```
 > See more information in ESMValTool
-[document](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart/configure.html?highlight=auxiliary_data#user-configuration-file).
+[document](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart
+/configure.html?highlight=auxiliary_data#user-configuration-file).
 {: .callout}
 
 > ## Number of parallel tasks