Skip to content

Commit dfe7392

Browse files
authored
Merge pull request #196 from ESMValGroup/fix_links_development
Fix links in development and add download option
2 parents 110f1b7 + babd172 commit dfe7392

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

_episodes/08-development-setup.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,14 @@ ESMValTool is an open-source project in ESMValGroup. We can contribute to its de
2525
- a new or updated recipe script, see lesson on
2626
[Writing your own recipe]({{ page.root }}{% link _episodes/05-preprocessor.md %})
2727
- a new or updated diagnostics script, see lesson on
28-
[Writing your own diagnostic script]
28+
[Writing your own diagnostic script]({{ page.root }}{% link _episodes/10-diagnostics.md %})
2929
- a new or updated cmorizer script, see lesson on
30-
[CMORization: Using observational datasets]
30+
[CMORization: Using observational datasets]({{ page.root }}{% link _episodes/09-cmorization.md %})
3131
- helping with reviewing process of pull requests, see ESMValTool documentation on
3232
[Review of pull requests](https://docs.esmvaltool.org/en/latest/community/review.html)
3333

34-
In this lesson, we first show how to set up a development installation of ESMValTool. So, you can
35-
make modifications. Then, we explain the process of how to contribute your changes or additions
36-
to the community.
34+
In this lesson, we first show how to set up a development installation of ESMValTool so you can
35+
make changes or additions. We then explain how you can contribute these changes to the community.
3736

3837
> ## Git knowledge
3938
>
@@ -53,7 +52,13 @@ Let’s get started.
5352

5453
The ESMValTool source code is available on a public GitHub repository:
5554
[https://github.com/ESMValGroup/ESMValTool](https://github.com/ESMValGroup/ESMValTool).
56-
To obtain the code, the easiest way is to clone the repository:
55+
To obtain the code, there are two options:
56+
57+
1. download the code from the repository. A ZIP file called
58+
``ESMValTool-master.zip`` is downloaded. To continue the installation, unzip
59+
the file, move to the ``ESMValTool-master`` directory and then follow the
60+
sequence of steps starting from **2 ESMValTool dependencies**.
61+
2. clone the repository if you want to contribute to the ESMValTool development:
5762

5863
~~~bash
5964
git clone https://github.com/ESMValGroup/ESMValTool.git
@@ -171,6 +176,14 @@ If the installation is successful, ESMValTool prints a help message to the conso
171176
> {: .solution}
172177
{: .challenge}
173178
179+
### 4 Updating ESMValTool
180+
181+
The ``master`` branch has the latest features of ESMValTool. Please make sure
182+
that the source code on your machine is up-to-date. If you obtain the source
183+
code using git clone as explained in step **1 Source code**, you can run ``git pull``
184+
to update the source code. Then ESMValTool installation will be updated
185+
with changes from the ``master`` branch.
186+
174187
## Contribution
175188
176189
We have seen how to install ESMValTool in a ``develop`` mode.
@@ -359,7 +372,7 @@ when you submit a pull request.
359372
>> ~~~
360373
>>
361374
>> For details, see lesson
362-
>> [Writing your own diagnostic script](#).
375+
>> [Writing your own diagnostic script]({{ page.root }}{% link _episodes/10-diagnostics.md %}).
363376
>>
364377
> {: .solution}
365378
{: .challenge}

0 commit comments

Comments
 (0)