adapt testing and continuous integration guides

CLIMADA-project · Nov 20, 2023 · 91e35e7 · 91e35e7
1 parent 40ab66a
commit 91e35e7
Show file tree

Hide file tree

Showing 10 changed files with 163 additions and 349 deletions.
diff --git a/doc/guide/Guide_Miscellaneous.ipynb → doc/guide/Guide_CLIMADA_conventions.ipynb b/doc/guide/Guide_Miscellaneous.ipynb → doc/guide/Guide_CLIMADA_conventions.ipynb
@@ -8,28 +8,7 @@
     }
    },
    "source": [
-    "# Miscellaneous CLIMADA conventions"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "slideshow": {
-     "slide_type": "slide"
-    },
-    "tags": [],
-    "toc": true
-   },
-   "source": [
-    "## Contents\n",
-    "\n",
-    "- [Dependencies (python packages)](#Dependencies-(python-packages))\n",
-    "- [Class inheritance](#Class-inheritance)\n",
-    "- [Paper repository](#Paper-repository)\n",
-    "- [Utility function](#Utility-function)\n",
-    "- [Impact function renaming - if to impf](#Impact-function-renaming---if-to-impf)\n",
-    "- [Data dependencies](#Data-dependencies)\n",
-    "- [Side Note on Parameters](#Side-Note-on-Parameters)"
+    "# CLIMADA coding conventions"
    ]
   },
   {

diff --git a/doc/guide/Guide_Configuration.ipynb b/doc/guide/Guide_Configuration.ipynb
@@ -7,23 +7,6 @@
     "# Constants and Configuration"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Content\n",
-    "\n",
-    "- [Constants](#Constants)\n",
-    "    - [Hard Coded](#Hard-Coded)\n",
-    "    - [Configurable](#Configurable)\n",
-    "    - [Where to put constants?](#Where-to-put-constants?)\n",
-    "- [Configuration](#Configurable)\n",
-    "    - [Configuration files](#Configuration-files)\n",
-    "    - [Accessing configuration values](#Accessing-configuration-values)\n",
-    "    - [Default Configuration](#Default-Configuration)\n",
-    "    - [Test Configuration](#Test-Configuration)\n"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {

diff --git a/doc/guide/Guide_Euler.ipynb b/doc/guide/Guide_Euler.ipynb
@@ -7,22 +7,6 @@
     "# Using Climada on the Euler Cluster (ETH internal)"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "\n",
-    "## Content\n",
-    "\n",
-    "- [Access to Euler](#Access-to-Euler)\n",
-    "- [Installation and working directories](#Installation-and-working-directories)\n",
-    "- [Pre-installed version of Climada](#Pre-installed-version-of-Climada)\n",
-    "- [Working with Git branches](#Working-with-Git-branches)\n",
-    "- [Fallback: Conda installation](#Fallback:-Conda)\n",
-    "- [Run a Jupyter Notebook on Euler](#Run-Jupyter-Notebook-on-Euler)\n",
-    "- [Trouble shooting](#Trouble-shooting)"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},

diff --git a/doc/guide/Guide_Git_Development.ipynb b/doc/guide/Guide_Git_Development.ipynb
@@ -12,26 +12,6 @@
     "Chris Fairless"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "slideshow": {
-     "slide_type": "slide"
-    }
-   },
-   "source": [
-    "## Contents\n",
-    "\n",
-    "- [Git and GitHub](#Git-and-GitHub)\n",
-    "- [Gitflow](#Gitflow)\n",
-    "- [Installing CLIMADA for development](#Installing-CLIMADA-for-development)\n",
-    "- [Does it belong in CLIMADA?](#Does-it-belong-in-CLIMADA?)\n",
-    "- [Features and branches](#Features-and-branches)\n",
-    "- [Pull requests](#Pull-requests) \n",
-    "- [General tips and tricks](#General-tips-and-tricks)\n",
-    "   "
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {

diff --git a/doc/guide/Guide_Py_Performance.ipynb b/doc/guide/Guide_Py_Performance.ipynb
@@ -20,24 +20,6 @@
     "⚠️ **Don't over-optimize** at the expense of readability and usability."
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "slideshow": {
-     "slide_type": "skip"
-    },
-    "toc": true
-   },
-   "source": [
-    "## Contents \n",
-    "\n",
-    "- [Profiling](#Profiling)\n",
-    "- [General considerations](#General-considerations)\n",
-    "- [NumPy-realted tips and best practice](#NumPy-related-tips-and-best-practice)\n",
-    "- [Miscellaneous](#Miscellaneous)\n",
-    "- [Take-home message](#Take-home-messages)"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {

diff --git a/doc/guide/Guide_PythonDos-n-Donts.ipynb b/doc/guide/Guide_PythonDos-n-Donts.ipynb
@@ -11,25 +11,6 @@
     "# Coding in Python: Dos and Don’ts"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {
-    "slideshow": {
-     "slide_type": "slide"
-    }
-   },
-   "source": [
-    "## Content\n",
-    "\n",
-    "- [To Code or Not to Code?](#To-Code-or-Not-to-Code?)\n",
-    "- [Clean Code](#Clean-Code) \n",
-    "- [Commenting & Documenting](#Commenting-&-Documenting) \n",
-    "- [Exception Handling and Logging](#Exception-Handling-and-Logging)\n",
-    "- [Importing](#Importing)\n",
-    "- [How to structure a method or function](#How-to-structure-a-method-or-function)\n",
-    "- [Debugging](#Debugging)"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {