Merge pull request #152 from alliander-opensource/feature/doc-example-index

Reading result batches example

Author: nitbharambe

docs/examples/Power Flow Example.ipynb

@@ -523,7 +523,7 @@
    "execution_count": 14,
    "id": "4e25006f",
    "metadata": {
-    "scrolled": true
+    "scrolled": false
    },
    "outputs": [
     {
@@ -548,6 +548,71 @@
     "print(output_data[\"line\"][\"i_from\"])"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "466082fd",
+   "metadata": {},
+   "source": [
+    "#### Accessing batch data\n",
+    "\n",
+    "It may be a bit unintuitive to read the `output_data` or `update_data` of a component directly as they are a dictionary of 3 dimension data, ie. $ids \\times batches \\times  attributes$. Remember that the `output_data` or `update_data` are a dictionary of numpy structured arrays. Hence the component should be indexed first. The index that follows can be [indexed with numpy structured arrays](https://numpy.org/doc/stable/user/basics.rec.html#indexing-structured-arrays)\n",
+    "\n",
+    "To read the result of a single batch, lets say `1st batch`,"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 15,
+   "id": "a8ad72d8",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "   id  energized   loading        p_from        q_from      i_from  \\\n",
+      "0   3          1  0.212031  29511.239220  3.508895e+06  193.061627   \n",
+      "1   5          1  0.064924  -1267.160636 -1.172098e+06   64.923606   \n",
+      "2   8          1  0.156578  19805.345039  2.500724e+06  137.590869   \n",
+      "\n",
+      "         s_from         p_to          q_to        i_to          s_to  \n",
+      "0  3.509019e+06  1267.160636 -3.827902e+06  212.030847  3.827902e+06  \n",
+      "1  1.172099e+06  3574.919119  8.320006e+05   46.000611  8.320083e+05  \n",
+      "2  2.500802e+06 -3574.919119 -2.832001e+06  156.577603  2.832003e+06  \n"
+     ]
+    }
+   ],
+   "source": [
+    "print(pd.DataFrame(output_data[\"line\"][0]))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "e25301da",
+   "metadata": {},
+   "source": [
+    "Or maybe we wish to find result of a single component, (eg. 1st line) in all batches"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 16,
+   "id": "7bceccf4",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "[ 193.06162675  248.65360093  368.12834615  510.20016036  662.04311447\n",
+      "  819.63118685  981.46004118 1146.90787963 1315.7236725  1487.83778526]\n"
+     ]
+    }
+   ],
+   "source": [
+    "print(output_data[\"line\"][\"i_from\"][:,0])"
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "ac217192",
@@ -562,7 +627,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": 17,
    "id": "041368dc",
    "metadata": {},
    "outputs": [],
@@ -597,7 +662,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 16,
+   "execution_count": 18,
    "id": "34338ce3",
    "metadata": {},
    "outputs": [
@@ -628,7 +693,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 17,
+   "execution_count": 19,
    "id": "04e56690",
    "metadata": {},
    "outputs": [],
@@ -655,7 +720,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 18,
+   "execution_count": 20,
    "id": "0d5b94c2",
    "metadata": {},
    "outputs": [
@@ -732,7 +797,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 19,
+   "execution_count": 21,
    "id": "b5f10bae",
    "metadata": {},
    "outputs": [
@@ -788,7 +853,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 20,
+   "execution_count": 22,
    "id": "1a221507",
    "metadata": {},
    "outputs": [
@@ -825,7 +890,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 21,
+   "execution_count": 23,
    "id": "541af620",
    "metadata": {},
    "outputs": [
@@ -864,7 +929,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 22,
+   "execution_count": 24,
    "id": "b702eb15",
    "metadata": {},
    "outputs": [
@@ -894,7 +959,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3.9.13 ('pgm-dev')",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },