prog

nbs/index.ipynb

@@ -2,7 +2,7 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 1,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -15,67 +15,43 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Dynamics of Regional Climate Systems (DRCS) - Tools\n",
+    "# Dynamics of Regional Climate Systems (DRCS)\n",
     "\n",
     "[![Build Status](https://drone.io-warnemuende.de/api/badges/boergel/drcstools/status.svg)](https://drone.io-warnemuende.de/boergel/drcstools)\n",
     "\n",
-    "> For data analysis"
+    "> This package combines all of the tools that I use for my data analysis"
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Content\n",
     "\n",
-    "- Stormtracks\n",
-    "    * Follows Benestad et al. (2006)+\n",
-    "- derivative\n",
-    "    * Calculates first and second derivative following Gill (1981)\n",
-    "- stats\n",
-    "    * spatial mean added\n",
-    "    * regression function for regression maps and more\n",
-    "- helper_functions\n",
-    "    * reading netcdf files using xarray\n",
-    "    * adjusting 0-360 lon to -180 to 180 \n",
-    "    * much more\n",
-    "- total exchange flow\n",
-    "    * using xarray\n",
+    "Initially, I created this package to keep track of all useful functions that I use on a regular basis. I encourage you to contribute to this package, finding possible errors, improvements or by adding new useful functions.\n",
+    "\n",
+    "The package is build with the package nbdev which allows creating packages within an interactive jupyter notebook enviroment.\n",
     "    "
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Install"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "`pip install drcstools`"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## How to use"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "Usecase + concept"
+    "To install this package use \n",
+    "\n",
+    "`git clone https://git.io-warnemuende.de/boergel/drcstools.git` \n",
+    "\n",
+    "`cd drcstools`\n",
+    "\n",
+    "`pip install -e .`"
    ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3 (ipykernel)",
+   "display_name": "xarray",
    "language": "python",
    "name": "python3"
   },
@@ -89,7 +65,12 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.4"
+   "version": "3.10.6"
+  },
+  "vscode": {
+   "interpreter": {
+    "hash": "85c5783586d30ff72e98f5d52ef95e9c172daa6cb2628b0e9aeb01c271dd5883"
+   }
   }
  },
  "nbformat": 4,