VeraGridEngine 5.5.0__tar.gz → 5.5.1__tar.gz

{veragridengine-5.5.0 → veragridengine-5.5.1}/PKG-INFO

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

{veragridengine-5.5.0 → veragridengine-5.5.1}/VeraGridEngine/Devices/assets.py

@@ -4122,7 +4122,7 @@ class Assets:
         """
         self._rms_events_groups.append(obj)
 
-    def delete_rms_events_groups(self, obj: dev.RmsEventsGroup):
+    def delete_rms_events_group(self, obj: dev.RmsEventsGroup):
         """
         Delete zone
         :param obj: index
@@ -4226,7 +4226,7 @@ class Assets:
                     to_del.append(grp)
 
             for grp in to_del:
-                self.delete_rms_events_groups(grp)
+                self.delete_rms_events_group(grp)
 
     # ------------------------------------------------------------------------------------------------------------------
     # Remedial action
@@ -7001,6 +7001,14 @@ class Assets:
             elm = dev.DynamicModelHost()
             dictionary_of_lists = dict()
 
+        elif elm_type == DeviceType.RmsEventDevice:
+            elm = dev.RmsEvent()
+            dictionary_of_lists = dict()
+
+        elif elm_type == DeviceType.RmsEventsGroupDevice:
+            elm = dev.RmsEventsGroup()
+            dictionary_of_lists = dict()
+
         else:
             raise Exception(f'elm_type not understood: {elm_type.value}')
 

{veragridengine-5.5.0 → veragridengine-5.5.1}/VeraGridEngine/Simulations/Rms/initialization.py

@@ -303,6 +303,4 @@ def initialize_rms(grid: MultiCircuit, power_flow_results, logger: Logger = Logg
                 mdl.algebraic_eqs.append(P[i])
                 mdl.algebraic_eqs.append(Q[i])
 
-
-
     return compose_system_block(grid, power_flow_results, vars2device)

veragridengine-5.5.1/VeraGridEngine/Simulations/SmallSignalStability/__init__.py

@@ -0,0 +1,8 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+# SPDX-License-Identifier: MPL-2.0
+
+from VeraGridEngine.Simulations.SmallSignalStability.small_signal_driver import SmallSignalStabilityDriver
+from VeraGridEngine.Simulations.SmallSignalStability.small_signal_options import SmallSignalStabilityOptions
+from VeraGridEngine.Simulations.SmallSignalStability.small_signal_results import SmallSignalStabilityResults

veragridengine-5.5.0/VeraGridEngine/Simulations/SmallSignal_Stability/SmallSignal_driver.py → veragridengine-5.5.1/VeraGridEngine/Simulations/SmallSignalStability/small_signal_driver.py

@@ -8,19 +8,22 @@ from typing import Dict, Union
 from VeraGridEngine.Devices.multi_circuit import MultiCircuit
 from VeraGridEngine.Utils.Symbolic.block_solver import BlockSolver
 from VeraGridEngine.Simulations.driver_template import DriverTemplate
-from VeraGridEngine.Simulations.SmallSignal_Stability.SmallSignal_options import SmallSignal_Stability_Options
-from VeraGridEngine.Simulations.SmallSignal_Stability.SmallSignal_results import SmallSignal_Stability_Results
+from VeraGridEngine.Simulations.SmallSignalStability.small_signal_options import SmallSignalStabilityOptions
+from VeraGridEngine.Simulations.SmallSignalStability.small_signal_results import SmallSignalStabilityResults
 from VeraGridEngine.enumerations import EngineType, SimulationTypes
 from VeraGridEngine.Simulations.PowerFlow.power_flow_driver import PowerFlowResults
 from VeraGridEngine.Simulations.Rms.initialization import initialize_rms
 
 
-class SmallSignal_Stability_Driver(DriverTemplate):
+class SmallSignalStabilityDriver(DriverTemplate):
+    """
+    SmallSignal_Stability_Driver
+    """
     name = 'Small Signal Stability Simulation'
     tpe = SimulationTypes.SmallSignal_run
 
     def __init__(self, grid: MultiCircuit,
-                 options: Union[SmallSignal_Stability_Options, None] = None,
+                 options: Union[SmallSignalStabilityOptions, None] = None,
                  pf_results: Union[PowerFlowResults, None] = None,
                  engine: EngineType = EngineType.VeraGrid):
 
@@ -38,13 +41,13 @@ class SmallSignal_Stability_Driver(DriverTemplate):
 
         self.pf_results: Union[PowerFlowResults, None] = pf_results
 
-        self.options: SmallSignal_Stability_Options = SmallSignal_Stability_Options() if options is None else options
+        self.options: SmallSignalStabilityOptions = SmallSignalStabilityOptions() if options is None else options
 
-        self.results:  SmallSignal_Stability_Results = SmallSignal_Stability_Results(stability = "",
-                 Eigenvalues = np.empty(0),
-                 PF = np.empty(0),
-                 stat_vars =  [],
-                 vars2device= {})
+        self.results: SmallSignalStabilityResults = SmallSignalStabilityResults(stability="",
+                                                                                Eigenvalues=np.empty(0),
+                                                                                PF=np.empty(0),
+                                                                                stat_vars=[],
+                                                                                vars2device={})
 
         self.__cancel__ = False
 
@@ -57,9 +60,9 @@ class SmallSignal_Stability_Driver(DriverTemplate):
         :return:
         """
         # Run the dynamic simulation
-        self.run_Small_Signal_Stability()
+        self.run_small_signal_stability()
 
-    def run_Small_Signal_Stability(self):
+    def run_small_signal_stability(self):
         """
         Performs the numerical integration using the chosen method.
         :return:
@@ -82,6 +85,7 @@ class SmallSignal_Stability_Driver(DriverTemplate):
                 integrator = "implicit_euler"
             else:
                 raise ValueError(f"integrator not implemented :( {self.options.integration_method}")
+
             t, y = slv.simulate(
                 t0=0,
                 t_end=self.options.ss_assessment_time,
@@ -90,19 +94,28 @@ class SmallSignal_Stability_Driver(DriverTemplate):
                 params0=params0,
                 method=integrator
             )
-            i = int(self.options.ss_assessment_time/self.options.time_step)
-            stab, Eigenvalues, pfactors = slv.stability_assessment(x=y[i], params=params0, plot=False )
-        else:
 
-            stab, Eigenvalues, pfactors = slv.stability_assessment(x=x0, params=params0, plot=False )
+            i = int(self.options.ss_assessment_time / self.options.time_step)
+            (stability,
+             eigenvalues,
+             participation_factors,
+             damping_ratios,
+             conjugate_frequencies) = slv.run_small_signal_stability(x=y[i], params=params0, plot=False)
 
+        else:
 
-        self.results: SmallSignal_Stability_Results = SmallSignal_Stability_Results(stability=stab,
-                                                    Eigenvalues = Eigenvalues,
-                                                    PF = pfactors,
-                                                    stat_vars=slv._state_vars,
-                                                    vars2device=slv.vars2device)
+            (stability,
+             eigenvalues,
+             participation_factors,
+             damping_ratios,
+             conjugate_frequencies) = slv.run_small_signal_stability(x=x0, params=params0, plot=False)
 
+        self.results: SmallSignalStabilityResults = SmallSignalStabilityResults(
+            stability=stability,
+            Eigenvalues=eigenvalues,
+            PF=participation_factors,
+            stat_vars=slv.state_vars,
+            vars2device=slv.vars2device
+        )
 
         self.toc()
-

veragridengine-5.5.0/VeraGridEngine/Simulations/SmallSignal_Stability/SmallSignal_options.py → veragridengine-5.5.1/VeraGridEngine/Simulations/SmallSignalStability/small_signal_options.py

@@ -6,12 +6,12 @@
 from VeraGridEngine.enumerations import DynamicIntegrationMethod
 from VeraGridEngine.Simulations.options_template import OptionsTemplate
 
-class SmallSignal_Stability_Options(OptionsTemplate):
+
+class SmallSignalStabilityOptions(OptionsTemplate):
     """
     Rms simulation options
     """
 
-
     def __init__(self,
                  time_step: float = 0.01,
                  ss_assessment_time: float = 5,
@@ -22,7 +22,6 @@ class SmallSignal_Stability_Options(OptionsTemplate):
         todo: add EMT vs RMS!
         :param time_step: time step of the simulations (s)
         :param ss_assessment_time: stability assessment time (s)
-        :param max_integrator_iterations: max number of iterations
         :param tolerance: Integration tolerance
         :param integration_method: Integration method (default Trapezoid)
         """
@@ -34,10 +33,7 @@ class SmallSignal_Stability_Options(OptionsTemplate):
         self.ss_assessment_time: float = ss_assessment_time
         self.tolerance: float = tolerance
 
-
-
         self.register(key="integration_method", tpe=DynamicIntegrationMethod)
         self.register(key="time_step", tpe=float)
         self.register(key="ss_assessment_time", tpe=float)
         self.register(key="tolerance", tpe=float)
-

veragridengine-5.5.0/VeraGridEngine/Simulations/SmallSignal_Stability/SmallSignal_results.py → veragridengine-5.5.1/VeraGridEngine/Simulations/SmallSignalStability/small_signal_results.py

@@ -18,28 +18,37 @@ from VeraGridEngine.basic_structures import IntVec, Vec, StrVec, CxVec, Converge
 from VeraGridEngine.enumerations import StudyResultsType, ResultTypes, DeviceType
 from VeraGridEngine.Utils.Symbolic.symbolic import Var
 
-class SmallSignal_Stability_Results(ResultsTemplate):
+
+class SmallSignalStabilityResults(ResultsTemplate):
 
     def __init__(self,
                  stability: str,
                  Eigenvalues: np.ndarray,
                  PF: np.ndarray,
                  stat_vars: List[Var],
-                 vars2device: Dict[int, PhysicalDevice],
-                 ):
+                 vars2device: Dict[int, PhysicalDevice]):
+        """
+
+        :param stability:
+        :param Eigenvalues:
+        :param PF:
+        :param stat_vars:
+        :param vars2device:
+        """
         ResultsTemplate.__init__(
             self,
             name='Small Signal Stability',
-            available_results=[ResultTypes.Modes,
-                               ResultTypes.ParticipationFactors,
-                               ResultTypes.SDomainPlot
-                               ],
+            available_results=[
+                ResultTypes.Modes,
+                ResultTypes.ParticipationFactors,
+                ResultTypes.SDomainPlot
+            ],
             time_array=None,
             clustering_results=None,
             study_results_type=StudyResultsType.SmallSignalStability
         )
-        # stat_vars_names = [str(var) + vars2device[var.uid].name for var in stat_vars]
-        stat_vars_names =[f"{var}{i // 2 + 1}" for i, var in enumerate(stat_vars)]
+
+        stat_vars_names = [f"{var}{i // 2 + 1}" for i, var in enumerate(stat_vars)]
 
         self.stat_vars_array = np.array(stat_vars_names, dtype=np.str_)
 
@@ -59,7 +68,7 @@ class SmallSignal_Stability_Results(ResultsTemplate):
             return ResultsTable(
                 data=self.participation_factors,
                 index=np.array(self.stat_vars_array.astype(str), dtype=np.str_),
-                columns=np.array([f"Mode {i}" for i in range(len(self.eigenvalues))], dtype=np.str_), #
+                columns=np.array([f"Mode {i}" for i in range(len(self.eigenvalues))], dtype=np.str_),  #
                 title="Participation factors for each eigenvalue",
                 idx_device_type=DeviceType.NoDevice,
                 cols_device_type=DeviceType.NoDevice
@@ -69,7 +78,7 @@ class SmallSignal_Stability_Results(ResultsTemplate):
             return ResultsTable(
                 data=np.array([np.real(self.eigenvalues), np.imag(self.eigenvalues)]).T,
                 index=np.array([f"Mode {i}" for i in range(len(self.eigenvalues))], dtype=np.str_),
-                columns= np.array(["Real", "Imaginary"]),
+                columns=np.array(["Real", "Imaginary"]),
                 title="Eigenvalues",
                 idx_device_type=DeviceType.NoDevice,
                 cols_device_type=DeviceType.NoDevice
@@ -86,7 +95,7 @@ class SmallSignal_Stability_Results(ResultsTemplate):
                 plt.ion()
                 fig = plt.figure(figsize=(8, 6))
                 ax = fig.add_subplot(111)
-                sc = ax.scatter(re, im, c=colors, cmap = 'winter', s = 120, alpha = 0.8)
+                sc = ax.scatter(re, im, c=colors, cmap='winter', s=120, alpha=0.8)
                 fig.suptitle("S-Domain Stability plot")
                 ax.set_xlabel(r'Real  $ [s^{-1}]$')
                 ax.set_ylabel(r'Imaginary  $ [s^{-1}]$')
@@ -127,7 +136,7 @@ class SmallSignal_Stability_Results(ResultsTemplate):
                 fig.canvas.mpl_connect("motion_notify_event", hover)
 
             return ResultsTable(data=data,
-                                index=np.empty(len(self.eigenvalues),dtype=np.str_),
+                                index=np.empty(len(self.eigenvalues), dtype=np.str_),
                                 idx_device_type=DeviceType.NoDevice,
                                 columns=np.array(['Real', 'Imag']),
                                 cols_device_type=DeviceType.NoDevice,
@@ -153,4 +162,4 @@ class SmallSignal_Stability_Results(ResultsTemplate):
     #
     #     ax.set_title(r'$S-Domain$ plot')
     #     ax.set_xlabel(r'$Imaginary [s^{-1}]$')
-    #     ax.set_ylabel(r'$Real [s^{-1}]$')
+    #     ax.set_ylabel(r'$Real [s^{-1}]$')

{veragridengine-5.5.0 → veragridengine-5.5.1}/VeraGridEngine/Simulations/__init__.py

@@ -24,6 +24,6 @@ from VeraGridEngine.Simulations.NodalCapacity import *
 from VeraGridEngine.Simulations.Reliability import *
 from VeraGridEngine.Simulations.AI import *
 from VeraGridEngine.Simulations.Rms import *
-from VeraGridEngine.Simulations.SmallSignal_Stability import *
+from VeraGridEngine.Simulations.SmallSignalStability import *
 from VeraGridEngine.Simulations.results_template import DriverToSave, ResultsTemplate