GridCalEngine 5.0.13__tar.gz → 5.0.14__tar.gz

{GridCalEngine-5.0.13 → GridCalEngine-5.0.14}/GridCalEngine/DataStructures/hvdc_data.py

@@ -74,6 +74,8 @@ class HvdcData:
         self.C_hvdc_bus_t: sp.lil_matrix = sp.lil_matrix((nelm, nbus),
                                                          dtype=int)  # this ons is just for splitting islands
 
+        self.original_idx = np.zeros(nelm, dtype=int)
+
     def size(self) -> int:
         """
         Get size of the structure
@@ -123,6 +125,8 @@ class HvdcData:
         data.C_hvdc_bus_f = self.C_hvdc_bus_f[np.ix_(elm_idx, bus_idx)]
         data.C_hvdc_bus_t = self.C_hvdc_bus_t[np.ix_(elm_idx, bus_idx)]
 
+        data.original_idx = elm_idx
+
         # first slice, then remap
         data.F = self.F[elm_idx]
         data.T = self.T[elm_idx]
@@ -175,6 +179,8 @@ class HvdcData:
         data.C_hvdc_bus_f = self.C_hvdc_bus_f.copy()
         data.C_hvdc_bus_t = self.C_hvdc_bus_t.copy()
 
+        data.original_idx = self.original_idx.copy()
+
         return data
 
     def get_bus_indices_f(self) -> IntVec:

{GridCalEngine-5.0.13 → GridCalEngine-5.0.14}/GridCalEngine/Devices/Aggregation/__init__.py

@@ -25,3 +25,7 @@ from GridCalEngine.Devices.Aggregation.emission_gas import EmissionGas
 from GridCalEngine.Devices.Aggregation.area import Area
 from GridCalEngine.Devices.Aggregation.zone import Zone
 from GridCalEngine.Devices.Aggregation.country import Country
+from GridCalEngine.Devices.Aggregation.community import Community
+from GridCalEngine.Devices.Aggregation.region import Region
+from GridCalEngine.Devices.Aggregation.municipality import Municipality
+from GridCalEngine.Devices.Aggregation.branch_group import BranchGroup

GridCalEngine-5.0.14/GridCalEngine/Devices/Aggregation/branch_group.py

@@ -0,0 +1,37 @@
+# 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 typing import Union
+from GridCalEngine.Devices.Parents.editable_device import EditableDevice, DeviceType
+
+
+class BranchGroup(EditableDevice):
+
+    def __init__(self,
+                 name='',
+                 code='',
+                 idtag: Union[str, None] = None):
+        """
+        BranchGroup
+        :param name: name of the generator fuel
+        :param code: secondary id
+        :param idtag: UUID code
+        """
+        EditableDevice.__init__(self,
+                                name=name,
+                                code=code,
+                                idtag=idtag,
+                                device_type=DeviceType.BranchGroupDevice)

GridCalEngine-5.0.14/GridCalEngine/Devices/Aggregation/community.py

@@ -0,0 +1,47 @@
+# 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 typing import Union
+from GridCalEngine.Devices.Parents.editable_device import DeviceType
+from GridCalEngine.Devices.Aggregation.area import GenericAreaGroup
+from GridCalEngine.Devices.Aggregation.country import Country
+
+
+class Community(GenericAreaGroup):
+
+    def __init__(self, name='Country', idtag: Union[str, None] = None, code='', latitude=0.0, longitude=0.0,
+                 country: Union[Country, None] = None):
+        """
+        Country
+        :param name: name of the area
+        :param idtag: UUID code
+        :param latitude: latitude (deg)
+        :param longitude: longutide (deg)
+        :param country: (optional)
+        """
+        GenericAreaGroup.__init__(self,
+                                  name=name,
+                                  idtag=idtag,
+                                  code=code,
+                                  device_type=DeviceType.CommunityDevice,
+                                  latitude=latitude,
+                                  longitude=longitude)
+
+        self.country: Union[Country, None] = country
+
+        self.register(key="country", units="", tpe=DeviceType.CountryDevice,
+                      definition="Substation country, altenativelly this can be obtained from the community")

GridCalEngine-5.0.14/GridCalEngine/Devices/Aggregation/municipality.py

@@ -0,0 +1,47 @@
+# 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 typing import Union
+from GridCalEngine.Devices.Parents.editable_device import DeviceType
+from GridCalEngine.Devices.Aggregation.area import GenericAreaGroup
+from GridCalEngine.Devices.Aggregation.region import Region
+
+
+class Municipality(GenericAreaGroup):
+
+    def __init__(self, name='Municipality', idtag: Union[str, None] = None, code='', latitude=0.0, longitude=0.0,
+                 region: Union[Region, None] = None):
+        """
+        Country
+        :param name: name of the area
+        :param idtag: UUID code
+        :param latitude: latitude (deg)
+        :param longitude: longutide (deg)
+        :param region: (optional)
+        """
+        GenericAreaGroup.__init__(self,
+                                  name=name,
+                                  idtag=idtag,
+                                  code=code,
+                                  device_type=DeviceType.MunicipalityDevice,
+                                  latitude=latitude,
+                                  longitude=longitude)
+
+        self.region: Union[Region, None] = region
+
+        self.register(key="region", units="", tpe=DeviceType.RegionDevice,
+                      definition="Substation region, altenativelly this can be obtained from the municipality")

GridCalEngine-5.0.13/GridCalEngine/Devices/Substation/substation.py → GridCalEngine-5.0.14/GridCalEngine/Devices/Aggregation/region.py

@@ -18,22 +18,29 @@
 from typing import Union
 from GridCalEngine.Devices.Parents.editable_device import DeviceType
 from GridCalEngine.Devices.Aggregation.area import GenericAreaGroup
+from GridCalEngine.Devices.Aggregation.community import Community
 
 
-class Substation(GenericAreaGroup):
+class Region(GenericAreaGroup):
 
-    def __init__(self, name='Substation', idtag: Union[str, None] = None, code='', latitude=0.0, longitude=0.0):
+    def __init__(self, name='Region', idtag: Union[str, None] = None, code='', latitude=0.0, longitude=0.0,
+                 community: Union[Community, None] = None):
         """
-
-        :param name:
-        :param idtag:
-        :param latitude:
-        :param longitude:
+        Country
+        :param name: name of the area
+        :param idtag: UUID code
+        :param latitude: latitude (deg)
+        :param longitude: longutide (deg)
         """
         GenericAreaGroup.__init__(self,
                                   name=name,
                                   idtag=idtag,
                                   code=code,
-                                  device_type=DeviceType.SubstationDevice,
+                                  device_type=DeviceType.RegionDevice,
                                   latitude=latitude,
                                   longitude=longitude)
+
+        self.community: Union[Community, None] = community
+
+        self.register(key="community", units="", tpe=DeviceType.CommunityDevice,
+                      definition="Substation community, altenativelly this can be obtained from the region")

{GridCalEngine-5.0.13 → GridCalEngine-5.0.14}/GridCalEngine/Devices/Aggregation/zone.py

@@ -17,7 +17,7 @@
 
 from typing import Union
 from GridCalEngine.Devices.Parents.editable_device import DeviceType
-from GridCalEngine.Devices.Aggregation.area import GenericAreaGroup
+from GridCalEngine.Devices.Aggregation.area import GenericAreaGroup, Area
 
 
 class Zone(GenericAreaGroup):
@@ -26,13 +26,15 @@ class Zone(GenericAreaGroup):
                  idtag: Union[str, None] = None,
                  code='',
                  latitude=0.0,
-                 longitude=0.0):
+                 longitude=0.0,
+                 area: Union[Area, None] = None):
         """
         Zone
         :param name: name of the zone
         :param idtag: UUID code
         :param latitude: latitude (deg)
         :param longitude: longutide (deg)
+        :param area: (optional)
         """
         GenericAreaGroup.__init__(self,
                                   name=name,
@@ -40,4 +42,9 @@ class Zone(GenericAreaGroup):
                                   code=code,
                                   device_type=DeviceType.ZoneDevice,
                                   latitude=latitude,
-                                  longitude=longitude)
+                                  longitude=longitude)
+
+        self.area: Union[Area, None] = area
+
+        self.register(key="area", units="", tpe=DeviceType.AreaDevice,
+                      definition="Substation area, altenativelly this can be obtained from the zone")

{GridCalEngine-5.0.13 → GridCalEngine-5.0.14}/GridCalEngine/Devices/Branches/line.py

@@ -441,44 +441,6 @@ class Line(BranchParent):
         elm.temperature_prof = self.temp_oper_prof
         return elm
 
-    def split_line(self, position: float) -> Tuple["Line", "Line", Bus]:
-        """
-        Split a branch by a given distance
-        :param position: per unit distance measured from the "from" bus (0 ~ 1)
-        :return: the two new Branches and the mid short circuited bus
-        """
-
-        assert (0.0 < position < 1.0)
-
-        # Each of the Branches will have the proportional impedance
-        # Bus_from           Middle_bus            Bus_To
-        # o----------------------o--------------------o
-        #   >-------- x -------->|
-        #   (x: distance measured in per unit (0~1)
-
-        middle_bus = self.bus_from.copy()
-        middle_bus.name += ' split'
-
-        # C(x, y) = (x1 + t * (x2 - x1), y1 + t * (y2 - y1))
-        middle_bus.X = self.bus_from.x + (self.bus_to.x - self.bus_from.x) * position
-        middle_bus.y = self.bus_from.y + (self.bus_to.y - self.bus_from.y) * position
-
-        props_to_scale = ['R', 'R0', 'X', 'X0', 'B', 'B0', 'length']  # list of properties to scale
-
-        br1 = self.copy()
-        br1.bus_from = self.bus_from
-        br1.bus_to = middle_bus
-        for p in props_to_scale:
-            setattr(br1, p, getattr(self, p) * position)
-
-        br2 = self.copy()
-        br2.bus_from = middle_bus
-        br2.bus_to = self.bus_to
-        for p in props_to_scale:
-            setattr(br2, p, getattr(self, p) * (1.0 - position))
-
-        return br1, br2, middle_bus
-
     def fill_design_properties(self, r_ohm, x_ohm, c_nf, length, Imax, freq, Sbase):
         """
         Fill R, X, B from not-in-per-unit parameters

{GridCalEngine-5.0.13 → GridCalEngine-5.0.14}/GridCalEngine/Devices/Branches/switch.py

@@ -117,8 +117,6 @@ class Switch(BranchParent):
                    rate=self.rate,
                    active=self.active)
 
-        b.measurements = self.measurements
-
         return b
 
     def get_save_data(self):

{GridCalEngine-5.0.13 → GridCalEngine-5.0.14}/GridCalEngine/Devices/Injections/controllable_shunt.py

@@ -76,7 +76,7 @@ class ControllableShunt(InjectionParent):
         self._b_steps = np.zeros(number_of_steps)
 
         # regardless of the linear / nonlinear type, we always store
-        # the cummulative values because the query is faster
+        # the cumulative values because the query is faster
         for i in range(number_of_steps):
             self._g_steps[i] = g_per_step * (i + 1)
             self._b_steps[i] = b_per_step * (i + 1)

{GridCalEngine-5.0.13 → GridCalEngine-5.0.14}/GridCalEngine/Devices/Injections/load.py

@@ -28,7 +28,8 @@ class Load(LoadParent):
     Load
     """
 
-    def __init__(self, name='Load', idtag=None, code='', G=0.0, B=0.0, Ir=0.0, Ii=0.0, P=0.0, Q=0.0, Cost=1200.0,
+    def __init__(self, name='Load', idtag=None, code='',
+                 G=0.0, B=0.0, Ir=0.0, Ii=0.0, P=0.0, Q=0.0, Cost=1200.0,
                  active=True, mttf=0.0, mttr=0.0, capex=0, opex=0,
                  build_status: BuildStatus = BuildStatus.Commissioned):
         """

{GridCalEngine-5.0.13 → GridCalEngine-5.0.14}/GridCalEngine/Devices/Parents/branch_parent.py

@@ -15,17 +15,15 @@
 # along with this program; if not, write to the Free Software Foundation,
 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
-
-import pandas as pd
 import numpy as np
 from typing import Tuple, Union
-from matplotlib import pyplot as plt
 
 from GridCalEngine.basic_structures import Logger
 from GridCalEngine.Devices.Substation.bus import Bus
 from GridCalEngine.Devices.Substation.connectivity_node import ConnectivityNode
 from GridCalEngine.enumerations import BuildStatus
 from GridCalEngine.Devices.Parents.editable_device import EditableDevice, DeviceType
+from GridCalEngine.Devices.Aggregation.branch_group import BranchGroup
 from GridCalEngine.Devices.profile import Profile
 
 
@@ -127,7 +125,7 @@ class BranchParent(EditableDevice):
         self._protection_rating_factor_prof = Profile(default_value=protection_rating_factor)
 
         # List of measurements
-        self.measurements = list()
+        self.group: Union[BranchGroup, None] = None
 
         self.register('bus_from', units="", tpe=DeviceType.BusDevice,
                       definition='Name of the bus at the "from" side', editable=False)
@@ -163,6 +161,8 @@ class BranchParent(EditableDevice):
                       definition="Branch build status. Used in expansion planning.")
         self.register('capex', units="e/MW", tpe=float, definition="Cost of investment. Used in expansion planning.")
         self.register('opex', units="e/MWh", tpe=float, definition="Cost of operation. Used in expansion planning.")
+        self.register('group', units="", tpe=DeviceType.BranchGroupDevice,
+                      definition="Group where this branch belongs")
 
     @property
     def bus_from_prof(self) -> Profile:

GridCalEngine-5.0.14/GridCalEngine/Devices/Substation/substation.py

@@ -0,0 +1,87 @@
+# 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 typing import Union
+from GridCalEngine.Devices.Parents.editable_device import DeviceType
+from GridCalEngine.Devices.Aggregation.area import GenericAreaGroup, Area
+from GridCalEngine.Devices.Aggregation.zone import Zone
+from GridCalEngine.Devices.Aggregation.country import Country
+from GridCalEngine.Devices.Aggregation.community import Community
+from GridCalEngine.Devices.Aggregation.region import Region
+from GridCalEngine.Devices.Aggregation.municipality import Municipality
+
+
+class Substation(GenericAreaGroup):
+
+    def __init__(self, name='Substation', idtag: Union[str, None] = None, code='', latitude=0.0, longitude=0.0,
+                 area: Union[Area, None] = None,
+                 zone: Union[Zone, None] = None,
+                 country: Union[Country, None] = None,
+                 community: Union[Community, None] = None,
+                 region: Union[Region, None] = None,
+                 municipality: Union[Municipality, None] = None,
+                 address: str = ""):
+        """
+
+        :param name:
+        :param idtag:
+        :param code:
+        :param latitude:
+        :param longitude:
+        :param area:
+        :param zone:
+        :param country:
+        :param community:
+        :param region:
+        :param municipality:
+        :param address:
+        """
+        GenericAreaGroup.__init__(self,
+                                  name=name,
+                                  idtag=idtag,
+                                  code=code,
+                                  device_type=DeviceType.SubstationDevice,
+                                  latitude=latitude,
+                                  longitude=longitude)
+
+        self.area: Union[Area, None] = area
+        self.zone: Union[Zone, None] = zone
+        self.country: Union[Country, None] = country
+        self.community: Union[Community, None] = community
+        self.region: Union[Region, None] = region
+        self.municipality: Union[Municipality, None] = municipality
+        self.address: str = address
+
+        self.register(key="area", units="", tpe=DeviceType.AreaDevice,
+                      definition="Substation area, altenativelly this can be obtained from the zone")
+
+        self.register(key="zone", units="", tpe=DeviceType.ZoneDevice,
+                      definition="Substation area")
+
+        self.register(key="country", units="", tpe=DeviceType.CountryDevice,
+                      definition="Substation country, altenativelly this can be obtained from the community")
+
+        self.register(key="community", units="", tpe=DeviceType.CommunityDevice,
+                      definition="Substation community, altenativelly this can be obtained from the region")
+
+        self.register(key="region", units="", tpe=DeviceType.RegionDevice,
+                      definition="Substation region, altenativelly this can be obtained from the municipality")
+
+        self.register(key="municipality", units="", tpe=DeviceType.MunicipalityDevice,
+                      definition="Substation municipality")
+
+        self.register(key="address", units="", tpe=str, definition="Substation address")