Skip to content

Commit ba968d9

Browse files
committed
update information about directory structure
1 parent 9189712 commit ba968d9

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

_episodes/03-configuration.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Configuration"
33
teaching: 0
44
exercises: 0
55
questions:
6-
- "What is user configuration file and how can I use it?"
6+
- "What is the user configuration file and how can I use it?"
77
objectives:
88
- "Understand the data directories structure"
99
- "Configure ESMValTool to ignore some settings"
@@ -25,19 +25,40 @@ Make a copy and rename it to ``config-user.yml``:
2525

2626
This file contains the information for:
2727
* Directory structure for the data from different projects
28-
* Rootpaths to input data
28+
* Rootpath to input data
2929
* Number of available CPUs
3030
* Destination directory
3131
* Auxiliary data directory
3232
* Output settings
3333

3434
## Directory structure for the data from different projects
35-
ESMValTool uses several categories (in ESMValTool, this is referred to as projects) for input data based on their source, like CMIP for dataset from climate model intercomparison project, and OBS for observational dataset that adhere to (CMOR standard)[https://cmor.llnl.gov/].
36-
For each category, you can define either one path or several pathes as a list.
35+
Input data can be from various models, observations and reanalysis data that adhere to the [CF/CMOR standard](https://cmor.llnl.gov/). ESMValTool uses several categories (in ESMValTool, this is referred to as projects) for input data based on their source.
36+
The current categories in the configuration file are mentioned below. For example, CMIP is used for a dataset from the climate model intercomparison project whereas OBS for an observational dataset. For each category, you can define either one path or several pathes as a list.
37+
38+
~~~
39+
rootpath:
40+
CMIP3: [~/cmip3_inputpath1, ~/cmip3_inputpath2]
41+
CMIP5: [~/cmip5_inputpath1, ~/cmip5_inputpath2]
42+
CMIP6: [~/cmip6_inputpath1, ~/cmip6_inputpath2]
43+
OBS: ~/obs_inputpath
44+
OBS6: ~/obs6_inputpath
45+
obs4mips: ~/obs4mips_inputpath
46+
ana4mips: ~/ana4mips_inputpath
47+
native6: ~/native6_inputpath
48+
RAWOBS: ~/rawobs_inputpath
49+
default: ~/default_inputpath
50+
~~~
51+
{: .source}
52+
53+
> ## Attention
54+
>
55+
> * For more information about data from different projects, you can visit ESMValTool [documentation](https://esmvaltool.readthedocs.io/en/latest/getting_started/inputdata.html).
56+
{: .callout}
3757

3858
## Rootpaths to input data
59+
The ``rootpath`` specifies the directories where ESMValTool will look for input data.
3960
In this lesson, you work with data from (CMIP5)[https://esgf-node.llnl.gov/projects/cmip5/].
40-
Add the root path of the folder where you downloaded the data during the (Setup)[https://escience-academy.github.io/lesson-esmvaltool/setup.html].
61+
Add the root path of the folder where you downloaded the data during the (Setup)[https://esmvalgroup.github.io/tutorial/setup.html].
4162

4263
~~~
4364
rootpath:
@@ -46,6 +67,11 @@ Add the root path of the folder where you downloaded the data during the (Setup)
4667
~~~
4768
{: .source}
4869

70+
> ## Attention
71+
>
72+
> * For more information about setting the correct rootpath, you can visit ESMValTool [documentation](https://esmvaltool.readthedocs.io/projects/esmvalcore/en/latest/esmvalcore/datafinder.html).
73+
{: .callout}
74+
4975
## Number of available CPUs
5076
## Auxiliary data directory (used for some additional datasets)
5177
auxiliary_data_dir: ~/auxiliary_data

0 commit comments

Comments
 (0)