Split solution cells

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

Author: Thijss

power-grid-model-ds/introduction.ipynb

@@ -60,19 +60,30 @@
     "In this exercise, we will extend the grid to include an output voltage u for nodes and an output current i_from for lines, which are not present in the basic grid.\n",
     "\n",
     "### Step 1: Define Extended Node and Line arrays\n",
-    "We create subclasses of NodeArray and LineArray that include the new properties. We'll call them MyNodeArray and MyLineArray. Each subclass defines a class attribute for the new column and (optionally) a default value for that column via a _defaults dictionary."
+    "We create subclasses of NodeArray and LineArray that include the new properties. We'll call them MyNodeArray and MyLineArray. Each subclass defines a class attribute for the new column and (optionally) a default value for that column via a _defaults dictionary.\n",
+    "\n",
+    "**⚙️ Assignment**: Create two Array extensions to hold the x, y, u (extending NodeArray) and i_from (extending LineArray) attributes\n",
+    "\n",
+    "**💡 Hint**: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_extensions_examples.html"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "fcb5c7f4",
+   "id": "7cfe11a7-80ed-4fe9-8c7f-0daf0ec1c27a",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Build your solution here..."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "6ada3e60-8bd7-4687-9f29-3ae5ff029228",
    "metadata": {},
    "outputs": [],
    "source": [
-    "# ⚙️ Create two Array extensions to hold the x, y, u (extending NodeArray) and i_from (extending LineArray) attributes\n",
-    "# Hint: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_extensions_examples.html\n",
-    "\n",
     "# %load solutions/introduction_1_1_define_array_extensions"
    ]
   },
@@ -82,19 +93,32 @@
    "metadata": {},
    "source": [
     "### Step 2: Create an Extended Grid class\n",
-    "Now we'll integrate these new arrays into a custom Grid class. We do this by subclassing the PGM-DS Grid and specifying that our grid should use MyNodeArray and MyLineArray instead of the default NodeArray and LineArray. We'll use Python's dataclass to define the new Grid schema:"
+    "Now we'll integrate these new arrays into a custom Grid class. We do this by subclassing the PGM-DS Grid and specifying that our grid should use MyNodeArray and MyLineArray instead of the default NodeArray and LineArray. We'll use Python's dataclass to define the new Grid schema:\n",
+    "\n",
+    "**⚙️ Assignment**: Create a new grid class that uses the extended arrays.\n",
+    "\n",
+    "**💡 Hint 1**: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_extensions_examples.html#adding-the-new-arrays-to-the-grid\n",
+    "\n",
+    "**💡 Hint 2**: Make sure to add the `@dataclass` decorator to your grid."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "2da55398",
+   "id": "de236a67-1632-4f81-9145-7a904c63746b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Build your solution here..."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "a7512d0d-5d85-44b6-b42e-11be0fa6802a",
    "metadata": {},
    "outputs": [],
    "source": [
-    "# ⚙️ Create a new grid class that uses the extended arrays\n",
-    "# Hint: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_extensions_examples.html\n",
-    "\n",
     "# %load solutions/introduction_1_2_define_my_grid"
    ]
   },
@@ -112,7 +136,11 @@
    "metadata": {},
    "source": [
     "### Step 3: Initialize an Extended Grid\n",
-    "With the classes defined, let's create an instance of our extended grid. PGM-DS provides a convenient class method Grid.empty() to initialize an empty grid. We'll call this on our ExtendedGrid:"
+    "With the classes defined, let's create an instance of our extended grid. PGM-DS provides a convenient class method Grid.empty() to initialize an empty grid. We'll call this on our ExtendedGrid:\n",
+    "\n",
+    "**⚙️ Assignment**: Instantiate an empty extended grid\n",
+    "\n",
+    "**💡 Hint**: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_examples.html#creating-an-empty-grid"
    ]
   },
   {
@@ -122,9 +150,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# ⚙️ Instantiate an empty extended grid\n",
-    "# Hint: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_examples.html#creating-an-empty-grid\n",
-    "\n",
+    "# Build your solution here..."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "8d5464bf-5689-4919-a85b-b6548b475537",
+   "metadata": {},
+   "outputs": [],
+   "source": [
     "# %load solutions/introduction_1_3_grid_empty"
    ]
   },
@@ -133,7 +168,11 @@
    "id": "06983bc4",
    "metadata": {},
    "source": [
-    "Verification: To ensure our extended properties exist, you can access the new attributes:"
+    "Verification: To ensure our extended properties exist, you can access the new attributes:\n",
+    "\n",
+    "**⚙️ Assignment**: Print some information about the grid.\n",
+    "\n",
+    "**💡 Hint**: Be creative! You can use the grid's attributes and methods to get information about the grid. Using `print()` on an array will format it for better readability."
    ]
   },
   {
@@ -143,9 +182,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# ⚙️ Print some information about the grid\n",
-    "# Hint: be creative! You can use the grid's attributes and methods to get information about the grid.\n",
-    "\n",
+    "# Build your solution here..."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "b4d131c6-094a-49a2-a283-5bdbd05e961d",
+   "metadata": {},
+   "outputs": [],
+   "source": [
     "# %load solutions/introduction_1_3_grid_verification"
    ]
   },
@@ -177,7 +223,11 @@
     "### Step 1: Add a substation node\n",
     "First, let's add a substation node to the grid. We create an MyNodeArray with one entry representing the substation. We need to provide at least an id, a rated voltage (u_rated), and a node type.\n",
     "We will use the enum NodeType.SUBSTATION_NODE for the type.\n",
-    "In this example, we will assign the substation an ID of 101 and a rated voltage of 10500.0 (which could represent 10.5 kV):"
+    "In this example, we will assign the substation an ID of 101 and a rated voltage of 10500.0 (which could represent 10.5 kV):\n",
+    "\n",
+    "**⚙️ Assignment**: Add a substation to the grid.\n",
+    "\n",
+    "**💡 Hint**: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_examples.html#adding-substations"
    ]
   },
   {
@@ -187,9 +237,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# ⚙️ Add a substation to the grid\n",
-    "# Hint: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_examples.html#adding-substations\n",
-    "\n",
+    "# Build your solution here..."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "5c641c07-1cc7-44bc-87ff-49bed38e7d5c",
+   "metadata": {},
+   "outputs": [],
+   "source": [
     "# %load solutions/introduction_2_1_add_substation"
    ]
   },
@@ -218,7 +275,9 @@
    "metadata": {},
    "source": [
     "### Step 2: Add a second node\n",
-    "Next, we'll add another node to represent a load or another bus in the grid. This node will be of a generic type (we'll use NodeType.UNSPECIFIED, which equals 0 in the enum). We'll give it an ID of 102 and the same base voltage (10.5 kV):"
+    "Next, we'll add another node to represent a load or another bus in the grid. This node will be of a generic type (we'll use NodeType.UNSPECIFIED, which equals 0 in the enum). We'll give it an ID of 102 and the same base voltage (10.5 kV).\n",
+    "\n",
+    "**⚙️ Assignment**: Add a node to the grid. "
    ]
   },
   {
@@ -228,8 +287,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# ⚙️ Add a node to the grid\n",
-    "\n",
+    "# Build your solution here..."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "3f987c7c-ea3b-472c-b9f9-f379a478bc4e",
+   "metadata": {},
+   "outputs": [],
+   "source": [
     "# %load solutions/introduction_2_2_add_node"
    ]
   },
@@ -250,7 +317,11 @@
    "metadata": {},
    "source": [
     "### Step 3: Add a line connecting the two nodes\n",
-    "Now that we have two nodes, we will connect them with a line. We'll use our MyLineArray to create a single line record. We need to specify an ID for the line (let's use 201), the from_node and to_node it connects (101 to 102), and statuses to indicate the line is active. We should also provide line electrical parameters (resistance, reactance, etc.) – we'll use some placeholder values here for demonstration:"
+    "Now that we have two nodes, we will connect them with a line. We'll use our MyLineArray to create a single line record. We need to specify an ID for the line (let's use 201), the from_node and to_node it connects (101 to 102), and statuses to indicate the line is active. We should also provide line electrical parameters (resistance, reactance, etc.) – we'll use some placeholder values here for demonstration:\n",
+    "\n",
+    "**⚙️ Assignment**: Add a line to the grid.\n",
+    "\n",
+    "**💡 Hint**: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_examples.html#adding-lines"
    ]
   },
   {
@@ -260,9 +331,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# ⚙️ Add a line to the grid\n",
-    "# Hint: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_examples.html#adding-lines\n",
-    "\n",
+    "# Build your solution here..."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "0211f7ec-0890-4880-b78a-65610e1eaf10",
+   "metadata": {},
+   "outputs": [],
+   "source": [
     "# %load solutions/introduction_2_3_add_line"
    ]
   },
@@ -290,7 +368,11 @@
    "metadata": {},
    "source": [
     "### Step 4: Add a load to the second node\n",
-    "We'll now add a load connected to node 102. PGM-DS uses a SymLoadArray for symmetrical loads. We will create a single load with an ID of 401 at node 102. We need to specify the node it is attached to, a load type code (we'll use 1 for a basic load type), the specified active (p_specified) and reactive (q_specified) power (let's say 1e6 each, representing 1 MW and 1 Mvar for example), and set its status to active (1):"
+    "We'll now add a load connected to node 102. PGM-DS uses a SymLoadArray for symmetrical loads. We will create a single load with an ID of 401 at node 102. We need to specify the node it is attached to, a load type code (we'll use 1 for a basic load type), the specified active (p_specified) and reactive (q_specified) power (let's say 1e6 each, representing 1 MW and 1 Mvar for example), and set its status to active (1):\n",
+    "\n",
+    "**⚙️ Assignment**: Add a load to the grid.\n",
+    "\n",
+    "**💡 Hint**: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_examples.html#adding-loads"
    ]
   },
   {
@@ -300,9 +382,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# ⚙️ Add a load to the grid\n",
-    "# Hint: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_examples.html#adding-loads\n",
-    "\n",
+    "# Build your solution here..."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "5499a30c-8820-4066-a322-ee03d5cfb8cf",
+   "metadata": {},
+   "outputs": [],
+   "source": [
     "# %load solutions/introduction_2_4_add_load"
    ]
   },
@@ -330,7 +419,11 @@
    "metadata": {},
    "source": [
     "### Step 5: Add a source to the substation node\n",
-    "Finally, we'll add a power source to supply the grid at the substation (node 101). We'll use SourceArray for this. We'll create a source with ID 501 at node 101, status active (1), and set a reference voltage u_ref. Typically, u_ref might be the slack/reference voltage magnitude or angle; we'll use 0.0 as a reference angle (assuming the default usage):"
+    "Finally, we'll add a power source to supply the grid at the substation (node 101). We'll use SourceArray for this. We'll create a source with ID 501 at node 101, status active (1), and set a reference voltage u_ref. Typically, u_ref might be the slack/reference voltage magnitude or angle; we'll use 0.0 as a reference angle (assuming the default usage):\n",
+    "\n",
+    "**⚙️ Assignment**: Add a source to the grid.\n",
+    "\n",
+    "**💡 Hint**: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_examples.html#adding-a-source"
    ]
   },
   {
@@ -340,9 +433,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# ⚙️ Add a source to the grid\n",
-    "# Hint: https://power-grid-model-ds.readthedocs.io/en/stable/examples/model/grid_examples.html#adding-a-source\n",
-    "\n",
+    "# Build your solution here..."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "1ab72aec-acc5-42ac-b429-18f608d6bd38",
+   "metadata": {},
+   "outputs": [],
+   "source": [
     "# %load solutions/introduction_2_5_add_source"
    ]
   },
@@ -369,7 +469,11 @@
    "id": "e5e6eb1b",
    "metadata": {},
    "source": [
-    "You should see [501] as the source ID and [101] as the node, indicating the source is at node 101. The count of sources should be 1. Now we have built a simple grid with 2 nodes (101 and 102), 1 line connecting them, 1 load at node 102, and 1 source at node 101. It's good practice to ensure all IDs are unique and there are no inconsistencies. PGM-DS provides a method grid.check_ids() to validate this​"
+    "You should see [501] as the source ID and [101] as the node, indicating the source is at node 101. The count of sources should be 1. Now we have built a simple grid with 2 nodes (101 and 102), 1 line connecting them, 1 load at node 102, and 1 source at node 101. It's good practice to ensure all IDs are unique and there are no inconsistencies. PGM-DS provides a method grid.check_ids() to validate this.\n",
+    "\n",
+    "**⚙️ Assignment**: Check whether all IDs are correct.\n",
+    "\n",
+    "**💡 Hint**: The grid has a method for that!"
    ]
   },
   {
@@ -379,9 +483,16 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# ⚙️ Check whether all IDs are correct\n",
-    "# Hint: The grid has a method for that!\n",
-    "\n",
+    "# Build your solution here..."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "403f00f3-d0bd-497a-8b93-8eaba629d68b",
+   "metadata": {},
+   "outputs": [],
+   "source": [
     "# %load solutions/introduction_2_6_check_ids"
    ]
   },
@@ -429,7 +540,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": ".venv",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -443,7 +554,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.6"
+   "version": "3.13.2"
   }
  },
  "nbformat": 4,