Skip to content

Commit 73dad51

Browse files
committed
Correcc rendering
1 parent a634ba3 commit 73dad51

File tree

1 file changed

+16
-24
lines changed

1 file changed

+16
-24
lines changed

_episodes/10-development-setup.md

Lines changed: 16 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,14 @@ So you want to contribute code to ESMValTool, what follows describes a developme
2424
## Obtaining the source code
2525

2626
The ESMValTool source code is available on a public GitHub repository:
27-
https://github.com/ESMValGroup/ESMValTool
27+
[https://github.com/ESMValGroup/ESMValTool](https://github.com/ESMValGroup/ESMValTool)
2828

2929
The easiest way to obtain it is to clone the repository using git.
3030
To clone the public repository open a terminal window and type:
3131

32+
~~~bash
33+
git clone https://github.com/ESMValGroup/ESMValTool.git
3234
~~~
33-
git clone https://github.com/ESMValGroup/ESMValTool.git
34-
~~~
35-
{: .source}
3635

3736
By default, this command will create a folder called ESMValTool containing the
3837
source code of the tool.
@@ -42,16 +41,15 @@ Move into the directory to continue installation.
4241
> ## Attention
4342
>
4443
> Make sure that the master branch is checked out before continuing intallation:
45-
> ~~~
44+
> ~~~bash
4645
> git checkout master
4746
> ~~~
48-
> {: .source}
4947
{: .callout}
5048
5149
## Prerequisites
5250
5351
It is recommended to use conda to manage ESMValTool dependencies.
54-
For a minimal conda installation go to https://conda.io/miniconda.html. To
52+
For a minimal conda installation go to [https://conda.io/miniconda.html](https://conda.io/miniconda.html). To
5553
simplify the installation process, an environment definition file is provided
5654
in the repository (``environment.yml`` in the root folder).
5755
@@ -69,53 +67,47 @@ independent from any other Python tools present in the system.
6967
To create an environment, go to the directory containing the ESMValTool source
7068
code (called ESMValTool if you did not choose a different name) and run
7169
70+
~~~bash
71+
conda env create --name esmvaltool --file environment.yml
7272
~~~
73-
conda env create --name esmvaltool --file environment.yml
74-
~~~
75-
{: .source}
7673
7774
The environment is called ``esmvaltool`` by default, but it is possible to use
7875
the option ``--name ENVIRONMENT_NAME`` to define a custom name. You can activate
7976
the environment using the command:
8077
78+
~~~bash
79+
conda activate esmvaltool
8180
~~~
82-
conda activate esmvaltool
83-
~~~
84-
{: .source}
8581
86-
If you run into trouble, please try recreating the environment. More information can be found in the (conda documentation)[https://docs.conda.io/en/latest/].
82+
If you run into trouble, please try recreating the environment. More information can be found in the [conda documentation](https://docs.conda.io/en/latest/).
8783
8884
8985
## Software installation
9086
9187
Once all prerequisites are fulfilled, ESMValTool can be installed by running
9288
the following commands in the directory containing the ESMValTool source code:
9389
90+
~~~bash
91+
pip install .
9492
~~~
95-
pip install .
96-
~~~
97-
{: .source}
9893
9994
## Test the installation
10095
10196
The next step is to check that the installation works properly.
10297
To do this, run the tool with:
10398
99+
~~~bash
100+
esmvaltool --help
104101
~~~
105-
esmvaltool --help
106-
~~~
107-
{: .source}
108102
109103
If everything was installed properly, ESMValTool should have printed a
110104
help message to the console.
111105
112106
For a more complete installation verification, run the automated tests and
113107
confirm that no errors are reported:
114108
109+
~~~bash
110+
python setup.py test --installation
115111
~~~
116-
python setup.py test --installation
117-
~~~
118-
{: .source}
119112
120113
{% include links.md %}
121-

0 commit comments

Comments
 (0)