Update the examples

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

Author: actions-user

examples/Asymmetric Calculation Example.ipynb

@@ -119,8 +119,8 @@
     "asym_load[\"node\"] = [6]\n",
     "asym_load[\"status\"] = [1]\n",
     "asym_load[\"type\"] = [LoadGenType.const_power]\n",
-    "asym_load[\"p_specified\"] = [[10e6, 20e6 , 0]] # the 3 phases may have different loads\n",
-    "asym_load[\"q_specified\"] = [[0, 8e6, 2e6]] # the 3 phases may have different loads\n",
+    "asym_load[\"p_specified\"] = [[10e6, 20e6, 0]]  # the 3 phases may have different loads\n",
+    "asym_load[\"q_specified\"] = [[0, 8e6, 2e6]]  # the 3 phases may have different loads\n",
     "\n",
     "# source\n",
     "source = initialize_array(DatasetType.input, ComponentType.source, 1)\n",
@@ -135,7 +135,7 @@
     "    ComponentType.line: line,\n",
     "    ComponentType.sym_load: sym_load,\n",
     "    ComponentType.asym_load: asym_load,\n",
-    "    ComponentType.source: source\n",
+    "    ComponentType.source: source,\n",
     "}"
    ]
   },
@@ -172,7 +172,8 @@
     "    symmetric=False,  # This enables asymmetric calculations\n",
     "    error_tolerance=1e-8,\n",
     "    max_iterations=20,\n",
-    "    calculation_method=CalculationMethod.newton_raphson)"
+    "    calculation_method=CalculationMethod.newton_raphson,\n",
+    ")"
    ]
   },
   {
@@ -269,13 +270,13 @@
    "outputs": [],
    "source": [
     "# note the shape of the array, 10 scenarios, 1 objects (asymmetric load_7)\n",
-    "load_profile = initialize_array(DatasetType.update, ComponentType.asym_load, (10, 1))  \n",
+    "load_profile = initialize_array(DatasetType.update, ComponentType.asym_load, (10, 1))\n",
     "\n",
     "# this is a scale of asym_load from 0% to 100%------------------\n",
     "# the array is an (10, 1, 3) shape, which shows (scenario, object, phase).\n",
     "# Users can always customize the load_profile in different ways.\n",
     "load_profile[\"id\"] = [7]\n",
-    "load_profile[\"p_specified\"] = [10e6, 20e6 , 0] * np.linspace(0, 1, 10).reshape(-1, 1, 1)\n",
+    "load_profile[\"p_specified\"] = [10e6, 20e6, 0] * np.linspace(0, 1, 10).reshape(-1, 1, 1)\n",
     "\n",
     "time_series_mutation = {ComponentType.asym_load: load_profile}"
    ]
@@ -301,7 +302,12 @@
     "# Validation (optional)\n",
     "from power_grid_model.validation import assert_valid_batch_data\n",
     "\n",
-    "assert_valid_batch_data(input_data=asym_input_data, update_data=time_series_mutation, symmetric=False, calculation_type=CalculationType.power_flow)\n",
+    "assert_valid_batch_data(\n",
+    "    input_data=asym_input_data,\n",
+    "    update_data=time_series_mutation,\n",
+    "    symmetric=False,\n",
+    "    calculation_type=CalculationType.power_flow,\n",
+    ")\n",
     "\n",
     "# Batch Asymmetric Power Flow Calculation\n",
     "output_data = asym_model.calculate_power_flow(update_data=time_series_mutation, symmetric=False)"
@@ -519,7 +525,7 @@
     }
    ],
    "source": [
-    "display(pd.DataFrame(output_data[ComponentType.line][\"i_from\"][:,0]))"
+    "display(pd.DataFrame(output_data[ComponentType.line][\"i_from\"][:, 0]))"
    ]
   },
   {
@@ -560,10 +566,13 @@
     "sym_power_sensor[\"id\"] = [14, 15, 16, 17, 18, 19, 20]\n",
     "sym_power_sensor[\"measured_object\"] = [3, 3, 5, 5, 8, 8, 4]\n",
     "sym_power_sensor[\"measured_terminal_type\"] = [\n",
-    "    MeasuredTerminalType.branch_from, MeasuredTerminalType.branch_to,\n",
-    "    MeasuredTerminalType.branch_from, MeasuredTerminalType.branch_to,\n",
-    "    MeasuredTerminalType.branch_from, MeasuredTerminalType.branch_to,\n",
-    "    MeasuredTerminalType.load\n",
+    "    MeasuredTerminalType.branch_from,\n",
+    "    MeasuredTerminalType.branch_to,\n",
+    "    MeasuredTerminalType.branch_from,\n",
+    "    MeasuredTerminalType.branch_to,\n",
+    "    MeasuredTerminalType.branch_from,\n",
+    "    MeasuredTerminalType.branch_to,\n",
+    "    MeasuredTerminalType.load,\n",
     "]\n",
     "sym_power_sensor[\"power_sigma\"] = [1.0e5, 1.0e4, 1.0e5, 1.0e4, 1.0e4, 1.0e5, 1.0e5]\n",
     "sym_power_sensor[\"p_measured\"] = [10e6, -20e6, 4e6, -4e6, 25e6, -15e6, 20e6]\n",
@@ -578,7 +587,7 @@
     "asym_power_sensor[\"p_measured\"] = [[10e6, 20e6, 0]]\n",
     "asym_power_sensor[\"q_measured\"] = [[0, 8e6, 2e6]]\n",
     "\n",
-    "# all \n",
+    "# all\n",
     "asym_input_data = {\n",
     "    ComponentType.node: node,\n",
     "    ComponentType.line: line,\n",
@@ -609,6 +618,7 @@
    "source": [
     "# Validation(optional)\n",
     "from power_grid_model.validation import assert_valid_input_data\n",
+    "\n",
     "assert_valid_input_data(input_data=asym_input_data, calculation_type=CalculationType.state_estimation, symmetric=False)\n",
     "\n",
     "# Construction\n",

examples/Make Test Dataset.ipynb

@@ -208,7 +208,12 @@
     "source[\"u_ref\"] = [1.0]\n",
     "\n",
     "# all\n",
-    "input_data = {ComponentType.node: node, ComponentType.line: line, ComponentType.sym_load: sym_load, ComponentType.source: source}"
+    "input_data = {\n",
+    "    ComponentType.node: node,\n",
+    "    ComponentType.line: line,\n",
+    "    ComponentType.sym_load: sym_load,\n",
+    "    ComponentType.source: source,\n",
+    "}"
    ]
   },
   {

examples/Power Flow Example.ipynb

@@ -118,7 +118,7 @@
     "    ComponentType.node: node,\n",
     "    ComponentType.line: line,\n",
     "    ComponentType.sym_load: sym_load,\n",
-    "    ComponentType.source: source\n",
+    "    ComponentType.source: source,\n",
     "}"
    ]
   },
@@ -180,6 +180,7 @@
    "outputs": [],
    "source": [
     "from power_grid_model.validation import assert_valid_input_data\n",
+    "\n",
     "assert_valid_input_data(input_data=input_data, calculation_type=CalculationType.power_flow)"
    ]
   },
@@ -249,10 +250,8 @@
    "outputs": [],
    "source": [
     "output_data = model.calculate_power_flow(\n",
-    "    symmetric=True,\n",
-    "    error_tolerance=1e-8,\n",
-    "    max_iterations=20,\n",
-    "    calculation_method=CalculationMethod.newton_raphson)"
+    "    symmetric=True, error_tolerance=1e-8, max_iterations=20, calculation_method=CalculationMethod.newton_raphson\n",
+    ")"
    ]
   },
   {
@@ -340,7 +339,8 @@
     "    error_tolerance=1e-8,\n",
     "    max_iterations=20,\n",
     "    calculation_method=CalculationMethod.newton_raphson,\n",
-    "    output_component_types=[ComponentType.node])\n",
+    "    output_component_types=[ComponentType.node],\n",
+    ")\n",
     "\n",
     "print(\"List of component types in result dataset\")\n",
     "print(list(output_data.keys()))\n",
@@ -450,10 +450,7 @@
     "update_line[\"from_status\"] = [0]  # switch off at from side\n",
     "# leave to-side swiching status the same, no need to specify\n",
     "\n",
-    "update_data = {\n",
-    "    ComponentType.sym_load: update_sym_load,\n",
-    "    ComponentType.line: update_line\n",
-    "}"
+    "update_data = {ComponentType.sym_load: update_sym_load, ComponentType.line: update_line}"
    ]
   },
   {
@@ -475,6 +472,7 @@
    "outputs": [],
    "source": [
     "from power_grid_model.validation import assert_valid_batch_data\n",
+    "\n",
     "assert_valid_batch_data(input_data=input_data, update_data=update_data, calculation_type=CalculationType.power_flow)"
    ]
   },
@@ -620,7 +618,9 @@
     "\n",
     "time_series_mutation = {ComponentType.sym_load: load_profile}\n",
     "\n",
-    "assert_valid_batch_data(input_data=input_data, update_data=time_series_mutation, calculation_type=CalculationType.power_flow)"
+    "assert_valid_batch_data(\n",
+    "    input_data=input_data, update_data=time_series_mutation, calculation_type=CalculationType.power_flow\n",
+    ")"
    ]
   },
   {
@@ -730,7 +730,7 @@
     }
    ],
    "source": [
-    "print(output_data[ComponentType.line][\"i_from\"][:,0])"
+    "print(output_data[ComponentType.line][\"i_from\"][:, 0])"
    ]
   },
   {
@@ -766,20 +766,14 @@
     "# below the same broadcasting trick\n",
     "line_profile[\"id\"] = [[3, 5, 8]]\n",
     "# fully specify the status of all lines, even it is the same as the base scenario\n",
-    "line_profile[\"from_status\"] = [\n",
-    "    [0, 1, 1],\n",
-    "    [1, 0, 1],\n",
-    "    [1, 1, 0]\n",
-    "]\n",
-    "line_profile[\"to_status\"] = [\n",
-    "    [0, 1, 1],\n",
-    "    [1, 0, 1],\n",
-    "    [1, 1, 0]\n",
-    "]\n",
+    "line_profile[\"from_status\"] = [[0, 1, 1], [1, 0, 1], [1, 1, 0]]\n",
+    "line_profile[\"to_status\"] = [[0, 1, 1], [1, 0, 1], [1, 1, 0]]\n",
     "\n",
     "n_min_1_mutation_update_all = {ComponentType.line: line_profile}\n",
     "\n",
-    "assert_valid_batch_data(input_data=input_data, update_data=n_min_1_mutation_update_all, calculation_type=CalculationType.power_flow)"
+    "assert_valid_batch_data(\n",
+    "    input_data=input_data, update_data=n_min_1_mutation_update_all, calculation_type=CalculationType.power_flow\n",
+    ")"
    ]
   },
   {
@@ -830,7 +824,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "line_profile = initialize_array(DatasetType.update, ComponentType.line, (3, 1))  # 3 scenarios, 1 object mutation per scenario\n",
+    "line_profile = initialize_array(\n",
+    "    DatasetType.update, ComponentType.line, (3, 1)\n",
+    ")  # 3 scenarios, 1 object mutation per scenario\n",
     "# for each mutation, only one object is specified\n",
     "line_profile[\"id\"] = [[3], [5], [8]]\n",
     "# specify only the changed status (switch off) of one line\n",
@@ -839,7 +835,9 @@
     "\n",
     "n_min_1_mutation_update_specific = {ComponentType.line: line_profile}\n",
     "\n",
-    "assert_valid_batch_data(input_data=input_data, update_data=n_min_1_mutation_update_specific, calculation_type=CalculationType.power_flow)"
+    "assert_valid_batch_data(\n",
+    "    input_data=input_data, update_data=n_min_1_mutation_update_specific, calculation_type=CalculationType.power_flow\n",
+    ")"
    ]
   },
   {
@@ -973,10 +971,7 @@
     "line_error[\"tan1\"] = [0.0]\n",
     "line_error[\"i_n\"] = [1000]\n",
     "\n",
-    "error_data = {\n",
-    "    ComponentType.node: node_error,\n",
-    "    ComponentType.line: line_error\n",
-    "}\n",
+    "error_data = {ComponentType.node: node_error, ComponentType.line: line_error}\n",
     "\n",
     "try:\n",
     "    assert_valid_input_data(error_data, symmetric=True)\n",
@@ -1059,10 +1054,8 @@
    "source": [
     "try:\n",
     "    model.calculate_power_flow(\n",
-    "        symmetric=True,\n",
-    "        error_tolerance=1e-20,\n",
-    "        max_iterations=20,\n",
-    "        calculation_method=CalculationMethod.newton_raphson)\n",
+    "        symmetric=True, error_tolerance=1e-20, max_iterations=20, calculation_method=CalculationMethod.newton_raphson\n",
+    "    )\n",
     "except PowerGridError as e:\n",
     "    print(e)"
    ]
@@ -1097,7 +1090,7 @@
    "outputs": [],
    "source": [
     "time_series_mutation[ComponentType.sym_load][\"id\"][3] = 1000  # unknown id\n",
-    "time_series_mutation[ComponentType.sym_load][\"p_specified\"][7] = 1e100  # large power\n"
+    "time_series_mutation[ComponentType.sym_load][\"p_specified\"][7] = 1e100  # large power"
    ]
   },
   {
@@ -1169,14 +1162,11 @@
     }
    ],
    "source": [
-    "# we run the batch calculation with continue_on_batch_error=True, \n",
+    "# we run the batch calculation with continue_on_batch_error=True,\n",
     "#    it will return the results with partially valid data\n",
     "\n",
     "\n",
-    "output_data = model.calculate_power_flow(\n",
-    "    update_data=time_series_mutation,\n",
-    "    continue_on_batch_error=True\n",
-    ")\n",
+    "output_data = model.calculate_power_flow(update_data=time_series_mutation, continue_on_batch_error=True)\n",
     "\n",
     "# print node data for u_pu, note that the data is rubbish for scenario 3 and 7\n",
     "print(\"Node data with invalid results\")\n",

examples/Short Circuit Example.ipynb

@@ -55,7 +55,14 @@
     "    import pandas as pd\n",
     "\n",
     "from power_grid_model import LoadGenType, ComponentType, DatasetType\n",
-    "from power_grid_model import PowerGridModel, CalculationMethod, CalculationType, FaultType, FaultPhase, ShortCircuitVoltageScaling\n",
+    "from power_grid_model import (\n",
+    "    PowerGridModel,\n",
+    "    CalculationMethod,\n",
+    "    CalculationType,\n",
+    "    FaultType,\n",
+    "    FaultPhase,\n",
+    "    ShortCircuitVoltageScaling,\n",
+    ")\n",
     "from power_grid_model import initialize_array"
    ]
   },
@@ -131,7 +138,7 @@
     "    ComponentType.line: line,\n",
     "    ComponentType.sym_load: sym_load,\n",
     "    ComponentType.source: source,\n",
-    "    ComponentType.fault: fault\n",
+    "    ComponentType.fault: fault,\n",
     "}"
    ]
   },
@@ -173,6 +180,7 @@
    "outputs": [],
    "source": [
     "from power_grid_model.validation import assert_valid_input_data\n",
+    "\n",
     "assert_valid_input_data(input_data=input_data, calculation_type=CalculationType.short_circuit)"
    ]
   },
@@ -230,7 +238,9 @@
    },
    "outputs": [],
    "source": [
-    "output_data = model.calculate_short_circuit(calculation_method=CalculationMethod.iec60909, short_circuit_voltage_scaling=ShortCircuitVoltageScaling.maximum)\n"
+    "output_data = model.calculate_short_circuit(\n",
+    "    calculation_method=CalculationMethod.iec60909, short_circuit_voltage_scaling=ShortCircuitVoltageScaling.maximum\n",
+    ")"
    ]
   },
   {
@@ -296,7 +306,7 @@
     "print(\"\\n------line result: id------\")\n",
     "print(output_data[ComponentType.line][\"id\"])\n",
     "print(\"------line result: u_pu------\")\n",
-    "print(output_data[ComponentType.line][\"i_from\"])\n"
+    "print(output_data[ComponentType.line][\"i_from\"])"
    ]
   },
   {