Skip to content

Commit 8bffe03

Browse files
Merge pull request #139 from ESMValGroup/remove_julia_instructions
Remove julia instructions
2 parents 57f6428 + 4ca2835 commit 8bffe03

File tree

1 file changed

+86
-75
lines changed

1 file changed

+86
-75
lines changed

_episodes/02-installation.md

Lines changed: 86 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,8 @@ In this tutorial we will be using the
1919
install the ESMValTool. Other installation methods are also available, they can
2020
be found in the
2121
[documentation](https://docs.esmvaltool.org/en/latest/quickstart/installation.html).
22-
ESMValTool also contains diagnostics written in [Julia](https://julialang.org/).
23-
Because Julia cannot be installed by Conda, we will install Julia separately. We
24-
will first learn how to install Conda, Julia, and finally the ESMValTool. We end
25-
this chapter by testing that the installation was successful.
22+
We will first install Conda, and then ESMValTool. We end this chapter by testing
23+
that the installation was successful.
2624

2725
## Install Conda
2826

@@ -124,90 +122,103 @@ instructions.
124122

125123
## Install Julia
126124

125+
Some ESMValTool diagnostics are written in the Julia programming language.
126+
If you want a full installation of ESMValTool including Julia diagnostics, you need
127+
to make sure Julia is installed before installing ESMValTool.
128+
129+
In this tutorial, we will not use Julia, but for reference, we have listed the steps
130+
to install Julia below.
127131
Complete instructions for installing Julia can be found on the [Julia
128132
installation page](https://julialang.org/downloads/platform/#linux_and_freebsd).
129-
In this tutorial, we will use the following steps. First, open a bash terminal
130-
and create a directory to install Julia in and cd into it
131-
132-
```bash
133-
mkdir ~/julia
134-
cd ~/julia
135-
```
136-
137-
Next, to download and extract the file `julia-1.0.5-linux-x86_64.tar.gz`, you can use the following commands::
138-
139-
```bash
140-
wget https://julialang-s3.julialang.org/bin/linux/x64/1.0/julia-1.0.5-linux-x86_64.tar.gz
141-
tar -xvzf julia-1.0.5-linux-x86\_64.tar.gz
142-
```
143-
144-
This will extract the files to a directory named `~/julia/julia-1.0.5`. To run
145-
Julia, you need to add the full path of Julia's `bin` folder to PATH environment
146-
variable. To do this, you can edit the `~/.bashrc` (or `~/.bash_profile`) file.
147-
Open the file in a text editor called ``nano``:
148-
149-
```bash
150-
nano ~/.bashrc
151-
```
152-
153-
and add a new line as follows at the
154-
bottom of the file:
155-
156-
```bash
157-
export PATH="$PATH:$HOME/julia/julia-1.0.5/bin"
158-
```
159-
160-
Finally, for the settings to take effect, either reload your bash profile
161-
162-
```bash
163-
source ~/.bashrc
164-
```
165-
166-
(or `source ~/.bash_profile`), or close the bash terminal window and open a new
167-
one.
168-
169-
To check that the Julia executable can be found, run
170-
171-
```bash
172-
which julia
173-
```
174-
175-
to display the path to the Julia executable, it should be
176-
177-
```
178-
~/julia/julia-1.0.5/bin/julia
179-
```
180-
{: .output}
181-
182-
To test that Julia is installed correctly, run
183-
184-
```bash
185-
julia
186-
```
187-
188-
to start the interactive Julia interpreter. Press `Ctrl+D` to exit.
189133

190-
> ## Text editor side note
134+
> ## Julia installation instructions
191135
>
192-
> No matter what editor you use, you will need to know where it searches
193-
> for and saves files. If you start it from the shell, it will (probably)
194-
> use your current working directory as its default location. We use ``nano``
195-
> in examples here because it is one of the least complex text editors.
196-
> Press <kbd>ctrl</kbd> + <kbd>O</kbd> to save the file,
197-
> and then <kbd>ctrl</kbd> + <kbd>X</kbd> to exit ``nano``.
198-
{: .callout}
136+
> First, open a bash terminal and create a directory to install Julia in and cd
137+
> into it
138+
>
139+
> ```bash
140+
> mkdir ~/julia
141+
> cd ~/julia
142+
> ```
143+
>
144+
> Next, to download and extract the file `julia-1.0.5-linux-x86_64.tar.gz`, you can use the following commands::
145+
>
146+
> ```bash
147+
> wget https://julialang-s3.julialang.org/bin/linux/x64/1.0/julia-1.0.5-linux-x86_64.tar.gz
148+
> tar -xvzf julia-1.0.5-linux-x86\_64.tar.gz
149+
> ```
150+
>
151+
> This will extract the files to a directory named `~/julia/julia-1.0.5`. To run
152+
> Julia, you need to add the full path of Julia's `bin` folder to PATH environment
153+
> variable. To do this, you can edit the `~/.bashrc` (or `~/.bash_profile`) file.
154+
> Open the file in a text editor called ``nano``:
155+
>
156+
> ```bash
157+
> nano ~/.bashrc
158+
> ```
159+
>
160+
> and add a new line as follows at the
161+
> bottom of the file:
162+
>
163+
> ```bash
164+
> export PATH="$PATH:$HOME/julia/julia-1.0.5/bin"
165+
> ```
166+
>
167+
> Finally, for the settings to take effect, either reload your bash profile
168+
>
169+
> ```bash
170+
> source ~/.bashrc
171+
> ```
172+
>
173+
> (or `source ~/.bash_profile`), or close the bash terminal window and open a new
174+
> one.
175+
>
176+
> To check that the Julia executable can be found, run
177+
>
178+
> ```bash
179+
> which julia
180+
> ```
181+
>
182+
> to display the path to the Julia executable, it should be
183+
>
184+
> ```
185+
> ~/julia/julia-1.0.5/bin/julia
186+
> ```
187+
> {: .output}
188+
>
189+
> To test that Julia is installed correctly, run
190+
>
191+
> ```bash
192+
> julia
193+
> ```
194+
>
195+
> to start the interactive Julia interpreter. Press `Ctrl+D` to exit.
196+
{: .solution}
199197
200198
## Install the ESMValTool package
201199
202-
To install the ESMValTool package, run
200+
The ESMValTool package contains diagnostics scripts in four languages: R,
201+
Python, Julia and NCL. This introduces a lot of dependencies, and therefore the
202+
installation can take quite long. It is, however, possible to install
203+
'subpackages' for each of the languages. The following (sub)packages are
204+
available:
205+
206+
- `esmvaltool-python`
207+
- `esmvaltool-ncl`
208+
- `esmvaltool-r`
209+
- `esmvaltool-julia`
210+
- `esmvaltool` --> the complete package, i.e. the combination of the above.
211+
212+
For the tutorial, we will use only Python diagnostics. Thus, to install the
213+
ESMValTool-python package, run
203214
204215
```bash
205-
conda create -n esmvaltool -c conda-forge -c esmvalgroup esmvaltool
216+
conda create -n esmvaltool -c conda-forge -c esmvalgroup esmvaltool-python
206217
```
207218
208219
This will create a new [Conda
209220
environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)
210-
called `esmvaltool`, with the ESMValTool package and all of its dependencies
221+
called `esmvaltool`, with the ESMValTool-Python package and all of its dependencies
211222
installed in it.
212223
213224
> ## Conda common problems

0 commit comments

Comments
 (0)