VeraGridEngine 5.5.8__tar.gz → 5.5.11__tar.gz

{veragridengine-5.5.8 → veragridengine-5.5.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: VeraGridEngine
-Version: 5.5.8
+Version: 5.5.11
 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.8 → veragridengine-5.5.11}/VeraGridEngine/Devices/Branches/transformer3w.py

@@ -10,7 +10,7 @@ from VeraGridEngine.Devices.Parents.physical_device import PhysicalDevice
 from VeraGridEngine.Devices.Branches.winding import Winding
 from VeraGridEngine.Devices.Branches.transformer_type import get_impedances
 from VeraGridEngine.Devices.profile import Profile
-from VeraGridEngine.enumerations import DeviceType
+from VeraGridEngine.enumerations import DeviceType, BuildStatus
 from VeraGridEngine.Devices.Parents.editable_device import get_at
 
 
@@ -102,7 +102,8 @@ class Transformer3W(PhysicalDevice):
                  V1=10.0, V2=10.0, V3=10.0, active=True,
                  r12=0.0, r23=0.0, r31=0.0, x12=0.0, x23=0.0, x31=0.0,
                  rate12=0.0, rate23=0.0, rate31=0.0,
-                 x=0.0, y=0.0):
+                 x=0.0, y=0.0,
+                 build_status: BuildStatus = BuildStatus.Commissioned):
         """
         Constructor
         :param idtag: Unique identifier
@@ -132,7 +133,8 @@ class Transformer3W(PhysicalDevice):
                                 name=name,
                                 idtag=idtag,
                                 code=code,
-                                device_type=DeviceType.Transformer3WDevice)
+                                device_type=DeviceType.Transformer3WDevice,
+                                build_status=build_status)
 
         if bus0 is None:
             self.bus0 = Bus(name=name + '_bus', Vnom=1.0, xpos=x, ypos=y, is_internal=True)

{veragridengine-5.5.8 → veragridengine-5.5.11}/VeraGridEngine/Devices/Fluid/fluid_injection_template.py

@@ -44,7 +44,8 @@ class FluidInjectionTemplate(PhysicalDevice):
                                 name=name,
                                 idtag=idtag,
                                 code=code,
-                                device_type=device_type)
+                                device_type=device_type,
+                                build_status=build_status)
 
         self.active = True
         self._active_prof = Profile(default_value=self.active, data_type=bool)
@@ -53,7 +54,6 @@ class FluidInjectionTemplate(PhysicalDevice):
         self.max_flow_rate = float(max_flow_rate)  # m3/s
         self._plant: FluidNode = plant
         self._generator: Generator = generator
-        self.build_status = build_status
 
         self.facility: Facility | None = None
 
@@ -66,9 +66,6 @@ class FluidInjectionTemplate(PhysicalDevice):
                       editable=False)
         self.register(key='generator', units="", tpe=DeviceType.GeneratorDevice, definition="Electrical machine",
                       editable=False)
-        self.register(key='build_status', units='', tpe=BuildStatus,
-                      definition='Branch build status. Used in expansion planning.')
-
         self.register(key='facility', units='', tpe=DeviceType.FacilityDevice,
                       definition='Facility where this is located', editable=True)
 

{veragridengine-5.5.8 → veragridengine-5.5.11}/VeraGridEngine/Devices/Fluid/fluid_node.py

@@ -63,7 +63,8 @@ class FluidNode(PhysicalDevice):
                                 name=name,
                                 idtag=idtag,
                                 code=code,
-                                device_type=DeviceType.FluidNodeDevice)
+                                device_type=DeviceType.FluidNodeDevice,
+                                build_status=build_status)
 
         self.min_level = float(min_level)  # hm3
         self.max_level = float(max_level)  # hm3
@@ -73,7 +74,6 @@ class FluidNode(PhysicalDevice):
         self.spillage_cost = float(spillage_cost)  # m3/s
         self.inflow = float(inflow)  # m3/s
         self._bus: Bus | None = bus
-        self.build_status = build_status
 
         self.color = color if color is not None else "#00aad4"  # nice blue color
 
@@ -103,9 +103,6 @@ class FluidNode(PhysicalDevice):
         self.register(key='bus', units='', tpe=DeviceType.BusDevice,
                       definition='Electrical bus.', editable=False)
 
-        self.register(key='build_status', units='', tpe=BuildStatus,
-                      definition='Branch build status. Used in expansion planning.')
-
         self.register(key='spillage_cost', units='e/(m3/s)', tpe=float,
                       definition='Cost of nodal spillage',
                       profile_name='spillage_cost_prof')

{veragridengine-5.5.8 → veragridengine-5.5.11}/VeraGridEngine/Devices/Fluid/fluid_path.py

@@ -6,10 +6,9 @@ from __future__ import annotations
 import numpy as np
 from typing import Union, TYPE_CHECKING, Tuple
 from VeraGridEngine.Devices.Parents.physical_device import PhysicalDevice
-from VeraGridEngine.enumerations import DeviceType, SubObjectType
+from VeraGridEngine.enumerations import DeviceType, SubObjectType, BuildStatus
 from VeraGridEngine.Devices.Fluid.fluid_node import FluidNode
 from VeraGridEngine.Devices.Branches.line_locations import LineLocations
-from VeraGridEngine.basic_structures import Logger
 
 if TYPE_CHECKING:
     from VeraGridEngine.Devices.types import CONNECTION_TYPE
@@ -33,7 +32,8 @@ class FluidPath(PhysicalDevice):
                  target: FluidNode = None,
                  min_flow: float = 0.0,
                  max_flow: float = 0.0,
-                 color: str | None = None):
+                 color: str | None = None,
+                 build_status: BuildStatus = BuildStatus.Commissioned ):
         """
         Fluid path
         :param name:Name of the fluid transporter
@@ -49,7 +49,8 @@ class FluidPath(PhysicalDevice):
                                 name=name,
                                 idtag=idtag,
                                 code=code,
-                                device_type=DeviceType.FluidPathDevice)
+                                device_type=DeviceType.FluidPathDevice,
+                                build_status=build_status)
 
         self.source = source
         self.target = target

{veragridengine-5.5.8 → veragridengine-5.5.11}/VeraGridEngine/Devices/Parents/branch_parent.py

@@ -110,7 +110,8 @@ class BranchParent(PhysicalDevice):
                                 name=name,
                                 idtag=idtag,
                                 code=code,
-                                device_type=device_type)
+                                device_type=device_type,
+                                build_status=build_status)
 
         # connectivity
         if bus_from is None:
@@ -156,8 +157,6 @@ class BranchParent(PhysicalDevice):
 
         self.opex = opex
 
-        self.build_status = build_status
-
         # line rating in MVA
         if not isinstance(rate, Union[float, int]):
             raise ValueError("Rate must be a float")
@@ -211,8 +210,6 @@ class BranchParent(PhysicalDevice):
         self.register('Cost', units="e/MWh", tpe=float,
                       definition="Cost of overloads. Used in OPF", profile_name="Cost_prof")
 
-        self.register('build_status', units="", tpe=BuildStatus,
-                      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,

{veragridengine-5.5.8 → veragridengine-5.5.11}/VeraGridEngine/Devices/Parents/injection_parent.py

@@ -36,7 +36,6 @@ class InjectionParent(PhysicalDevice):
         '_Cost_prof',
         'capex',
         'opex',
-        'build_status',
         'facility',
         'technologies',
         'scalable',
@@ -86,7 +85,8 @@ class InjectionParent(PhysicalDevice):
                                 name=name,
                                 idtag=idtag,
                                 code=code,
-                                device_type=device_type)
+                                device_type=device_type,
+                                build_status=build_status)
 
         self._bus = bus
 
@@ -105,8 +105,6 @@ class InjectionParent(PhysicalDevice):
 
         self.opex = opex
 
-        self.build_status = build_status
-
         self.facility: Facility | None = None
 
         self.technologies: Associations = Associations(device_type=DeviceType.Technology)
@@ -138,9 +136,6 @@ class InjectionParent(PhysicalDevice):
                       definition='Cost of investment. Used in expansion planning.')
         self.register(key='opex', units='e/MWh', tpe=float, definition='Cost of operation. Used in expansion planning.')
 
-        self.register(key='build_status', units='', tpe=BuildStatus,
-                      definition='Branch build status. Used in expansion planning.')
-
         self.register(key='Cost', units='e/MWh', tpe=float, definition='Cost of not served energy. Used in OPF.',
                       profile_name='Cost_prof')
 

{veragridengine-5.5.8 → veragridengine-5.5.11}/VeraGridEngine/Devices/Parents/physical_device.py

@@ -2,11 +2,13 @@
 # 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 __future__ import annotations
+
 import datetime
 from typing import Union
 from VeraGridEngine.Devices.Parents.editable_device import EditableDevice
 from VeraGridEngine.Devices.Aggregation.modelling_authority import ModellingAuthority
-from VeraGridEngine.enumerations import DeviceType
+from VeraGridEngine.enumerations import DeviceType, BuildStatus
 
 
 class PhysicalDevice(EditableDevice):
@@ -16,14 +18,16 @@ class PhysicalDevice(EditableDevice):
     __slots__ = (
         "modelling_authority",
         "_commissioned_date",
-        "_decommissioned_date"
+        "_decommissioned_date",
+        'build_status'
     )
 
     def __init__(self,
                  name: str,
                  idtag: Union[str, None],
                  code: str,
-                 device_type: DeviceType):
+                 device_type: DeviceType,
+                 build_status: BuildStatus):
         """
         PhysicalDevice
         :param name: Name of the device
@@ -41,8 +45,11 @@ class PhysicalDevice(EditableDevice):
         self.modelling_authority: Union[ModellingAuthority, None] = None
 
         self._commissioned_date: int = 0
+
         self._decommissioned_date: int = 0
 
+        self.build_status = build_status
+
         self.register(key='modelling_authority', units='', tpe=DeviceType.ModellingAuthority,
                       definition='Modelling authority of this asset')
         self.register(key='commissioned_date', units='', tpe=int, definition='Commissioned date of the asset',
@@ -50,6 +57,9 @@ class PhysicalDevice(EditableDevice):
         self.register(key='decommissioned_date', units='', tpe=int, definition='Decommissioned date of the asset',
                       is_date=True)
 
+        self.register('build_status', units="", tpe=BuildStatus,
+                      definition="Device build status. Used in expansion planning.")
+
     @property
     def commissioned_date(self) -> int:
         """

{veragridengine-5.5.8 → veragridengine-5.5.11}/VeraGridEngine/Devices/Substation/bus.py

@@ -8,7 +8,7 @@ from typing import Tuple, Union
 import numpy as np
 import pandas as pd
 from matplotlib import pyplot as plt
-from VeraGridEngine.enumerations import BusMode, DeviceType, BusGraphicType, SubObjectType
+from VeraGridEngine.enumerations import BusMode, DeviceType, BusGraphicType, SubObjectType, BuildStatus
 from VeraGridEngine.Devices.Parents.physical_device import PhysicalDevice
 from VeraGridEngine.Devices.Aggregation import Area, Zone, Country
 from VeraGridEngine.Devices.Substation.substation import Substation
@@ -92,7 +92,8 @@ class Bus(PhysicalDevice):
                  Vm0=1,
                  Va0=0,
                  graphic_type: BusGraphicType = BusGraphicType.BusBar,
-                 bus_bar: BusBar | None = None):
+                 bus_bar: BusBar | None = None,
+                 build_status: BuildStatus = BuildStatus.Commissioned):
         """
         The Bus object is the container of all the possible devices that can be attached to
         a bus bar or Substation. Such objects can be loads, voltage controlled generators,
@@ -132,7 +133,8 @@ class Bus(PhysicalDevice):
                                 name=name,
                                 idtag=idtag,
                                 code=code,
-                                device_type=DeviceType.BusDevice)
+                                device_type=DeviceType.BusDevice,
+                                build_status=build_status)
 
         self.active = bool(active)
         self._active_prof = Profile(default_value=self.active, data_type=bool)

{veragridengine-5.5.8 → veragridengine-5.5.11}/VeraGridEngine/Devices/Substation/busbar.py

@@ -2,9 +2,10 @@
 # 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 __future__ import annotations
 
 from typing import Union
-from VeraGridEngine.enumerations import DeviceType
+from VeraGridEngine.enumerations import DeviceType, BuildStatus
 from VeraGridEngine.Devices.Parents.physical_device import PhysicalDevice
 from VeraGridEngine.Devices.Substation.voltage_level import VoltageLevel
 
@@ -18,7 +19,8 @@ class BusBar(PhysicalDevice):
                  name='BusBar',
                  idtag: Union[None, str] = None,
                  code: str = '',
-                 voltage_level: VoltageLevel | None = None) -> None:
+                 voltage_level: VoltageLevel | None = None,
+                 build_status: BuildStatus = BuildStatus.Commissioned) -> None:
         """
         Constructor
         :param name: Name of the bus bar
@@ -30,7 +32,8 @@ class BusBar(PhysicalDevice):
                                 name=name,
                                 code=code,
                                 idtag=idtag,
-                                device_type=DeviceType.BusBarDevice)
+                                device_type=DeviceType.BusBarDevice,
+                                build_status=build_status)
 
         self._voltage_level: VoltageLevel | None = voltage_level
         self.register(key="voltage_level", tpe=DeviceType.BusDevice,

{veragridengine-5.5.8 → veragridengine-5.5.11}/VeraGridEngine/Devices/Substation/substation.py

@@ -2,22 +2,24 @@
 # 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 __future__ import annotations
 
 from typing import Union
+import datetime
 import numpy as np
-from VeraGridEngine.Devices.Parents.editable_device import DeviceType
-from VeraGridEngine.Devices.Aggregation.area import GenericAreaGroup, Area
+from VeraGridEngine.Devices.Parents.physical_device import PhysicalDevice
+from VeraGridEngine.Devices.Aggregation.area import Area
 from VeraGridEngine.Devices.Aggregation.zone import Zone
 from VeraGridEngine.Devices.Aggregation.country import Country
 from VeraGridEngine.Devices.Aggregation.community import Community
 from VeraGridEngine.Devices.Aggregation.region import Region
 from VeraGridEngine.Devices.Aggregation.municipality import Municipality
-from VeraGridEngine.Devices.Aggregation.modelling_authority import ModellingAuthority
 from VeraGridEngine.Devices.profile import Profile
 from VeraGridEngine.Devices.Parents.editable_device import get_at
+from VeraGridEngine.enumerations import BuildStatus, DeviceType
 
 
-class Substation(GenericAreaGroup):
+class Substation(PhysicalDevice):
     __slots__ = (
         '_area',
         '_zone',
@@ -34,6 +36,9 @@ class Substation(GenericAreaGroup):
         '_wind_speed_prof',
         'terrain_roughness',
         'modelling_authority',
+        'latitude',
+        'longitude',
+        'color',
     )
 
     def __init__(self,
@@ -53,7 +58,8 @@ class Substation(GenericAreaGroup):
                  temperature: float = 0.0,
                  wind_speed: float = 0.0,
                  terrain_roughness: float = 0.20,
-                 color: Union[str, None] = "#3d7d95"):
+                 color: Union[str, None] = "#3d7d95",
+                 build_status: BuildStatus = BuildStatus.Commissioned):
         """
 
         :param name:
@@ -74,14 +80,12 @@ class Substation(GenericAreaGroup):
         :param terrain_roughness:
         :param color: hexadecimal color string (i.e. #AA00FF)
         """
-        GenericAreaGroup.__init__(self,
-                                  name=name,
-                                  idtag=idtag,
-                                  code=code,
-                                  device_type=DeviceType.SubstationDevice,
-                                  latitude=latitude,
-                                  longitude=longitude,
-                                  color=color, )
+        PhysicalDevice.__init__(self,
+                                name=name,
+                                code=code,
+                                idtag=idtag,
+                                device_type=DeviceType.SubstationDevice,
+                                build_status=build_status)
 
         self._area: Union[Area, None] = area
         self._zone: Union[Zone, None] = zone
@@ -102,7 +106,15 @@ class Substation(GenericAreaGroup):
 
         self.terrain_roughness: float = float(terrain_roughness)
 
-        self.modelling_authority: Union[ModellingAuthority, None] = None
+        self.latitude = float(latitude)
+        self.longitude = float(longitude)
+
+        self.color = color if color is not None else self.rnd_color()
+
+        self.register(key='longitude', units='deg', tpe=float, definition='longitude.', profile_name='')
+        self.register(key='latitude', units='deg', tpe=float, definition='latitude.', profile_name='')
+        self.register(key='color', units='', tpe=str, definition='Color to paint the element in the map diagram',
+                      is_color=True)
 
         self.register(key="area", units="", tpe=DeviceType.AreaDevice,
                       definition="Substation area, altenativelly this can be obtained from the zone")
@@ -122,9 +134,6 @@ class Substation(GenericAreaGroup):
         self.register(key="municipality", units="", tpe=DeviceType.MunicipalityDevice,
                       definition="Substation municipality")
 
-        self.register(key='modelling_authority', units='', tpe=DeviceType.ModellingAuthority,
-                      definition='Modelling authority of this asset')
-
         self.register(key="address", units="", tpe=str,
                       definition="Substation address")
 
@@ -148,6 +157,7 @@ class Substation(GenericAreaGroup):
                                  "Rough (forest, small houses): 1.0~1.5\n"
                                  "Very rough (Large buildings):1.0~4.0")
 
+
     @property
     def area(self) -> Union[Area, None]:
         """
@@ -353,3 +363,65 @@ class Substation(GenericAreaGroup):
         :return:
         """
         return get_at(self.wind_speed, self.wind_speed_prof, t)
+
+    @property
+    def commissioned_date(self) -> int:
+        """
+
+        :return:
+        """
+        return self._commissioned_date
+
+    @commissioned_date.setter
+    def commissioned_date(self, val: int | datetime.datetime):
+        if isinstance(val, int):
+            self._commissioned_date = val
+        elif isinstance(val, datetime.datetime):
+            self._commissioned_date = val.timestamp()
+
+    def set_commissioned_year(self, year: int, month=1, day=1):
+        """
+        Helper function to set the commissioning date of the asset
+        :param year: Year
+        :param month: month number
+        :param day: day number
+        """
+        self.commissioned_date = datetime.datetime(year=year, month=month, day=day).timestamp()
+
+    def get_commissioned_date_as_date(self) -> datetime.datetime:
+        """
+        Get the commissioned date as datetime
+        :return:
+        """
+        return datetime.datetime.fromtimestamp(self._commissioned_date)
+
+    @property
+    def decommissioned_date(self) -> int:
+        """
+
+        :return:
+        """
+        return self._decommissioned_date
+
+    @decommissioned_date.setter
+    def decommissioned_date(self, val: int | datetime.datetime):
+        if isinstance(val, int):
+            self._decommissioned_date = val
+        elif isinstance(val, datetime.datetime):
+            self._decommissioned_date = val.timestamp()
+
+    def set_decommissioned_year(self, year: int, month=1, day=1):
+        """
+        Helper function to set the decommissioning date of the asset
+        :param year: Year
+        :param month: month number
+        :param day: day number
+        """
+        self.decommissioned_date = datetime.datetime(year=year, month=month, day=day).timestamp()
+
+    def get_decommissioned_date_as_date(self) -> datetime.datetime:
+        """
+        Get the commissioned date as datetime
+        :return:
+        """
+        return datetime.datetime.fromtimestamp(self._decommissioned_date)

{veragridengine-5.5.8 → veragridengine-5.5.11}/VeraGridEngine/Devices/Substation/voltage_level.py

@@ -4,7 +4,7 @@
 # SPDX-License-Identifier: MPL-2.0
 
 from typing import Union
-from VeraGridEngine.enumerations import DeviceType
+from VeraGridEngine.enumerations import DeviceType, BuildStatus
 from VeraGridEngine.Devices.Parents.physical_device import PhysicalDevice
 from VeraGridEngine.Devices.Substation.substation import Substation
 
@@ -19,7 +19,8 @@ class VoltageLevel(PhysicalDevice):
                  idtag: Union[str, None] = None,
                  code: str = '',
                  Vnom: float = 1.0,
-                 substation: Union[None, Substation] = None):
+                 substation: Union[None, Substation] = None,
+                 build_status: BuildStatus = BuildStatus.Commissioned):
         """
         Constructor
         :param name: Name
@@ -32,7 +33,8 @@ class VoltageLevel(PhysicalDevice):
                                 name=name,
                                 code=code,
                                 idtag=idtag,
-                                device_type=DeviceType.VoltageLevelDevice)
+                                device_type=DeviceType.VoltageLevelDevice,
+                                build_status=build_status)
 
         self.Vnom = float(Vnom)
 

{veragridengine-5.5.8 → veragridengine-5.5.11}/VeraGridEngine/Devices/assets.py

@@ -5,7 +5,7 @@
 import warnings
 import numpy as np
 import pandas as pd
-from typing import List, Dict, Tuple, Union, Any, Set, Generator
+from typing import List, Dict, Tuple, Union, Any, Set, Generator, Sequence
 import datetime as dateslib
 
 from VeraGridEngine.Devices.Dynamic.events import RmsEvent
@@ -1411,6 +1411,53 @@ class Assets:
         except ValueError:
             print(f"Could not delete {obj.name}")
 
+    def delete_buses(self, lst: Sequence[dev.Bus], delete_associated=False):
+        """
+        Delete a :ref:`Bus<bus>` object from the grid.
+        :param lst: Array of objects to remove
+        :param delete_associated: Delete the associated branches and injections
+        """
+        buses_to_remove = set(lst)
+
+        branches_to_delete = list()
+        injections_to_delete = list()
+
+        # delete associated Branches in reverse order
+        for branch_list in self.get_branch_lists(add_vsc=True, add_hvdc=True, add_switch=True):
+            for i in range(len(branch_list) - 1, -1, -1):
+                if branch_list[i].bus_from in buses_to_remove:
+                    if delete_associated:
+                        branches_to_delete.append(branch_list[i])
+                    else:
+                        branch_list[i].bus_from = None
+                elif branch_list[i].bus_to in buses_to_remove:
+                    if delete_associated:
+                        branches_to_delete.append(branch_list[i])
+                    else:
+                        branch_list[i].bus_to = None
+
+        for elm in branches_to_delete:
+            self.delete_branch(obj=elm)
+
+        # delete the associated injection devices
+        for inj_list in self.get_injection_devices_lists():
+            for i in range(len(inj_list) - 1, -1, -1):
+                if inj_list[i].bus in buses_to_remove:
+                    if delete_associated:
+                        injections_to_delete.append(inj_list[i])
+                    else:
+                        inj_list[i].bus = None
+
+        for elm in injections_to_delete:
+            self.delete_injection_device(obj=elm)
+
+        # delete the bus itself
+        for elm in buses_to_remove:
+            try:
+                self._buses.remove(elm)
+            except ValueError:
+                print(f"Could not delete {elm.name}")
+
     def get_buses_by(self, filter_elements: List[Union[dev.Area, dev.Country, dev.Zone]]) -> List[dev.Bus]:
         """
         Get a list of buses that can be found in the list of Areas | Zones | Countries