readme

nbs/index.ipynb

@@ -4,7 +4,15 @@
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Loading corebridge.core from /home/fenke/repos/corebridge/corebridge/core.py\n"
+     ]
+    }
+   ],
    "source": [
     "#| hide\n",
     "from corebridge.core import *"
@@ -31,7 +39,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Install"
+    "## Installation\n",
+    "\n",
+    "Use"
    ]
   },
   {
@@ -43,6 +53,13 @@
     "```"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "to install corebrdige. "
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -56,8 +73,6 @@
    "source": [
     "### Introduction\n",
     "\n",
-    "#### Wodan processing functions\n",
-    "\n",
     "Wodan is a proprietary backend service that applies high performance, custom analytical processing to timeseries data in the Whysor data and dashboarding environment.\n",
     "\n",
     "Each wodan module defines one function that operates as the entry point. The parameter annotations in this function definition are used to format data and retrieve parameters from the originating call to the wodan api. This function is called with data retrieved according to a specification and with additional parameters as annotated.\n",
@@ -71,18 +86,19 @@
     "    return data * multiplier\n",
     "    \n",
     "```\n",
-    "\n"
+    "\n",
+    " Wodan binds this function to a service endpoint and takes care of fetching data and parameters and converting the result for the caller.\n"
    ]
   },
   {
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### AICore modules\n",
+    "### AICore modules\n",
     "\n",
-    "For AICore one defines a class, always named `Module` with a constructor `__init__` and a method `infer`.\n",
+    "For AICore users define a class, always named `Module` with a constructor `__init__` and a method `infer`.\n",
     "\n",
-    "This package defines a baseclass to quickly construct a custom `Module` class that uses a wodan processor function inside the AICore system:\n",
+    "This package defines a baseclass to quickly construct a custom `Module` class that is able to use a wodan processor function inside the AICore system:\n",
     "\n",
     "\n",
     "\n",
@@ -99,7 +115,7 @@
     "    \n",
     "```\n",
     "\n",
-    "That's it. Well, you can add parameters to `__init__` that can be used as hyperparameters and you could override `infer` for the same reason. "
+    "That's it. Well, you can add parameters to `__init__` that can be used as hyperparameters in the web-interface and you could override `infer` for the same reason. The baseclass takes care of converting call parameters and data to the function specification and, calls the function and converts the result for the caller, similar to the original Wodan service."
    ]
   },
   {
@@ -113,11 +129,31 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## nbdev cycle\n",
+    "## Development\n",
+    "\n",
+    "Setup a virtual environment, activate it and install the development package and dependencies with, on linux\n",
+    "\n",
+    "``` \n",
+    "    pip install -e ‘.\\[dev\\]’\n",
+    "\n",
+    "```\n",
+    "\n",
+    "or on Windows\n",
+    "\n",
+    "```\n",
+    "    pip install -e .\\[dev\\]\n",
+    "\n",
+    "```"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### nbdev cycle\n",
     "\n",
     "- edit\n",
     "- nbdev_export\n",
-    "- pip install -e ‘.\\[dev\\]’\n",
     "- nbdev_test\n",
     "- nbdev_clean\n",
     "- nbdev_readme\n",
@@ -129,9 +165,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "python3",
+   "display_name": "corebridge.venv",
    "language": "python",
-   "name": "python3"
+   "name": "corebridge.venv"
   }
  },
  "nbformat": 4,