Skip to content

Commit 6093a43

Browse files
committed
codacy stuff
1 parent 34ea774 commit 6093a43

File tree

1 file changed

+27
-25
lines changed

1 file changed

+27
-25
lines changed

_episodes/01-introduction.md

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,27 @@ title: "Introduction"
33
teaching: 0
44
exercises: 25
55
questions:
6-
- What is ESMValTool?
7-
- When to use ESMValTool?
8-
- What are the main parts of ESMValTool that I need to know?
9-
- How does ESMValTool contribute to making climate research FAIR?
10-
- What is the role of the ESMValTool community?
11-
- Where to find help if I'm stuck with ESMValTool?
6+
- What is ESMValTool?
7+
- When to use ESMValTool?
8+
- What are the main parts of ESMValTool that I need to know?
9+
- How does ESMValTool contribute to making climate research FAIR?
10+
- What is the role of the ESMValTool community?
11+
- Where to find help if I'm stuck with ESMValTool?
1212

1313
objectives:
14-
- Describe the difference between ESMValTool and other tools like CDO or xarray
15-
- Understand the main parts of ESMValTool (recipe, diagnostic script)
16-
- Browse the documentation of ESMValTool for help
17-
- Exlain why ESMValTool is a great way to make climate analysis FAIR
18-
- List three different ways to get help from to the ESMValTool community (docs, user engagement email, github issues)
19-
- Know when (not) to use ESMValTool
14+
- Describe the difference between ESMValTool and other tools like CDO or xarray
15+
- Understand the main parts of ESMValTool (recipe, diagnostic script)
16+
- Browse the documentation of ESMValTool for help
17+
- Exlain why ESMValTool is a great way to make climate analysis FAIR
18+
- List three different ways to get help from to the ESMValTool community (docs, user engagement email, github issues)
19+
- Know when (not) to use ESMValTool
2020

2121
keypoints:
22-
- ESMValTool provides a reliable interface to analyse and evaluate climate data
23-
- By streamlining common preprocessor functions, ESMValTool facilitates comparison
24-
- ESMValTool is built and maintained by an active community of climate scientists and software developers
25-
- Using ESMValTool stimulates standardization, collaboration, and reuse
26-
- ESMValTool is written in Python, but supports diagnostic scripts in multiple languages
22+
- ESMValTool provides a reliable interface to analyse and evaluate climate data
23+
- By streamlining common preprocessor functions, ESMValTool facilitates comparison
24+
- ESMValTool is built and maintained by an active community of climate scientists and software developers
25+
- Using ESMValTool stimulates standardization, collaboration, and reuse
26+
- ESMValTool is written in Python, but supports diagnostic scripts in multiple languages
2727

2828
---
2929

@@ -48,25 +48,27 @@ EMSValTool is first and foremost a tool to analyse climate data. But you probabl
4848
>
4949
>> ## ESMValTool is ...
5050
>>
51-
>> ✓ **A tool to analyse climate data.** It takes care of finding, opening, checking, fixing, concatenating, and preprocessing CMIP data and several other supported datasets.
52-
>> ✕ **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.
53-
>> ✓ **A community effort.** EMSValTool is developed and maintained by a large team of climate scientists and software engineers. It is an open source project to which anyone can contribute. Its longevity depends on these contributions.
54-
>> ✓ **Free.** ESMValTool is licenced under Apache 2.0, which means everyone can use, modify, or share it free of charge. However, we *do* encourage all users to contribute to the community once they get more comfortable with the tool.
55-
>> ✓ **A command line tool.** ESMValTool was originally designed for the command line. But, we are working on a user-friendly python interface as well.
56-
>> ✓ **A way to make climate science more [FAIR](https://fair-software.eu/about).** ESMValTool collects provenance information about the data and code that are used to obtain a result. It comes with a readible recipe format that makes climate analysis consistent, reproducible, and easy to share.
57-
>> ✕ **Perfect.** Although we are continuously working to improve the tool, you may encounter some bugs or missing features. In this lesson, you will learn how to troubleshoot, find help, and maybe even contribute to the solution yourself.
58-
>> ✕ **Suitable for (Jupyter) notebooks.** ESMValTool was designed as a command line tool. But, we are working on a user-friendly Python interface as well.
51+
>> ✓ **A tool to analyse climate data.** It takes care of finding, opening, checking, fixing, concatenating, and preprocessing CMIP data and several other supported datasets.
52+
>> ✕ **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.
53+
>> ✓ **A community effort.** EMSValTool is developed and maintained by a large team of climate scientists and software engineers. It is an open source project to which anyone can contribute. Its longevity depends on these contributions.
54+
>> ✓ **Free.** ESMValTool is licenced under Apache 2.0, which means everyone can use, modify, or share it free of charge. However, we *do* encourage all users to contribute to the community once they get more comfortable with the tool.
55+
>> ✓ **A command line tool.** ESMValTool was originally designed for the command line. But, we are working on a user-friendly python interface as well.
56+
>> ✓ **A way to make climate science more [FAIR](https://fair-software.eu/about).** ESMValTool collects provenance information about the data and code that are used to obtain a result. It comes with a readible recipe format that makes climate analysis consistent, reproducible, and easy to share.
57+
>> ✕ **Perfect.** Although we are continuously working to improve the tool, you may encounter some bugs or missing features. In this lesson, you will learn how to troubleshoot, find help, and maybe even contribute to the solution yourself.
58+
>> ✕ **Suitable for (Jupyter) notebooks.** ESMValTool was designed as a command line tool. But, we are working on a user-friendly Python interface as well.
5959
>{: .solution}
6060
{: .challenge}
6161

6262
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*.
6363

6464
## How does ESMValTool work?
65+
6566
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.
6667

6768
![figure showing ESMValTool architecture]({{ page.root }}/fig/esmvaltool_architecture.png)
6869

6970
>## Discussion: (dis)advantages of this approach?
71+
>
7072
> Discuss or think about the pros and cons of this architecture for a moment. Then unfold the box below to see our answers.
7173
>
7274
>

0 commit comments

Comments
 (0)