Skip to content

Commit d296482

Browse files
committed
addressing codacy issues
1 parent 75b676c commit d296482

1 file changed

Lines changed: 56 additions & 35 deletions

File tree

index.md

Lines changed: 56 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -11,76 +11,97 @@ The Earth System Model Evaluation Tool (ESMValTool) is a community developed sof
1111
the diagnosis and evaluation of the causes and effects of model biases and inter-model spread within the CMIP model
1212
ensemble.
1313

14-
1514
This tutorial is structured such that the main body of the tutorial, up to the episode 7, can be done in one sitting.
1615
From episode 8, each episode is a mini-tutorial covering an advanced aspect of working with ESMValTool.
1716
These mini-tutorials can be appended to the main tutorial or worked through independently.
1817

1918
> ## What will you learn in this course
2019
>
21-
> - What is ESMValTool
22-
> - How to install ESMValTool
23-
> - How to configure ESMValTool for your local system
24-
> - How to run ESMValTool
25-
> - How to work with ESMValTool's suite of preprocessors
26-
> - How to debug your recipes
27-
> - How to access and deploy recipes from the ESMValTools gallery (Advanced)
28-
> - How to develop your own diagnostics and recipes (Advanced)
29-
> - How to contribute your recipes and diagnostics back into ESMValTool (Advanced)
30-
> - How to include new observational datasets (Advanced)
20+
> - What is ESMValTool
21+
>
22+
> - How to install ESMValTool
23+
>
24+
> - How to configure ESMValTool for your local system
25+
>
26+
> - How to run ESMValTool
27+
>
28+
> - How to work with ESMValTool's suite of preprocessors
29+
>
30+
> - How to debug your recipes
31+
>
32+
> - How to access and deploy recipes from the ESMValTools gallery (Advanced)
33+
>
34+
> - How to develop your own diagnostics and recipes (Advanced)
35+
>
36+
> - How to contribute your recipes and diagnostics back into ESMValTool (Advanced)
37+
>
38+
> - How to include new observational datasets (Advanced)
3139
>
3240
{: .checklist}
3341

3442
> ## Prerequisites
3543
>
3644
> *Minimal requirements:*
37-
> - Basic understanding of your preferred command line interface (ie a bash terminal)
38-
> - Laptop/desktop with [(mini)conda](https://docs.conda.io/en/latest/miniconda.html) installed
39-
> - Access to CMIP data
45+
>
46+
> - Basic understanding of your preferred command line interface (ie a bash terminal)
47+
>
48+
> - Laptop/desktop with [(mini)conda](https://docs.conda.io/en/latest/miniconda.html) installed
49+
>
50+
> - Access to CMIP data
4051
>
4152
> *Optional, but useful:*
42-
> - Basic understanding of git
43-
> - Access to a suitable computing system (eg CEDA-Jasmin, DKRZ-Mistral)
44-
> - GitHub account
53+
>
54+
> - Basic understanding of git
55+
>
56+
> - Access to a suitable computing system (eg CEDA-Jasmin, DKRZ-Mistral)
57+
>
58+
> - GitHub account
59+
>
4560
{: .prereq}
4661

47-
4862
### Main things you need to know before starting this course
4963

50-
1. This tutorial can be taken online independently or taught by one of our instructors.
51-
2. Don’t be alarmed if you can’t work through the entire tutorial in one sitting. It may take some time to get used to working with ESMValTool.
52-
3. If you get stuck, help is always available from the tutors, from ESMValTool developers via the [github issues page](https://github.com/ESMValGroup/ESMValTool/issues)
53-
or via the [ESMValTool email list](mailto:esmvaltool@listserv.dfn.de).
54-
4. This tutorial includes several advanced lessons after the conclusion. These advanced lessons should be treated like “mini-tutorials”, and include aspects like “developing your own diagnostic” or “how to include observations”.
64+
1. This tutorial can be taken online independently or taught by one of our instructors.
65+
66+
2. Don’t be alarmed if you can’t work through the entire tutorial in one sitting. It may take some time to get used to working with ESMValTool.
5567

68+
3. If you get stuck, help is always available from the tutors, from ESMValTool developers via the [github issues page](https://github.com/ESMValGroup/ESMValTool/issues)
69+
or via the [ESMValTool email list](mailto:esmvaltool@listserv.dfn.de).
5670

71+
4. This tutorial includes several advanced lessons after the conclusion. These advanced lessons should be treated like “mini-tutorials”, and include aspects like “developing your own diagnostic” or “how to include observations”.
5772

58-
> ## Additional resources:
73+
> ## Additional resources
74+
>
5975
> - [Read the docs page](https://esmvaltool.readthedocs.io/)
76+
>
6077
> - [ESMValTool home page](https://www.esmvaltool.org/)
78+
>
6179
> - [Technical description paper](https://doi.org/10.5194/gmd-13-1179-2020)
80+
>
6281
> - [ESMValTool Source code](https://github.com/ESMValGroup/ESMValTool)
82+
>
6383
> - [ESMValCore Source code](https://github.com/ESMValGroup/ESMValCore)
84+
>
6485
{: .callout}
6586

6687
## How to cite ESMValTool
6788

6889
Please cite this tutorial as:
6990

70-
- ESMValTool 2.0 tutorial, ESMValTool developers, version [ADD VERSION],
71-
[https://github.com/ESMValGroup/tutorial](https://github.com/ESMValGroup/tutorial),
72-
[DATE].
91+
- ESMValTool 2.0 tutorial, ESMValTool developers, version [ADD VERSION],
92+
[https://github.com/ESMValGroup/tutorial](https://github.com/ESMValGroup/tutorial),
93+
[DATE].
7394

7495
Please cite ESMValTool as:
7596

76-
- Lauer, A., Eyring, V., Bellprat, O., Bock, L., Gier, B. K., Hunter, A.,
77-
Lorenz, R., Pérez-Zanón, N., Righi, M., Schlund, M., Senftleben, D.,
78-
Weigel, K., and Zechlau, S.:
79-
Earth System Model Evaluation Tool (ESMValTool) v2.0 – diagnostics for
80-
emergent constraints and future projections from Earth system models in CMIP,
81-
Geosci. Model Dev. Discuss.,
82-
[https://doi.org/10.5194/gmd-2020-60](https://doi.org/10.5194/gmd-2020-60),
83-
in review, 2020.
97+
- Lauer, A., Eyring, V., Bellprat, O., Bock, L., Gier, B. K., Hunter, A.,
98+
Lorenz, R., Pérez-Zanón, N., Righi, M., Schlund, M., Senftleben, D.,
99+
Weigel, K., and Zechlau, S.:
100+
Earth System Model Evaluation Tool (ESMValTool) v2.0 – diagnostics for
101+
emergent constraints and future projections from Earth system models in CMIP,
102+
Geosci. Model Dev. Discuss.,
103+
[https://doi.org/10.5194/gmd-2020-60](https://doi.org/10.5194/gmd-2020-60),
104+
in review, 2020.
84105

85106

86107
{% include links.md %}

0 commit comments

Comments
 (0)