Skip to content

Commit

Permalink
Merge pull request #279 from ESMValGroup/update_to_v2.8
Browse files Browse the repository at this point in the history
Updates for v2.8 in basic tutorial lessons and setup
  • Loading branch information
rswamina authored May 2, 2023
2 parents a370df2 + c8a5ff7 commit bc6f7be
Show file tree
Hide file tree
Showing 11 changed files with 333 additions and 259 deletions.
2 changes: 1 addition & 1 deletion _episodes/00-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Introduction"
teaching: 5
exercises: 10
compatibility: ESMValTool v2.6.0
compatibility: ESMValTool v2.8.0

questions:
- What is ESMValTool?
Expand Down
6 changes: 2 additions & 4 deletions _episodes/01-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Quickstart guide"
teaching: 2
exercises: 8
compatibility: ESMValTool v2.6.0
compatibility: ESMValTool v2.8.0

questions:

Expand All @@ -24,7 +24,7 @@ keypoints:
to run ESMValTool as quickly as possible without having to go through the
whole tutorial"
- "Use the `module load` command to load the ESMValTool environment,
see the [installation]({{ page.root }}{% link _episodes/02-installation.md %})
see the [Installation](https://esmvalgroup.github.io/ESMValTool_Tutorial/02-installation/index.html)
episode for more details and use `esmvaltool --help` to check the ESMValTool
environment"
- "Use `esmvaltool config get_config_user` to create the ESMValTool user
Expand All @@ -33,8 +33,6 @@ keypoints:
---


- {: .callout}

> ## What is the purpose of the quickstart guide?
>
> - The purpose of the quickstart guide is to enable a user of ESMValTool to
Expand Down
11 changes: 7 additions & 4 deletions _episodes/02-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Installation"
teaching: 10
exercises: 10
compatibility: ESMValTool v2.6.0
compatibility: ESMValTool v2.8.0
questions:
- "What are the prerequisites for installing ESMValTool?"
- "How do I confirm that the installation was successful?"
Expand Down Expand Up @@ -123,7 +123,7 @@ For the tutorial, we will install the complete package. Thus, to install the
ESMValTool package, run

```bash
mamba create --name esmvaltool esmvaltool 'python=3.10'
mamba create --name esmvaltool esmvaltool
```

On MacOSX ESMValTool functionalities in Julia, NCL, and R are not supported. To install
Expand Down Expand Up @@ -229,10 +229,13 @@ to display the command line help.
> > {: .bash}
> > The version of ESMValTool installed should be displayed on the screen as:
> > ~~~
> > ESMValCore: 2.6.0
> > ESMValTool: 2.6.0
> > ESMValCore: 2.8.0
> > ESMValTool: 2.8.0
> > ~~~
> > {: .output}
> Note that on HPC servers such as JASMIN, sometimes a more recent development
> version may be displayed for ESMValTool, for e.g.
> `ESMValTool: 2.9.0.dev4+g6948d5512`
> {: .solution}
{: .challenge}

Expand Down
7 changes: 4 additions & 3 deletions _episodes/03-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Configuration"
teaching: 10
exercises: 10
compatibility: ESMValTool v2.6.0
compatibility: ESMValTool v2.8.0

questions:
- What is the user configuration file and how should I use it?
Expand Down Expand Up @@ -153,10 +153,11 @@ download directory and by setting the option to download data as shown below.
```yaml
# Directory for storing downloaded climate data
download_dir: ~/climate_data
offline: false
search_esgf: always
```
If you are working offline or do not want to download the data then set the
option above to `true`.
option above to `never`. If you want to download data only when the necessary files
are missing at the usual location, you can set the option to `when_missing`.
The ``rootpath`` specifies the directories where ESMValTool will look for input data.
For each category, you can define either one path or several paths as a list. For example:
Expand Down
Loading

0 comments on commit bc6f7be

Please sign in to comment.