Merge pull request #1029 from CLIMADA-project/feature/update_euler_guide_petals

Add instructions to install climada petals on Euler

Author: luseverin

CHANGELOG.md

@@ -11,6 +11,7 @@ Code freeze date: YYYY-MM-DD
 ### Dependency Changes
 
 ### Added
+- Added instructions to install Climada petals on Euler cluster in `doc.guide.Guide_Euler.ipynb` [#1029](https://github.com/CLIMADA-project/climada_python/pull/1029)
 
 ### Changed
 - `Hazard.local_exceedance_intensity`, `Hazard.local_return_period` and `Impact.local_exceedance_impact`, `Impact.local_return_period`, using the `climada.util.interpolation` module: New default (no binning), binning on decimals, and faster implementation [#1012](https://github.com/CLIMADA-project/climada_python/pull/1012)

doc/guide/Guide_Euler.ipynb

@@ -121,7 +121,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### 4. Install climada\n",
+    "### 4. Install Climada\n",
     "\n",
     "There are two options. Either install from the downloaded repository (option A), or use a particular released version (option B).\n",
     "\n",
@@ -132,6 +132,7 @@
     "cd climada_python\n",
     "pip install -e .\n",
     "```\n",
+    "If you need to work with a specific branch of Climada, you can do so by checking out to the target branch `your_branch` by running `git checkout your_branch` after having cloned the Climada repository and before running `pip install -e .`.\n",
     "\n",
     "#### option B\n",
     "\n",
@@ -190,6 +191,21 @@
     "and the Wiki https://scicomp.ethz.ch/wiki/Transition_from_LSF_to_Slurm for a mapping of `lsf` commands to their `slurm` equivalents."
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### 7. Optional: Install Climada Petals\n",
+    "\n",
+    "To install Climada Petals, repeat the steps described in step 4A, but replacing the climada_python with the climada_petals repository:\n",
+    "```bash\n",
+    "cd /cluster/project/climate/$USER  # or wherever you plan to download the repository\n",
+    "git clone https://github.com/CLIMADA-project/climada_petals.git  # unless this has been done before\n",
+    "cd climada_petals\n",
+    "pip install -e .\n",
+    "```"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},