Update docs

Signed-off-by: Thijs Baaijen <[email protected]>

Author: Thijss

docs/demos/connecting_new_consumer.ipynb

@@ -73,8 +73,8 @@
     "\n",
     "grid.set_feeder_ids()\n",
     "\n",
-    "grid.node.x_coor = np.random.uniform(100, 500, len(grid.node))\n",
-    "grid.node.y_coor = np.random.uniform(100, 500, len(grid.node))"
+    "grid.node[\"x_coor\"] = np.random.uniform(100, 500, len(grid.node))\n",
+    "grid.node[\"y_coor\"] = np.random.uniform(100, 500, len(grid.node))"
    ]
   },
   {
@@ -149,24 +149,26 @@
     "):\n",
     "    closest_node_idx = find_closest_node(\n",
     "        grid=grid,\n",
-    "        x=new_consumer.x_coor[0],\n",
-    "        y=new_consumer.y_coor[0],\n",
+    "        x=new_consumer[\"x_coor\"].item(),\n",
+    "        y=new_consumer[\"y_coor\"].item(),\n",
     "    )\n",
     "    closest_node = grid.node[closest_node_idx]\n",
     "\n",
     "    grid.append(new_consumer)\n",
-    "    new_consumer_load.node = new_consumer.id\n",
+    "    new_consumer_load[\"node\"] = new_consumer[\"id\"]\n",
     "    grid.append(new_consumer_load)\n",
     "\n",
-    "    dist = np.sqrt((closest_node.x_coor - new_consumer.x_coor) ** 2 + (closest_node.y_coor - new_consumer.y_coor) ** 2)\n",
+    "    distance = np.sqrt(\n",
+    "        (closest_node[\"x_coor\"] - new_consumer[\"x_coor\"]) ** 2 + (closest_node[\"y_coor\"] - new_consumer[\"y_coor\"]) ** 2\n",
+    "    )\n",
     "\n",
     "    new_line = ExtendedLineArray(\n",
     "        from_node=[closest_node.id],\n",
     "        to_node=[new_consumer.id],\n",
     "        from_status=[1],\n",
     "        to_status=[1],\n",
-    "        r1=[R_PER_KM * dist / 1_000],\n",
-    "        x1=[X_PER_KM * dist / 1_000],\n",
+    "        r1=[R_PER_KM * distance / 1_000],\n",
+    "        x1=[X_PER_KM * distance / 1_000],\n",
     "        c1=[0],\n",
     "        tan1=[0],\n",
     "        i_n=[200],\n",
@@ -231,8 +233,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "print(f\"Overloaded nodes: {grid.node[grid.node.is_overloaded].id}\")\n",
-    "print(f\"Overloaded lines: {grid.line[grid.line.is_overloaded].id}\")"
+    "print(f\"Overloaded nodes: {grid.node[grid.node.is_overloaded]['id']}\")\n",
+    "print(f\"Overloaded lines: {grid.line[grid.line.is_overloaded]['id']}\")"
    ]
   },
   {
@@ -255,8 +257,8 @@
     "    connect_new_consumer(grid, new_consumer, new_consumer_load)\n",
     "update_grid(grid)\n",
     "\n",
-    "print(f\"Overloaded nodes: {grid.node[grid.node.is_overloaded].id}\")\n",
-    "print(f\"Overloaded lines: {grid.line[grid.line.is_overloaded].id}\")"
+    "print(f\"Overloaded nodes: {grid.node[grid.node.is_overloaded]['id']}\")\n",
+    "print(f\"Overloaded lines: {grid.line[grid.line.is_overloaded]['id']}\")"
    ]
   }
  ],

docs/examples/model/array_examples.ipynb

@@ -67,6 +67,7 @@
    "source": [
     "# Accessing a single column\n",
     "id_column = fancy_array[\"id\"]\n",
+    "# Alternative syntax (not recommended: not type-safe)\n",
     "id_column = fancy_array.id\n",
     "\n",
     "# Accessing multiple columns\n",
@@ -89,12 +90,14 @@
    "outputs": [],
    "source": [
     "# Setting new values to a column\n",
-    "fancy_array.id = np.array([9, 9, 9])\n",
     "fancy_array[\"id\"] = np.array([9, 9, 9])\n",
-    "fancy_array.id = [9, 9, 9]\n",
     "fancy_array[\"id\"] = [9, 9, 9]\n",
-    "fancy_array.id = 9\n",
-    "fancy_array[\"id\"] = 9"
+    "fancy_array[\"id\"] = 9\n",
+    "\n",
+    "# Alternative syntax (not recommended: not type-safe)\n",
+    "fancy_array.id = np.array([9, 9, 9])\n",
+    "fancy_array.id = [9, 9, 9]\n",
+    "fancy_array.id = 9"
    ]
   },
   {
@@ -176,7 +179,7 @@
    "outputs": [],
    "source": [
     "# Example analysis: sum of a column\n",
-    "total = np.sum(fancy_array.test_int)"
+    "total = np.sum(fancy_array[\"test_int\"])"
    ]
   },
   {

docs/examples/model/grid_examples.ipynb

@@ -107,13 +107,13 @@
    "source": [
     "from power_grid_model_ds.arrays import TransformerArray\n",
     "\n",
-    "trafo = TransformerArray.empty(1)\n",
-    "trafo.id = 301\n",
-    "trafo.from_status = 1\n",
-    "trafo.to_status = 1\n",
-    "trafo.from_node = 102\n",
-    "trafo.to_node = 106\n",
-    "grid.append(trafo, check_max_id=False)"
+    "transformer = TransformerArray.empty(1)\n",
+    "transformer[\"id\"] = 301\n",
+    "transformer[\"from_status\"] = 1\n",
+    "transformer[\"to_status\"] = 1\n",
+    "transformer[\"from_node\"] = 102\n",
+    "transformer[\"to_node\"] = 106\n",
+    "grid.append(transformer, check_max_id=False)"
    ]
   },
   {
@@ -284,8 +284,8 @@
     "from power_grid_model_ds.arrays import LineArray\n",
     "\n",
     "new_line_array = LineArray.zeros(1)\n",
-    "new_line_array.from_node = 102\n",
-    "new_line_array.to_node = 105\n",
+    "new_line_array[\"from_node\"] = 102\n",
+    "new_line_array[\"to_node\"] = 105\n",
     "grid.add_branch(branch=new_line_array)"
    ]
   },
@@ -330,8 +330,8 @@
     "from power_grid_model_ds.arrays import LinkArray\n",
     "\n",
     "new_link_array = LinkArray.zeros(1)\n",
-    "new_link_array.from_node = 102\n",
-    "new_link_array.to_node = 105\n",
+    "new_link_array[\"from_node\"] = 102\n",
+    "new_link_array[\"to_node\"] = 105\n",
     "grid.add_branch(branch=new_link_array)"
    ]
   },
@@ -355,8 +355,8 @@
     "from power_grid_model_ds.arrays import TransformerArray\n",
     "\n",
     "new_transformer_array = TransformerArray.zeros(1)\n",
-    "new_transformer_array.from_node = 102\n",
-    "new_transformer_array.to_node = 105\n",
+    "new_transformer_array[\"from_node\"] = 102\n",
+    "new_transformer_array[\"to_node\"] = 105\n",
     "grid.add_branch(branch=new_transformer_array)"
    ]
   },

docs/model_interface.ipynb

@@ -71,8 +71,8 @@
     "from power_grid_model_ds.arrays import LineArray\n",
     "\n",
     "new_line_array = LineArray.zeros(1)\n",
-    "new_line_array.from_node = 2\n",
-    "new_line_array.to_node = 5\n",
+    "new_line_array[\"from_node\"] = 2\n",
+    "new_line_array[\"to_node\"] = 5\n",
     "grid.add_branch(branch=new_line_array)"
    ]
   },