Skip to content

Commit 5f13e54

Browse files
Merge pull request #253 from ESMValGroup/fix_check_fails
Fix on push check fails
2 parents 123ed7b + 3341c76 commit 5f13e54

20 files changed

+404
-274
lines changed

CODE_OF_CONDUCT.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
layout: page
3+
title: "Contributor Code of Conduct"
4+
---
15
# Contributor Code of Conduct
26

37
As contributors and maintainers of this tutorial,

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# ESMValTool Tutorial
22

3-
[![Join the chat at
4-
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)
5-
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3974592.svg)](https://doi.org/10.5281/zenodo.3974592)
3+
[![Join the chat at https://gitter.im/ESMValGroup/Tutorial](
4+
https://badges.gitter.im/ESMValGroup/Tutorial.svg)](
5+
https://gitter.im/ESMValGroup/Tutorial)
6+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3974592.svg)](
7+
https://doi.org/10.5281/zenodo.3974592)
68

79

810
[ESMValTool Tutorial][tutorial-site] is an open-source project in

_episodes/01-introduction.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,8 @@ documentation:
6464
- lastname_firstname
6565

6666
datasets:
67-
- {dataset: HadGEM2-ES, project: CMIP5, exp: historical, mip: Amon, ensemble: r1i1p1, start_year: 1960, end_year: 2005}
67+
- {dataset: HadGEM2-ES, project: CMIP5, exp: historical, mip: Amon,
68+
ensemble: r1i1p1, start_year: 1960, end_year: 2005}
6869

6970
preprocessors:
7071
global_mean:
@@ -88,8 +89,9 @@ diagnostics:
8889
>
8990
> > ## Solution
9091
> > The keys are explained in the ESMValTool documentation, in the `Recipe
91-
>> section `, under
92-
> [datasets](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/overview.html#recipe-section-datasets)
92+
> > section `, under
93+
> [datasets](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/recipe/
94+
overview.html#recipe-section-datasets)
9395
> {: .solution}
9496
{: .challenge}
9597

_episodes/02-installation.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,18 @@ depending on your level of expertise or involvement with ESMValTool and
3030
associated software such as GitHub and Mamba.
3131

3232
1. If you have access to a server where ESMValTool is already installed
33-
as a module, for e.g., the [CEDA JASMIN](https://help.jasmin.ac.uk/article/4955-community-software-esmvaltool)
33+
as a module, for e.g., the [CEDA JASMIN](https://help.jasmin.ac.uk/article
34+
/4955-community-software-esmvaltool)
3435
server, you can simply load the module with the following command:
3536
~~~bash
3637
module load esmvaltool
3738
~~~
38-
After loading ``esmvaltool``, we can start using ESMValTool right away. Please see the [next lesson]({{ page.root }}{% link _episodes/03-configuration.md %}).
39+
After loading ``esmvaltool``, we can start using ESMValTool right away. Please
40+
see the [next lesson]({{ page.root }}{% link _episodes/03-configuration.md %}).
3941
2. If you would like to install ESMValTool as a mamba package, then this lesson
4042
will tell you how!
41-
3. If you would like to start experimenting with existing diagnostics or contributing to ESMvalTool, please see the instructions for
43+
3. If you would like to start experimenting with existing diagnostics or
44+
contributing to ESMvalTool, please see the instructions for
4245
source installation in the lesson [Development and
4346
contribution]({{ page.root }}{% link _episodes/07-development-setup.md %}) and
4447
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
6265
ESMValTool is distributed using [Mamba](https://mamba.readthedocs.io/en/latest/index.html).
6366
To install mamba on ``Linux`` or ``MacOSX``, follow the instructions below:
6467

65-
1. Please download the installation file for the latest Mamba version [here](https://github.com/conda-forge/miniforge#mambaforge).
68+
1. Please download the installation file for the latest Mamba version
69+
[here](https://github.com/conda-forge/miniforge#mambaforge).
6670

6771
2. Next, run the installer from the place where you downloaded it:
6872

@@ -98,7 +102,8 @@ To install mamba on ``Linux`` or ``MacOSX``, follow the instructions below:
98102
This should show the path to your mamba executable, e.g. `~/mambaforge/bin/mamba`.
99103

100104
For more information about installing mamba,
101-
see [the mamba installation documentation](https://docs.esmvaltool.org/en/latest/quickstart/installation.html#mamba-installation).
105+
see [the mamba installation documentation](https://docs.esmvaltool.org/en
106+
/latest/quickstart/installation.html#mamba-installation).
102107

103108
### Install the ESMValTool package
104109

@@ -121,18 +126,22 @@ mamba create --name esmvaltool esmvaltool 'python=3.10'
121126
```
122127

123128
On MacOSX ESMValTool functionalities in Julia, NCL, and R are not supported. To install
124-
a Mamba environment on MacOSX, please refer to specific [information](https://docs.esmvaltool.org/en/latest/quickstart/installation.html#installation-on-macosx).
129+
a Mamba environment on MacOSX, please refer to specific [information](https://
130+
docs.esmvaltool.org/en/latest/quickstart/installation.html#installation-on-
131+
macosx).
125132

126133
This will create a new [Mamba
127-
environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)
134+
environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks
135+
/manage-environments.html)
128136
called `esmvaltool`, with the ESMValTool package and all of its dependencies
129137
installed in it.
130138

131139

132140
> ## Common issues
133141
>
134142
> You find a list of common installation problems and their solutions in the
135-
> [documentation](https://docs.esmvaltool.org/en/latest/quickstart/installation.html#common-installation-problems-and-their-solutions).
143+
> [documentation](https://docs.esmvaltool.org/en/latest/quickstart/installation
144+
.html#common-installation-problems-and-their-solutions).
136145
>
137146
{: .callout}
138147

_episodes/03-configuration.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,8 @@ file are mentioned below. For example, CMIP is used for a dataset from
140140
the Climate Model Intercomparison Project whereas OBS may be
141141
used for an observational dataset.
142142
More information about the projects used in ESMValTool is available in the
143-
[documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/quickstart/find_data.html).
143+
[documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/
144+
quickstart/find_data.html).
144145
When using ESMValTool on your own machine, you can create a directory to download
145146
climate model data or observation data sets and let the tool use data from there.
146147
It is also possible to ask
@@ -222,7 +223,8 @@ removing the machine specific lines should be sufficient to access input data.
222223
>>```
223224
>>
224225
>> - For more information about setting the rootpath, see also the ESMValTool
225-
>> [documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/quickstart/find_data.html).
226+
>> [documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/
227+
quickstart/find_data.html).
226228
> {: .solution}
227229
{: .challenge}
228230
@@ -236,7 +238,8 @@ The ``drs`` setting describes the file structure for several projects (e.g.
236238
CMIP6, CMIP5, obs4mips, OBS6, OBS) on several key machines
237239
(e.g. BADC, CP4CDS, DKRZ, ETHZ, SMHI, BSC). For more
238240
information about ``drs``, you can visit the ESMValTool documentation on
239-
[Data Reference Syntax (DRS)](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/quickstart/find_data.html#cmor-drs).
241+
[Data Reference Syntax (DRS)](https://docs.esmvaltool.org/projects/esmvalcore/
242+
en/latest/quickstart/find_data.html#cmor-drs).
240243
241244
> ## Set the correct drs
242245
>
@@ -299,7 +302,9 @@ information about ``drs``, you can visit the ESMValTool documentation on
299302
>> 2. Observational data are organized in Tiers depending on their level of
300303
>> public availability. Therefore the default directory must be structured
301304
>> accordingly with sub-directories `TierX` e.g. Tier1, Tier2 or Tier3, even
302-
>> 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).
305+
>> when `drs: default`. More details can be found in the
306+
[documentation](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/
307+
quickstart/find_data.html#observational-data).
303308
>>
304309
> {: .solution}
305310
{: .challenge}
@@ -319,7 +324,8 @@ if you want to feed some additional data (e.g. shape files) to your recipe.
319324
> auxiliary_data_dir: ~/auxiliary_data
320325
> ```
321326
> See more information in ESMValTool
322-
[document](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart/configure.html?highlight=auxiliary_data#user-configuration-file).
327+
[document](https://docs.esmvaltool.org/projects/ESMValCore/en/latest/quickstart
328+
/configure.html?highlight=auxiliary_data#user-configuration-file).
323329
{: .callout}
324330
325331
> ## Number of parallel tasks

0 commit comments

Comments
 (0)