Skip to content

Commit 2339015

Browse files
committed
adding a mention of a current working directory to run through all our lessons
1 parent 9fc67d8 commit 2339015

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

_episodes/03-configuration.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@ keypoints:
2020

2121
## The configuration file
2222

23+
For the purposes of this tutorial, we will create a directory in our home directory
24+
called `esmvaltool_tutorial` and use that as our working directory. The following steps
25+
should do that:
26+
27+
~~~bash
28+
mkdir esmvaltool_tutorial
29+
cd esmvaltool_tutorial
30+
~~~
31+
2332
The ``config-user.yml`` configuration file contains all the global level
2433
information needed by ESMValTool to run.
2534
This is a [YAML file](https://yaml.org/spec/1.2/spec.html).
@@ -30,11 +39,14 @@ You can get the default configuration file by running:
3039
esmvaltool config get_config_user --path=<target_dir>
3140
~~~
3241
The default configuration file will be downloaded to the directory specified with
33-
the `--path` variable. If this option is not used, the file will be saved to the default
42+
the `--path` variable. For instance, you can provide the path to your working directory
43+
as the `target_dir`. If this option is not used, the file will be saved to the default
3444
location: `~/.esmvaltool/config-user.yml`, where `~` is the
3545
path to your home directory. Note that files and directories starting with a
3646
period are "hidden", to see the `.esmvaltool` directory in the terminal use
37-
`ls -la ~`.
47+
`ls -la ~`.
48+
49+
3850

3951
We run a text editor called ``nano`` to have a look inside the configuration file
4052
and then modify it if needed:

_episodes/04-recipe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,12 +204,12 @@ Let's dissect what's happening here.
204204
> > 1. The config file should be the one we edited in the previous episode,
205205
> > something like `/home/<username>/.esmvaltool/config-user.yml` or `./config-user.yml`.
206206
> > 1. ESMValTool found the recipe in its installation directory, something like
207-
> > `/home/user/username/miniconda3/envs/esmvaltool_tutorial/bin/esmvaltool/recipes/examples/`
207+
> > `/home/user/username/miniconda3/envs/esmvaltool/bin/esmvaltool/recipes/examples/`
208208
>> or if you are using a pre-installed module on a server, something like `/apps/jasmin/community/esmvaltool/ESMValTool_2.4.0/esmvaltool/recipes/examples/recipe_python.yml`
209209
> > 1. ESMValTool creates a time-stamped output directory for every run. In this
210210
> > case, it should be something like `recipe_python_YYYYMMDD_HHMMSS`. This
211211
> > folder is made inside the output directory specified in the previous
212-
> > episode: `~/home/<user>/esmvaltool_tutorial/esmvaltool_output`.
212+
> > episode: `~/home/<username>/esmvaltool_tutorial/esmvaltool_output`.
213213
> > 1. There should be four output folders:
214214
> > - `plots/`: this is where output figures are stored.
215215
> > - `preproc/`: this is where pre-processed data are stored.

0 commit comments

Comments
 (0)