Skip to content

Commit 07bdd0a

Browse files
committed
update installation guide for Server/ Cluster
1 parent 8082285 commit 07bdd0a

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

doc/source/install_cluster.rst

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,19 @@ Installation on a server / the Euler Cluster (ETH internal)
55

66
Please execute the instructions of the following text boxes in a Terminal.
77
For ETH WCR group members, there are two directories that can be used for the installation:
8+
89
1. "Home": /cluster/home/USERNAME/
10+
911
2. "Work": /cluster/work/climate/USERNAME
12+
1013
The advantage of using "Home" is that it is the location with the fastest access for the use python and CLIMADA.
1114
The disadvantage of "Home" is the limited quota of 20 GB and 100'000 files, since both miniconda and CLIMADA come with many single files.
12-
If you don't have many other files stored in "Home", (1) is the recommended option. Otherwise got for (2)
15+
If you don't have many other files stored in "Home", (1) is the recommended option. Otherwise go for (2).
1316

1417
For all steps listed below, first enter the Cluster via SSH.
1518

1619
On the server, go to either your "Home" or your "Work" environment. In the following we will go for option (2) and install everything in the "Work" path.
17-
If you are using a different server or option, please customise the paths in each step.
20+
If you are using a different server or option, please customise the paths in each step::
1821

1922
cd /cluster/work/climate/USERNAME
2023

@@ -44,7 +47,7 @@ Install environment with Miniconda
4447
cd climada_python
4548
conda env create -f requirements/env_climada.yml --name climada_env
4649

47-
During the installation process of Miniconda, you are prompted to set the working directory according to your choice.
50+
During the installation process of Miniconda, you are prompted to set the working directory according to your choice.
4851

4952
2. **Install dependencies**: Create the virtual environment *climada_env* with climada's dependencies::
5053

@@ -61,9 +64,10 @@ Install environment with Miniconda
6164
python3 tests_runner.py
6265
source deactivate
6366
64-
If the installation has been successful, an OK will appear at the end of the execution.
65-
Warning: Executing the whole test_runner takes pretty long and downloads some files to climada_python/data that you might not need.
66-
Consider aborting the test once you see first "OK"s in the output.
67+
If the installation has been successful, an OK will appear at the end of the execution.
68+
69+
Warning: Executing the whole test_runner takes pretty long and downloads some files to climada_python/data that you might not need.
70+
Consider aborting the test once you see first "OK"s in the output.
6771

6872
4. **Submit a test BJOB to the queue of the cluster**: Write a shell script that initiates the Python environment climada_env and submit the job::
6973

@@ -79,10 +83,13 @@ Install environment with Miniconda
7983

8084

8185

82-
Notes:
83-
- Change the script after echo "python3" to the path of the Python script you want to execute.
84-
- Change the working path to the path you have cloned the climada_python repository to.
85-
- Customise the bsub options accordingly
86+
Notes:
87+
88+
- Change the script after echo "python3" to the path of the Python script you want to execute
89+
90+
- Change the working path to the path you have cloned the climada_python repository to
91+
92+
- Customise the bsub options accordingly
8693

8794

8895

0 commit comments

Comments
 (0)