Update the examples

Signed-off-by: GitHub Actions Bot <[email protected]>

Author: actions-user

examples/Transformer Examples.ipynb

@@ -40,7 +40,8 @@
     "import numpy as np\n",
     "import warnings\n",
     "\n",
-    "with warnings.catch_warnings(action=\"ignore\", category=DeprecationWarning):\n",
+    "with warnings.catch_warnings():\n",
+    "    warnings.simplefilter(\"ignore\", category=DeprecationWarning)\n",
     "    # suppress warning about pyarrow as future required dependency\n",
     "    import pandas as pd\n",
     "\n",
@@ -891,15 +892,160 @@
   },
   {
    "cell_type": "markdown",
-   "id": "7828a4e3",
+   "id": "9f1a6f30",
    "metadata": {},
    "source": [
-    "**NOTE:** the tap positions obtained using the `any_valid_tap` strategy may depend on the initial tap position of the transformers."
+    "You could also opt for fast_any_tap that takes advantage of binary search instead of linear search internally."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 12,
+   "id": "1fa08adb",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "------node result------\n"
+     ]
+    },
+    {
+     "data": {
+      "text/html": [
+       "<div>\n",
+       "<style scoped>\n",
+       "    .dataframe tbody tr th:only-of-type {\n",
+       "        vertical-align: middle;\n",
+       "    }\n",
+       "\n",
+       "    .dataframe tbody tr th {\n",
+       "        vertical-align: top;\n",
+       "    }\n",
+       "\n",
+       "    .dataframe thead th {\n",
+       "        text-align: right;\n",
+       "    }\n",
+       "</style>\n",
+       "<table border=\"1\" class=\"dataframe\">\n",
+       "  <thead>\n",
+       "    <tr style=\"text-align: right;\">\n",
+       "      <th></th>\n",
+       "      <th>id</th>\n",
+       "      <th>u</th>\n",
+       "    </tr>\n",
+       "  </thead>\n",
+       "  <tbody>\n",
+       "    <tr>\n",
+       "      <th>0</th>\n",
+       "      <td>2</td>\n",
+       "      <td>9999.994675</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>1</th>\n",
+       "      <td>4</td>\n",
+       "      <td>401.932237</td>\n",
+       "    </tr>\n",
+       "    <tr>\n",
+       "      <th>2</th>\n",
+       "      <td>6</td>\n",
+       "      <td>346.203709</td>\n",
+       "    </tr>\n",
+       "  </tbody>\n",
+       "</table>\n",
+       "</div>"
+      ],
+      "text/plain": [
+       "   id            u\n",
+       "0   2  9999.994675\n",
+       "1   4   401.932237\n",
+       "2   6   346.203709"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "\n",
+      "------tap regulator result------\n",
+      "\n",
+      "----------fast_any_tap----------\n"
+     ]
+    },
+    {
+     "data": {
+      "text/html": [
+       "<div>\n",
+       "<style scoped>\n",
+       "    .dataframe tbody tr th:only-of-type {\n",
+       "        vertical-align: middle;\n",
+       "    }\n",
+       "\n",
+       "    .dataframe tbody tr th {\n",
+       "        vertical-align: top;\n",
+       "    }\n",
+       "\n",
+       "    .dataframe thead th {\n",
+       "        text-align: right;\n",
+       "    }\n",
+       "</style>\n",
+       "<table border=\"1\" class=\"dataframe\">\n",
+       "  <thead>\n",
+       "    <tr style=\"text-align: right;\">\n",
+       "      <th></th>\n",
+       "      <th>id</th>\n",
+       "      <th>energized</th>\n",
+       "      <th>tap_pos</th>\n",
+       "    </tr>\n",
+       "  </thead>\n",
+       "  <tbody>\n",
+       "    <tr>\n",
+       "      <th>0</th>\n",
+       "      <td>8</td>\n",
+       "      <td>1</td>\n",
+       "      <td>-1</td>\n",
+       "    </tr>\n",
+       "  </tbody>\n",
+       "</table>\n",
+       "</div>"
+      ],
+      "text/plain": [
+       "   id  energized  tap_pos\n",
+       "0   8          1       -1"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "# one-time power flow calculation with automatic tap changing\n",
+    "output_data6f = model5.calculate_power_flow(tap_changing_strategy=TapChangingStrategy.fast_any_tap)\n",
+    "\n",
+    "# the node at the control side of the transformer now has a voltage within the specified voltage band\n",
+    "print(\"------node result------\")\n",
+    "display(pd.DataFrame(output_data6f[ComponentType.node])[[\"id\", \"u\"]])\n",
+    "\n",
+    "print(\"\\n------tap regulator result------\")\n",
+    "print(\"\\n----------fast_any_tap----------\")\n",
+    "display(pd.DataFrame(output_data6f[ComponentType.transformer_tap_regulator]))"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "7828a4e3",
+   "metadata": {},
+   "source": [
+    "**NOTE:** the tap positions obtained using the `any_valid_tap` and `fast_any_tap` strategy may depend on the initial tap position of the transformers."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 13,
    "id": "be276930",
    "metadata": {},
    "outputs": [
@@ -1094,7 +1240,7 @@
     "\n",
     "# power flow batch calculation with automatic tap changing\n",
     "output_data = model5.calculate_power_flow(\n",
-    "    update_data=update_data, tap_changing_strategy=TapChangingStrategy.any_valid_tap\n",
+    "    update_data=update_data, tap_changing_strategy=TapChangingStrategy.fast_any_tap\n",
     ")\n",
     "\n",
     "print(\"------node_4 batch result------\")\n",
@@ -1116,7 +1262,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 14,
    "id": "21b01a77",
    "metadata": {},
    "outputs": [
@@ -1259,7 +1405,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
+   "execution_count": 15,
    "id": "c0314199",
    "metadata": {},
    "outputs": [
@@ -1412,7 +1558,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 15,
+   "execution_count": 16,
    "id": "ac091392",
    "metadata": {},
    "outputs": [],
@@ -1437,7 +1583,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 16,
+   "execution_count": 17,
    "id": "9b66d16e",
    "metadata": {},
    "outputs": [
@@ -1585,7 +1731,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.2"
+   "version": "3.10.14"
   },
   "vscode": {
    "interpreter": {