Skip to content

Commit 35d37ae

Browse files
committed
Add 'how does esmvaltool work' section
1 parent 8651afb commit 35d37ae

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

_episodes/01-introduction.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ keypoints:
2828
---
2929

3030
## What is ESMValTool?
31-
EMSValTool is first and foremost a tool to analyse climate data. But you probably already knew that, and we like to think there's more to it than that.So let's start with a quick check to synchronize our expectations.
31+
EMSValTool is first and foremost a tool to analyse climate data. But you probably already knew that and we like to think there's more to it than that. So let's start with a quick check to synchronize our expectations.
3232

3333
> ## Question: what is ESMValTool?
3434
>
@@ -41,7 +41,7 @@ EMSValTool is first and foremost a tool to analyse climate data. But you probabl
4141
> - A command line tool
4242
> - A way to make climate science more [FAIR](https://fair-software.eu/about)
4343
> - Perfect
44-
> - Quite suitable for (Jupyter) notebooks
44+
> - Suitable for (Jupyter) notebooks
4545
>
4646
> Check our answers by unfolding the boxes below.
4747
>
@@ -56,30 +56,39 @@ EMSValTool is first and foremost a tool to analyse climate data. But you probabl
5656
>
5757
>> ## ESMValTool is not ...
5858
>>
59+
>> - The easy way out. If you just want to do an exploratory analysis or quickly hack something together, ESMValTool is probably not the way to go. The tool is intended for robust, repeatable and shareable climate analysis. That *does* require a bit more effort.
5960
>> - Perfect. Although we are continuously working to improve the tool, you may encounter some bugs or missing features. In this lesson, you'll learn how to troubleshoot, find help, and maybe even contribute to the solution yourself.
60-
>> - The easy way out. If you just want to do an exploratory analysis or quickly hack something together, ESMValTool is probably not the way to go. The tool is intended for robust, repeatable and shareable climate analysis.
61-
>> - Quite suitable for (Jupyter) notebooks. ESMValTool was designed as a command line tool. But, we are working on a user-friendly Python interface as well.
61+
>> - Suitable for (Jupyter) notebooks. ESMValTool was designed as a command line tool. But, we are working on a user-friendly Python interface as well.
6262
>{: .solution}
6363
{: .challenge}
6464

65-
To learn more about ESMValTool, you can find more information in the [documentation](https://docs.esmvaltool.org/en/latest/introduction.html), or the [overview paper](https://gmd.copernicus.org/articles/13/1179/2020/) in *Geoscientific Model Development*.
65+
To learn more about ESMValTool is, you can look at the [documentation](https://docs.esmvaltool.org/en/latest/introduction.html), the [official website](https://www.esmvaltool.org/about.html), or the [overview paper](https://gmd.copernicus.org/articles/13/1179/2020/) in *Geoscientific Model Development*.
6666

6767
## How does ESMValTool work?
68+
The figure below shows the different components of ESMValTool. Most of the work is done in the 'core', which performs a number of preprocessor steps. Outside of the core we have some configuration files that specify things like *where to find the CMIP data*. The most important file however, is the *recipe* that specifies which preprocessor functions need to be applied to what data. The recipe also points to a diagnostic script that is executed after the preprocessor and performs a more specific analysis on the preprocessed data.
6869

69-
### ESMValTool and ESMValCore
70+
![figure showing ESMValTool architecture]({{ page.root }}/fig/esmvaltool_architecture.png)
7071

71-
Include figure describing ESMValTool
72-
73-
### Preprocessor
74-
75-
### Recipe (include callout on yml)
76-
77-
### Global settings (user-config.yml)
78-
79-
### Diagnostics
72+
>## Discussion: (dis)advantages of this approach?
73+
> Discuss or think about the pro's and cons of this architecture for a moment. Then unfold the box below to see our answers.
74+
>
75+
>
76+
>>## See our thoughts
77+
>>
78+
>> - Streamlining common preprocessing steps ensures consistency in the algorithms being used and the way they are executed. This facilitates comparison and reproducibility.
79+
>> - Provenance and citation information can be tracked through the entire workflow.
80+
>> - The core builds upon the [iris](https://scitools.org.uk/iris/docs/latest/) package, which is quite strict in order to minimize unexpected results.
81+
>> - Recipes are easy to read and share.
82+
>> - A collection of recipes and diagnostic scripts is shipped with ESMValTool, ready for re-use. Everyone can add to this collection.
83+
>> - The recipe format takes some getting used to and may be a bit less flexible then working on the datasets directly.
84+
>> - Missing features can be more of a limiting factor.
85+
>{: .solution}
86+
{: .discussion}
8087

8188
## Community
8289

90+
some exercises:
91+
8392
- How many people are connected to github?
8493
- How many open issues?
8594
- How many merged pull requests in the last month?

0 commit comments

Comments
 (0)