Skip to content

Commit fd98947

Browse files
authored
Merge pull request #307 from ESMValGroup/fixing_typo
Fixing Typo
2 parents e94ac8a + 190bdeb commit fd98947

4 files changed

Lines changed: 19 additions & 19 deletions

File tree

_episodes/07-development-setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ with changes from the ``main`` branch.
204204
## Contribution
205205
206206
We have seen how to install ESMValTool in a ``develop`` mode.
207-
Now, we try to contribute to its development. Let's see how we this can be achieved.
207+
Now, we try to contribute to its development. Let's see how this can be achieved.
208208
We first discuss our ideas in an
209209
**[issue](https://github.com/ESMValGroup/ESMValTool/issues)** in ESMValTool repository.
210210
This can avoid disappointment at a later stage, for example,
@@ -236,7 +236,7 @@ However, a few (command line) tools can get you a long way,
236236
and we’ll cover those essentials in the next sections.
237237
238238
**Tip**: we encourage you to keep the pull requests small.
239-
Reviewing small incremental changes are more efficient.
239+
Reviewing small incremental changes is more efficient.
240240
241241
### Working example
242242
@@ -347,7 +347,7 @@ To explore other tools, have a look at ESMValTool documentation on
347347
### Run unit tests
348348
349349
Previous section introduced some tools to check code style and quality.
350-
What it has not done is show us how to tell whether our code is getting the right answer.
350+
There is lack of mechanism to determine whether or not our code is getting the right answer.
351351
To achieve that, we need to write and run tests for widely-used functions.
352352
ESMValTool comes with a lot of tests that are in the folder ``tests``.
353353

_episodes/08-diagnostics.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -340,17 +340,17 @@ available functions and their description can be found in
340340
## Diagnostic computation
341341
342342
After grouping and selecting data, we can read individual attributes (such as filename)
343-
of each item. Here we have grouped the input data by ``variables``
344-
so we loop over the variables (line 88). Following this, is a call to the
345-
function ``compute_diagnostic`` (line 93). Let's have a look at the
346-
definition of this function in line 42 where the actual analysis on the data is done.
343+
of each item. Here, we have grouped the input data by ``variables``,
344+
so we loop over the variables (line 88). Following this is a call to the
345+
function ``compute_diagnostic`` (line 93). Let's look at the
346+
definition of this function in line 42, where the actual analysis of the data is done.
347347
348348
Note that output from the ESMValCore preprocessor is in the form of NetCDF files.
349349
Here, ``compute_diagnostic`` uses
350350
[Iris](https://scitools-iris.readthedocs.io/en/latest/index.html) to read data
351351
from a netCDF file and performs an operation ``squeeze`` to remove any dimensions
352-
of length one. We can adapt this function to add our own analysis. As an
353-
example, here we calculate the bias using the average of the data using Iris cubes.
352+
of length one. We can adapt this function to add our own analysis. As an example,
353+
here we calculate the bias using the average of the data using Iris cubes.
354354
355355
~~~python
356356
def compute_diagnostic(filename):

_episodes/09-cmorization.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ the data. This process is called "CMORization".
4040
>
4141
> Concretely, the CMOR standards dictate e.g. the variable names and units,
4242
coordinate information, how the data should be structured (e.g. 1 variable per
43-
file), additional metadata requirements, but also file naming conventions a.k.a.
43+
file), additional metadata requirements, and file naming conventions a.k.a.
4444
the data reference syntax
4545
([DRS](https://docs.esmvaltool.org/projects/esmvalcore/en/latest/quickstart/find_data.html)).
4646
> All this information is stored in so-called CMOR tables.
47-
> As an example, the CMOR tables for the CMIP6 project can be found
47+
> For example, the CMOR tables for the CMIP6 project can be found
4848
[here](https://github.com/PCMDI/cmip6-cmor-tables).
4949
{: .callout}
5050

@@ -105,11 +105,11 @@ Note: you'll need a user-friendly ftp client. On Linux, `ncftp` works okay.
105105
> - **Tier3**: datasets with access restrictions (most of these datasets will also
106106
> need some kind of cmorization)
107107
>
108-
> These access restrictions are also the reason why the ESMValTool developers
108+
> These access restrictions are also why the ESMValTool developers
109109
> cannot distribute copies or automate downloading of all observations and
110-
> reanalysis data used in the recipes. As a compromise we provide the
110+
> reanalysis data used in the recipes. As a compromise, we provide the
111111
> CMORization scripts so that each user can CMORize their own copy of the access
112-
> restricted datasets if they need them.
112+
> restricted datasets if needed.
113113
>
114114
{: .callout}
115115

_episodes/10-debugging.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,10 @@ keypoints:
1414
---
1515

1616
Every user encounters errors. Once you know why you get certain types of errors,
17-
they become much easier to fix. The good news is, ESMValTool creates a record of
17+
they become much easier to fix. The good news is that ESMValTool creates a record of
1818
the output messages and stores them in log files. They can be used for debugging
19-
or monitoring the process. This lesson helps to understand what the different
20-
types of errors are and when you are likely to encounter them.
19+
or monitoring the process. This lesson helps you understand the different
20+
types of errors and when you are likely to encounter them.
2121

2222
## Log files
2323

@@ -326,7 +326,7 @@ save the pre-processed data. More information about this setting can be found at
326326
327327
> ## save_intermediary_cubes
328328
>
329-
> Note that this setting should be only used for debugging, as it significantly
329+
> Note that this setting should only be used for debugging, as it significantly
330330
> slows down the recipe and increases disk usage because a lot of output files
331331
> need to be stored.
332332
{: .callout}
@@ -434,7 +434,7 @@ How to re-run the diagnostic script?
434434
> If you run out of memory, try setting ``max_parallel_tasks`` to 1 in the
435435
> configuration file. Then, check the amount of memory you need for that by
436436
> inspecting the file ``run/resource_usage.txt`` in the output directory. Using
437-
> the number there you can increase the number of parallel tasks again to a
437+
> the number, there you can increase the number of parallel tasks again to a
438438
> reasonable number for the amount of memory available in your system.
439439
{: .callout}
440440

0 commit comments

Comments
 (0)