|
1 | 1 | --- |
2 | 2 | title: "Introduction" |
3 | 3 | teaching: 0 |
4 | | -exercises: 0 |
| 4 | +exercises: 10 |
5 | 5 | 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? |
12 | 12 |
|
13 | 13 | 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 |
20 | 20 |
|
21 | 21 | 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 |
27 | 27 |
|
28 | 28 | --- |
29 | 29 |
|
30 | | -## Welcome |
31 | | - |
32 | | - |
33 | 30 | ## 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. |
| 32 | + |
| 33 | +> ## Question: what is ESMValTool? |
| 34 | +> |
| 35 | +> Which of the following items would you say apply to ESMValTool? |
| 36 | +> |
| 37 | +> - A tool to analyse climate data |
| 38 | +> - The easy way out |
| 39 | +> - A community effort |
| 40 | +> - Free |
| 41 | +> - A command line tool |
| 42 | +> - A way to make climate science more [FAIR](https://fair-software.eu/about) |
| 43 | +> - Perfect |
| 44 | +> - Quite suitable for (Jupyter) notebooks |
| 45 | +> |
| 46 | +> Check our answers by unfolding the boxes below. |
| 47 | +> |
| 48 | +>> ## ESMValTool is ... |
| 49 | +>> |
| 50 | +>> - A tool to analyse climate data. It takes care of finding, opening, checking, fixing, concatenating, and preprocessing CMIP data and several other supported datasets. |
| 51 | +>> - 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, reproducbile, and easy to share. |
| 52 | +>> - 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. It's longevity depends on these contributions. |
| 53 | +>> - A command line tool. ESMValTool was originally designed for the command line. But, we are working on a user-friendly python interface as well. |
| 54 | +>> - Free. ESMValTool is licenced under Apache 2.0, which means everyone can use, modify, or share it free of charge. We *do* encourage all users to contribute to the community once they get more comfortable with the tool, though. |
| 55 | +>{: .solution} |
| 56 | +> |
| 57 | +>> ## ESMValTool is not ... |
| 58 | +>> |
| 59 | +>> - 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. |
| 62 | +>{: .solution} |
| 63 | +{: .challenge} |
| 64 | + |
| 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*. |
| 66 | + |
| 67 | +## How does ESMValTool work? |
| 68 | + |
| 69 | +### ESMValTool and ESMValCore |
34 | 70 |
|
35 | | -## ESMValTool and ESMValCore |
36 | 71 | Include figure describing ESMValTool |
37 | 72 |
|
38 | | -## What are the main parts of ESMValTool that I need to know? |
39 | | - |
40 | | - |
41 | | -## Preprocessor |
42 | | - |
| 73 | +### Preprocessor |
43 | 74 |
|
44 | | -## Recipe (include callout on yml) |
| 75 | +### Recipe (include callout on yml) |
45 | 76 |
|
| 77 | +### Global settings (user-config.yml) |
46 | 78 |
|
47 | | -## Global settings (user-config.yml) |
48 | | - |
49 | | - |
50 | | -## Diagnostics |
| 79 | +### Diagnostics |
51 | 80 |
|
52 | 81 | ## Community |
53 | 82 |
|
54 | 83 | - How many people are connected to github? |
55 | 84 | - How many open issues? |
56 | 85 | - How many merged pull requests in the last month? |
57 | 86 |
|
58 | | - |
59 | | - |
60 | 87 | {% include links.md %} |
61 | | - |
|
0 commit comments