Merge pull request #315 from FormingWorlds/ls/snellius-doc

Add installation instructions for Snellius cluster.

docs/installation.md

@@ -72,7 +72,7 @@ You will need to setup Python (>=3.10) on your system. This can be done via brew
     The code can be setup in `./socrates/` using the following script.
 
     ```console
-    source get_socrates.sh
+    source tools/get_socrates.sh
     ```
 
     The environemnt variable `RAD_DIR` must always point to the SOCRATES installation path.

docs/tips_snellius_cluster.md

@@ -0,0 +1,27 @@
+# Install PROTEUS on the Snellius Cluster
+
+1. Connect via SSH. See instructions from SURF [here](https://servicedesk.surf.nl/wiki/display/WIKI/SSH+public-key+authentication).
+
+2. Set up your working environment. You have to load some modules and set up the environment variables prior to the installation. To facilitate this we suggest to copy the following function into your `.bashrc` file of your home directory. Then, simply run this function `boot_PROTEUS` in your terminal each time you login.
+
+    ```console
+    boot_PROTEUS () {
+      module load 2023
+      module load Python/3.11.3-GCCcore-12.3.0
+      module load SciPy-bundle/2023.07-gfbf-2023a
+      module load netCDF-Fortran/4.6.1-gompi-2023a
+
+      export FWL_DATA=${HOME}/your_path_to_fwl_data
+      export RAD_DIR=${HOME}/your_path_to_socrates
+    }
+    ```
+
+3. Follow the generic installation instructions [here](./installation.md) from "Download the framework". We then recommand to add the activation of the python virtual environment into the `boot_PROTEUS` function of step 2.
+
+    ```console
+    boot_PROTEUS () {
+      [...]
+
+      source ${HOME}/proteus_directory/.venv/bin/activate
+    }
+    ```

mkdocs.yml

@@ -11,6 +11,7 @@ nav:
   - Data: data.md
   - Troubleshooting: troubleshooting.md
   - Kapteyn cluster: tips_kapteyn_cluster.md
+  - Snellius cluster: tips_snellius_cluster.md
   - Contact: contact.md
   - Contributing: CONTRIBUTING.md
   - Code of Conduct: CODE_OF_CONDUCT.md