SETUP.md 1.32 KB
Newer Older
fabian.neumann's avatar
fabian.neumann committed
1 2
# Download

3 4
You can download the tutorials with `git` with the following command (it should
be public):
fabian.neumann's avatar
fabian.neumann committed
5 6 7 8 9

```
git clone https://git.scc.kit.edu/sp2668/esm_tutorials.git
```

10 11
Alternatively, you can download the tutorials as compressed zip-file from
https://git.scc.kit.edu/sp2668/esm_tutorials/-/archive/master/esm_tutorials-master.zip
fabian.neumann's avatar
fabian.neumann committed
12

sp2668's avatar
sp2668 committed
13 14
# Installation Guide

15 16
**Make sure to follow these steps BEFORE the first tutorial (The wireless WILL
be spotty with so many heavy users and we'll loose precious tutorial time)!**
sp2668's avatar
sp2668 committed
17

18 19 20 21 22
Install `miniconda` (or Anaconda). For instructions for your operating system
see https://conda.io/docs/user-guide/install/index.html

Now create a new environment from the provided `requirements.yml` file. For
detailed instructions see
sp2668's avatar
sp2668 committed
23 24
https://conda.io/docs/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file

25 26
Open a terminal. Creating the environment requires the following set of
commands. They take time and have to download several packages!
sp2668's avatar
sp2668 committed
27 28 29 30 31 32 33

Windows:
```
conda env create -f requirements.yml
activate esm-tutorials
```

fabian.neumann's avatar
fabian.neumann committed
34
macOS and Linux:
sp2668's avatar
sp2668 committed
35 36 37 38 39
```
conda env create -f requirements.yml
source activate esm-tutorials
```

fabian.neumann's avatar
fabian.neumann committed
40
Open a jupyter notebook with the following command in the tutorial folder (where your notebooks are):
sp2668's avatar
sp2668 committed
41 42 43 44 45
```
jupyter notebook
```

You should now be ready to do the tutorials :)