@@ -6,32 +6,66 @@ Running
6
6
The ESMValCore package provides the ``esmvaltool `` command line tool, which can
7
7
be used to run a :doc: `recipe <../recipe/index >`.
8
8
9
- To run a recipe, call `` esmvaltool run`` with the desired recipe:
9
+ To list the available commands, run
10
10
11
11
.. code :: bash
12
12
13
- esmvaltool run recipe_python.yml
13
+ esmvaltool --help
14
+
15
+ It is also possible to get help on specific commands, e.g.
16
+
17
+ .. code :: bash
18
+
19
+ esmvaltool run --help
20
+
21
+ will display the help message with all options for the ``run `` command.
22
+
23
+ To run a recipe, call ``esmvaltool run `` with the path to the desired recipe:
24
+
25
+ .. code :: bash
26
+
27
+ esmvaltool run recipe_example.yml
28
+
29
+ The ``esmvaltool run recipe_example.yml `` command will first look if
30
+ ``recipe_example.yml `` is the path to an existing file.
31
+ If this is the case, it will run that recipe.
32
+ If you have :ref: `ESMValTool installed <esmvaltool:install >`, it will look if
33
+ the name matches one of the recipes in your ESMValTool installation directory,
34
+ in the subdirectory
35
+ `recipes <https://github.com/ESMValGroup/ESMValTool/blob/main/esmvaltool/recipes/ >`__
36
+ and run that.
37
+
38
+ .. note ::
39
+
40
+ There is no ``recipe_example.yml `` shipped with either ESMValCore or ESMValTool.
41
+ If you would like to try out the command above, replace ``recipe_example.yml ``
42
+ with the path to an existing recipe, e.g.
43
+ `examples/recipe_python.yml <https://github.com/ESMValGroup/ESMValTool/blob/main/esmvaltool/recipes/examples/recipe_python.yml >`_
44
+ if you have the ESMValTool package installed.
45
+
46
+ To work with installed recipes, the ESMValTool package provides the
47
+ ``esmvaltool recipes `` command, see :ref: `esmvaltool:recipes_command `.
14
48
15
49
If the configuration file is not in the default location
16
50
``~/.esmvaltool/config-user.yml ``, you can pass its path explicitly:
17
51
18
52
.. code :: bash
19
53
20
- esmvaltool run --config_file /path/to/config-user.yml recipe_python .yml
54
+ esmvaltool run --config_file /path/to/config-user.yml recipe_example .yml
21
55
22
56
It is also possible to explicitly change values from the config file using flags:
23
57
24
58
.. code :: bash
25
59
26
- esmvaltool run --argument_name argument_value recipe_python .yml
60
+ esmvaltool run --argument_name argument_value recipe_example .yml
27
61
28
62
To automatically download the files required to run a recipe from ESGF, set
29
63
``offline `` to ``false `` in the :ref: `user configuration file `
30
64
or run the tool with the command
31
65
32
66
.. code :: bash
33
67
34
- esmvaltool run --offline=False recipe_python .yml
68
+ esmvaltool run --offline=False recipe_example .yml
35
69
36
70
This feature is available for projects that are hosted on the ESGF, i.e.
37
71
CMIP3, CMIP5, CMIP6, CORDEX, and obs4MIPs.
@@ -40,7 +74,7 @@ To control the strictness of the CMOR checker, use the flag ``--check_level``:
40
74
41
75
.. code :: bash
42
76
43
- esmvaltool run --check_level=relaxed recipe_python .yml
77
+ esmvaltool run --check_level=relaxed recipe_example .yml
44
78
45
79
Possible values are:
46
80
54
88
55
89
.. code :: bash
56
90
57
- esmvaltool run recipe_python .yml --resume_from ~ /esmvaltool_output/recipe_python_20210930_123907
91
+ esmvaltool run recipe_example .yml --resume_from ~ /esmvaltool_output/recipe_python_20210930_123907
58
92
59
93
Multiple directories can be specified for re-use, make sure to quote them:
60
94
61
95
.. code :: bash
62
96
63
- esmvaltool run recipe_python .yml --resume_from " ~/esmvaltool_output/recipe_python_20210930_101007 ~/esmvaltool_output/recipe_python_20210930_123907"
97
+ esmvaltool run recipe_example .yml --resume_from " ~/esmvaltool_output/recipe_python_20210930_101007 ~/esmvaltool_output/recipe_python_20210930_123907"
64
98
65
99
The first preprocessor directory containing the required data will be used.
66
100
@@ -74,7 +108,7 @@ To run only the preprocessor tasks from a recipe, use
74
108
75
109
.. code :: bash
76
110
77
- esmvaltool run recipe_python .yml --remove_preproc_dir=False --run_diagnostic=False
111
+ esmvaltool run recipe_example .yml --remove_preproc_dir=False --run_diagnostic=False
78
112
79
113
.. note ::
80
114
@@ -88,7 +122,7 @@ To run a reduced version of the recipe, usually for testing purpose you can use
88
122
89
123
.. code :: bash
90
124
91
- esmvaltool run --max_datasets=NDATASETS --max_years=NYEARS recipe_python .yml
125
+ esmvaltool run --max_datasets=NDATASETS --max_years=NYEARS recipe_example .yml
92
126
93
127
In this case, the recipe will limit the number of datasets per variable to
94
128
NDATASETS and the total amount of years loaded to NYEARS. They can also be used
@@ -100,7 +134,7 @@ To run a recipe, even if some datasets are not available, use
100
134
101
135
.. code :: bash
102
136
103
- esmvaltool run --skip_nonexistent=True recipe_python .yml
137
+ esmvaltool run --skip_nonexistent=True recipe_example .yml
104
138
105
139
It is also possible to select only specific diagnostics to be run. To tun only
106
140
one, just specify its name. To provide more than one diagnostic to filter use
@@ -109,17 +143,7 @@ attention to the quotes.
109
143
110
144
.. code :: bash
111
145
112
- esmvaltool run --diagnostics=diagnostic1 recipe_python.yml
113
-
114
-
115
-
116
- To get help on additional commands, please use
117
-
118
- .. code :: bash
119
-
120
- esmvaltool --help
121
-
122
-
146
+ esmvaltool run --diagnostics=diagnostic1 recipe_example.yml
123
147
124
148
.. note ::
125
149
0 commit comments