GridCalEngine 5.1.56__tar.gz → 5.1.57__tar.gz

{GridCalEngine-5.1.56 → GridCalEngine-5.1.57}/GridCalEngine/DataStructures/__init__.py

@@ -27,3 +27,4 @@ from GridCalEngine.DataStructures.fluid_turbine_data import FluidTurbineData
 from GridCalEngine.DataStructures.fluid_pump_data import FluidPumpData
 from GridCalEngine.DataStructures.fluid_p2x_data import FluidP2XData
 from GridCalEngine.DataStructures.fluid_path_data import FluidPathData
+from GridCalEngine.DataStructures.numerical_circuit import compile_numerical_circuit_at, NumericalCircuit

{GridCalEngine-5.1.56 → GridCalEngine-5.1.57}/GridCalEngine/Simulations/OPF/__init__.py

@@ -22,3 +22,4 @@ from GridCalEngine.Simulations.OPF.opf_ts_results import OptimalPowerFlowTimeSer
 from GridCalEngine.Simulations.OPF.opf_ts_driver import OptimalPowerFlowTimeSeriesDriver
 from GridCalEngine.Simulations.OPF.opf_driver import OptimalPowerFlowDriver
 from GridCalEngine.Simulations.OPF.simple_dispatch_ts import run_simple_dispatch, run_simple_dispatch_ts
+from GridCalEngine.Simulations.OPF.NumericalMethods.ac_opf import run_nonlinear_opf, NonlinearOPFResults

GridCalEngine-5.1.57/GridCalEngine/Topology/__init__.py

@@ -0,0 +1,19 @@
+# GridCal
+# Copyright (C) 2015 - 2024 Santiago Peñate Vera
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3 of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+from GridCalEngine.Topology.topology_processor import process_grid_topology_at
+from GridCalEngine.Topology.detect_substations import detect_substations

{GridCalEngine-5.1.56 → GridCalEngine-5.1.57}/GridCalEngine/Topology/detect_substations.py

@@ -14,16 +14,18 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program; if not, write to the Free Software Foundation,
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-
-from typing import List, Union
+from __future__ import annotations
+from typing import List, Union, TYPE_CHECKING
 import numpy as np
 import GridCalEngine.Devices as dev
 from GridCalEngine.Devices.types import BRANCH_TYPES
-from GridCalEngine.Devices.multi_circuit import MultiCircuit
 from GridCalEngine.Topology.topology import find_islands, get_adjacency_matrix
-from GridCalEngine.basic_structures import IntVec, Logger
+from GridCalEngine.basic_structures import IntVec
 from scipy.sparse import lil_matrix
 
+if TYPE_CHECKING:
+    from GridCalEngine.Devices.multi_circuit import MultiCircuit
+
 
 def get_bus_group_substation(bus_indices: IntVec, buses: List[dev.Bus]) -> Union[dev.Substation, None]:
     """

{GridCalEngine-5.1.56 → GridCalEngine-5.1.57}/GridCalEngine/__init__.py

@@ -15,3 +15,4 @@
 # along with this program; if not, write to the Free Software Foundation,
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
+from GridCalEngine.api import *

{GridCalEngine-5.1.56 → GridCalEngine-5.1.57}/GridCalEngine/__version__.py

@@ -16,7 +16,7 @@ import datetime
 _current_year_ = datetime.datetime.now().year
 
 # do not forget to keep a three-number version!!!
-__GridCalEngine_VERSION__ = "5.1.56"
+__GridCalEngine_VERSION__ = "5.1.57"
 
 url = 'https://github.com/SanPen/GridCal'
 

{GridCalEngine-5.1.56 → GridCalEngine-5.1.57}/GridCalEngine/api.py

@@ -14,14 +14,13 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program; if not, write to the Free Software Foundation,
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-from GridCalEngine.Simulations.OPF.NumericalMethods.ac_opf import run_nonlinear_opf, NonlinearOPFResults
+from __future__ import annotations
 from GridCalEngine.basic_structures import *
 from GridCalEngine.Simulations import *
 from GridCalEngine.IO import *
 from GridCalEngine.Devices import *
-from GridCalEngine.DataStructures.numerical_circuit import compile_numerical_circuit_at
+from GridCalEngine.DataStructures import *
 from GridCalEngine.enumerations import *
-from GridCalEngine.Topology.detect_substations import detect_substations
 
 
 def open_file(filename: Union[str, List[str]]) -> MultiCircuit:
@@ -133,6 +132,81 @@ def power_flow_ts(grid: MultiCircuit,
     return driver.results
 
 
+def short_circuit(grid: MultiCircuit,
+                  fault_index: int,
+                  fault_type=FaultType.LG,
+                  pf_options: PowerFlowOptions = PowerFlowOptions(),
+                  pf_results: PowerFlowResults | None = None) -> ShortCircuitResults:
+    """
+    Run short circuit
+    :param grid: MultiCircuit instance
+    :param fault_index: Bus fault index
+    :param fault_type: Short circuit FaultType
+    :param pf_options: Power Flow Options instance (optional)
+    :param pf_results: PowerFlowResults (optional, if none, a power flow is run)
+    :return: Short circuit results
+    """
+    if pf_results is None:
+        pf_results = power_flow(grid=grid,
+                                options=pf_options)
+
+    sc_options = ShortCircuitOptions(bus_index=fault_index,
+                                     fault_type=fault_type)
+
+    sc = ShortCircuitDriver(grid=grid,
+                            options=sc_options,
+                            pf_options=pf_options,
+                            pf_results=pf_results)
+    sc.run()
+
+    return sc.results
+
+
+def continuation_power_flow(grid: MultiCircuit,
+                            options: ContinuationPowerFlowOptions = None,
+                            pf_options: PowerFlowOptions = PowerFlowOptions(),
+                            pf_results: PowerFlowResults | None = None) -> ShortCircuitResults:
+    """
+    Run continuation power flow circuit
+    :param grid: MultiCircuit instance
+    :param options: ContinuationPowerFlowOptions instance (optional)
+    :param pf_options: Power Flow Options instance (optional)
+    :param pf_results: PowerFlowResults (optional, if none, a power flow is run)
+    :return: Short circuit results
+    """
+    if pf_results is None:
+        pf_results = power_flow(grid=grid,
+                                options=pf_options)
+
+    # declare the CPF options
+    if options is None:
+        options = ContinuationPowerFlowOptions(step=0.001,
+                                               approximation_order=CpfParametrization.ArcLength,
+                                               adapt_step=True,
+                                               step_min=0.00001,
+                                               step_max=0.2,
+                                               error_tol=1e-3,
+                                               tol=1e-6,
+                                               max_it=20,
+                                               stop_at=CpfStopAt.Full,
+                                               verbose=False)
+
+    # We compose the target direction
+    base_power = pf_results.Sbus / grid.Sbase
+    vc_inputs = ContinuationPowerFlowInput(Sbase=base_power,
+                                           Vbase=pf_results.voltage,
+                                           Starget=base_power * 2)
+
+    # declare the CPF driver and run
+    vc = ContinuationPowerFlowDriver(grid=grid,
+                                     options=options,
+                                     inputs=vc_inputs,
+                                     pf_options=pf_options)
+    vc.run()
+
+    return vc.results
+
+
 def acopf(grid: MultiCircuit,
           pf_options: PowerFlowOptions = PowerFlowOptions(),
           opf_options: OptimalPowerFlowOptions = OptimalPowerFlowOptions(),
@@ -157,6 +231,22 @@ def acopf(grid: MultiCircuit,
     return acopf_res
 
 
+def lin_opf(grid: MultiCircuit,
+            options: OptimalPowerFlowOptions = OptimalPowerFlowOptions()) -> OptimalPowerFlowResults:
+    """
+    Run Linear Optimal Power Flow
+    :param grid: MultiCircuit instance
+    :param options: Optimal Power Flow Options instance (optional)
+    :return: Linear Optimal Power Flow results
+    """
+
+    # declare the snapshot opf
+    opf_driver = OptimalPowerFlowDriver(grid=grid, options=options)
+    opf_driver.run()
+
+    return opf_driver.results
+
+
 def contingencies_ts(circuit: MultiCircuit,
                      use_clustering: bool = False,
                      n_points: int = 100,

{GridCalEngine-5.1.56 → GridCalEngine-5.1.57}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: GridCalEngine
-Version: 5.1.56
+Version: 5.1.57
 Summary: GridCal is a Power Systems simulation program intended for professional use and research
 Home-page: https://github.com/SanPen/GridCal
 Author: Santiago Peñate Vera et. Al.