Skip to content

Commit dd72f7e

Browse files
committed
fix the link to config_references
1 parent 1afa69f commit dd72f7e

File tree

2 files changed

+27
-16
lines changed

2 files changed

+27
-16
lines changed

_episodes/04-recipe.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -181,14 +181,22 @@ Please note the following sections:
181181
The documentation consists of the following information:
182182
183183
- description: a short description of the recipe
184-
- authors: a list of authors (linked to `esmvaltool/config-references.yml`)
185-
- maintainer: a list of maintainers (linked to
186-
`esmvaltool/config-references.yml`)
187-
- references: a list of references (linked to a bibtexfile in
188-
`esmvaltool/references` with the same name)
189-
- projects: a list of projects (linked to
190-
`esmvaltool/config-references.yml`)
184+
- authors: a list of authors
185+
- maintainer: a list of maintainers
186+
- references: a list of references
187+
- projects: a list of projects
191188
189+
> ## config-references.yml and references
190+
>
191+
> The values for the keys ``author``, ``maintainer``, ``projects`` and
192+
> ``references`` in the recipe should be known by ESMValTool. A list of ESMValTool
193+
> author, maintainer, and projects are mentioned in the file ``config-references.yml``
194+
> that can be found in
195+
> [ESMValTool/esmvaltool](https://github.com/ESMValGroup/ESMValTool/blob/master/esmvaltool/config-references.yml).
196+
>
197+
> ESMValTool references in `BibTeX` format can be found in
198+
> [ESMValTool/esmvaltool/references](https://github.com/ESMValGroup/ESMValTool/tree/master/esmvaltool/references).
199+
{: .callout}
192200
193201
- datasets: lines 22-23
194202
@@ -399,9 +407,9 @@ available) can be found below. Note that the timestamps differ.
399407
400408
> ## Your output plot(s).
401409
> Plots for the dataset(s) are located in `./recipe_example_#_#/plots/timeseries_diag/`
402-
>
410+
>
403411
> For a single dataset:
404-
>
412+
>
405413
> ![single dataset](../fig/diag_CMIP5_HadGEM2-ES_Omon_historical_r1i1p1_thetaoga_prep_timeseries_diag_timeseries_temperature_1859_2005_timeseries_0.png "single dataset")
406414
>
407415
> Or an overlay plot, if multiple datasets are defined:
@@ -410,8 +418,8 @@ available) can be found below. Note that the timestamps differ.
410418
{: .solution}
411419
412420
> ## Your main output log file.
413-
> The main output file is located at `./recipe_example_#_#/run/main_log.txt/`
414-
>
421+
> The main output file is located at `./recipe_example_#_#/run/main_log.txt/`
422+
>
415423
> ~~~bash
416424
> INFO [33433]
417425
> ______________________________________________________________________
@@ -499,7 +507,7 @@ available) can be found below. Note that the timestamps differ.
499507
500508
> ## Your settings.yml file.
501509
> This file is located at `./recipe_example_#_#/run/diag_timeseries_temperature/timeseries_diag/settings.yaml`.
502-
>
510+
>
503511
> ```YAML
504512
> auxiliary_data_dir: /mnt/lustre01/pf/b/b380506/work/auxiliary_data
505513
> input_files:
@@ -519,9 +527,9 @@ available) can be found below. Note that the timestamps differ.
519527
{: .solution}
520528
521529
> ## A metadata.yml file.
522-
>
530+
>
523531
> This file is located at `./recipe_example_#_#/preproc/diag_timeseries_temperature/timeseries_variable/metadata.yml`.
524-
>
532+
>
525533
> ```YAML
526534
> ? /scratch/b/b380506/recipe_example_20200701_082257/preproc/diag_timeseries_temperature/timeseries_variable/CMIP5_HadGEM2-ES_Omon_historical_r1i1p1_thetaoga_1859-2005.nc
527535
> : alias: HadGEM2-ES
@@ -552,7 +560,7 @@ available) can be found below. Note that the timestamps differ.
552560
553561
> ## The diagnostic log file.
554562
> This file is located at `./recipe_example_#_#/run/diag_timeseries_temperature/timeseries_diag/log.txt`
555-
>
563+
>
556564
> ~~~bash
557565
> Starting diagnostic script timeseries_diag with configuration:
558566
> auxiliary_data_dir: /mnt/lustre01/pf/b/b380506/work/auxiliary_data

_episodes/06-debugging.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,13 +215,16 @@ attach the run/recipe_*.yml and run/main_log_debug.txt files from the output dir
215215
216216
The values for the keys ``author``, ``maintainer``, ``projects`` and
217217
``references`` in the recipe should be known by ESMValTool. A list of ESMValTool
218-
author, maintainer, references, and projects can be found in the
218+
author, maintainer, and projects can be found in the
219219
``config-references.yml``. You could download this file:
220220
221221
~~~bash
222222
wget https://github.com/ESMValGroup/ESMValTool/blob/master/esmvaltool/config-references.yml
223223
~~~
224224
225+
And ESMValTool references in `BibTeX` format can be found
226+
[here](https://github.com/ESMValGroup/ESMValTool/tree/master/esmvaltool/references).
227+
225228
> ## ESMValTool can’t locate the data
226229
>
227230
> You are assisting a colleague with ESMValTool. The colleague replaces the

0 commit comments

Comments
 (0)