GridCalEngine 5.3.41__tar.gz → 5.3.43__tar.gz

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Compilers/circuit_to_gslv.py

@@ -572,7 +572,7 @@ def convert_investment(
                          device_idtag=elm.device_idtag,
                          group=groups_dict[elm.group],
                          CAPEX=elm.CAPEX,
-                         OPEX=elm.OPEX,
+                         OPEX=0.0,
                          status=elm.status, )
 
 
@@ -2381,14 +2381,14 @@ def translate_gslv_pf_results(grid: MultiCircuit, res: "pg.PowerFlowResults", lo
     """
     results = PowerFlowResults(
         n=grid.get_bus_number(),
-        m=grid.get_branch_number_wo_hvdc(),
+        m=grid.get_branch_number(add_switch=True, add_vsc=False, add_hvdc=False),
         n_hvdc=grid.get_hvdc_number(),
         n_vsc=grid.get_vsc_number(),
         n_gen=grid.get_generators_number(),
         n_batt=grid.get_batteries_number(),
         n_sh=grid.get_shunt_like_device_number(),
         bus_names=grid.get_bus_names(),
-        branch_names=grid.get_branch_names(add_switch=True),
+        branch_names=grid.get_branch_names(add_switch=True, add_vsc=False, add_hvdc=False),
         hvdc_names=grid.get_hvdc_names(),
         vsc_names=grid.get_vsc_names(),
         gen_names=grid.get_generator_names(),

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Devices/Aggregation/area.py

@@ -32,7 +32,8 @@ class GenericAreaGroup(EditableDevice):
 
         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')
+        self.register(key='color', units='', tpe=str, definition='Color to paint the element in the map diagram',
+                      is_color=True)
 
 
 class Area(GenericAreaGroup):

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Devices/Aggregation/contingency.py

@@ -4,26 +4,29 @@
 # SPDX-License-Identifier: MPL-2.0
 
 from typing import Union
-from GridCalEngine.Devices.Parents.editable_device import EditableDevice, DeviceType
+from GridCalEngine.Devices.Parents.editable_device import EditableDevice
+from GridCalEngine.Devices.Parents.pointer_device_parent import PointerDeviceParent
+from GridCalEngine.enumerations import ContingencyOperationTypes, DeviceType
 from GridCalEngine.Devices.Aggregation.contingency_group import ContingencyGroup
-from GridCalEngine.enumerations import ContingencyOperationTypes
 
 
-class Contingency(EditableDevice):
+class Contingency(PointerDeviceParent):
     """
     The Contingency object
     """
 
     def __init__(self,
+                 device: EditableDevice | None = None,
                  idtag: Union[str, None] = None,
-                 device_idtag='',
                  name="Contingency",
                  code='',
                  prop: ContingencyOperationTypes = ContingencyOperationTypes.Active,
                  value=0.0,
-                 group: Union[None, ContingencyGroup] = None):
+                 group: Union[None, ContingencyGroup] = None,
+                 comment: str = ""):
         """
         Contingency
+        :param device: Some device to point at
         :param idtag: String. Element unique identifier
         :param name: String. Contingency name
         :param code: String. Contingency code name
@@ -32,19 +35,19 @@ class Contingency(EditableDevice):
         :param group: ContingencyGroup. Contingency group
         """
 
-        EditableDevice.__init__(self,
-                                idtag=idtag,
-                                code=code,
-                                name=name,
-                                device_type=DeviceType.ContingencyDevice)
+        PointerDeviceParent.__init__(self,
+                                     idtag=idtag,
+                                     device=device,
+                                     code=code,
+                                     name=name,
+                                     device_type=DeviceType.ContingencyDevice,
+                                     comment=comment)
 
         # Contingency type
-        self.device_idtag = device_idtag
         self._prop: ContingencyOperationTypes = prop
         self._value = value
         self._group: ContingencyGroup = group
 
-        self.register(key='device_idtag', units='', tpe=str, definition='Unique ID', editable=False)
         self.register(key='prop', units='', tpe=ContingencyOperationTypes,
                       definition=f'Object property to change')
         self.register(key='value', units='', tpe=float, definition='Property value')

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Devices/Aggregation/investment.py

@@ -4,57 +4,54 @@
 # SPDX-License-Identifier: MPL-2.0
 
 from typing import Union
-from GridCalEngine.Devices.Parents.editable_device import EditableDevice, DeviceType
+
+from GridCalEngine.Devices.Parents.editable_device import EditableDevice
+from GridCalEngine.Devices.Parents.pointer_device_parent import PointerDeviceParent
 from GridCalEngine.Devices.Aggregation.investments_group import InvestmentsGroup
+from GridCalEngine.enumerations import DeviceType
 
 
-class Investment(EditableDevice):
+class Investment(PointerDeviceParent):
     """
     Investment
     """
 
     def __init__(self,
+                 device: EditableDevice | None = None,
                  idtag: Union[str, None] = None,
-                 device_idtag: Union[str, None] = None,
                  name="Investment",
                  code='',
                  CAPEX: float = 0.0,
-                 OPEX: float = 0.0,
                  status: bool = True,
                  group: InvestmentsGroup = None,
                  comment: str = ""):
         """
         Investment
+        :param device: Some device to point at
         :param idtag: String. Element unique identifier
         :param name: String. Contingency name
         :param code: String. Contingency code name
         :param CAPEX: Float. Capital expenditures
-        :param OPEX: Float. Operating expenditures
         :param status: If true the investment activates when applied, otherwise is deactivated
         :param group: InvestmentGroup. Investment group
         :param comment: Comment
         """
 
-        EditableDevice.__init__(self,
-                                idtag=idtag,
-                                code=code,
-                                name=name,
-                                device_type=DeviceType.InvestmentDevice,
-                                comment=comment)
+        PointerDeviceParent.__init__(self,
+                                     idtag=idtag,
+                                     device=device,
+                                     code=code,
+                                     name=name,
+                                     device_type=DeviceType.InvestmentDevice,
+                                     comment=comment)
 
-        # Contingency type
-        self.device_idtag: str = device_idtag
         self.CAPEX: float = CAPEX
-        # self.OPEX: float = OPEX
         self._group: InvestmentsGroup = group
         self.status: bool = status
 
-        self.register(key='device_idtag', units='', tpe=str, definition='Unique ID')
         self.register(key='CAPEX', units='M€', tpe=float,
                       definition='Capital expenditures. This is the investment value, '
                                  'it overrides the CAPEX value of the device if it exits.')
-        # self.register(key='OPEX', units='M€', tpe=float,
-        #               definition='Operation expenditures. Maintenance costs among other recurrent costs.')
         self.register(key='status', units='', tpe=bool,
                       definition='If true the investment activates when applied, otherwise is deactivated.')
         self.register(key='group', units='', tpe=DeviceType.InvestmentsGroupDevice, definition='Investment group')

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Devices/Aggregation/remedial_action.py

@@ -4,26 +4,29 @@
 # SPDX-License-Identifier: MPL-2.0
 
 from typing import Union
-from GridCalEngine.Devices.Parents.editable_device import EditableDevice, DeviceType
+from GridCalEngine.Devices.Parents.editable_device import EditableDevice
+from GridCalEngine.Devices.Parents.pointer_device_parent import PointerDeviceParent
 from GridCalEngine.Devices.Aggregation.remedial_action_group import RemedialActionGroup
-from GridCalEngine.enumerations import ContingencyOperationTypes
+from GridCalEngine.enumerations import ContingencyOperationTypes, DeviceType
 
 
-class RemedialAction(EditableDevice):
+class RemedialAction(PointerDeviceParent):
     """
     The RemedialAction object
     """
 
     def __init__(self,
+                 device: EditableDevice | None = None,
                  idtag: Union[str, None] = None,
-                 device_idtag='',
                  name="Remedial action",
                  code='',
                  prop: ContingencyOperationTypes = ContingencyOperationTypes.Active,
                  value=0.0,
-                 group: Union[None, RemedialActionGroup] = None):
+                 group: Union[None, RemedialActionGroup] = None,
+                 comment: str = ""):
         """
         RemedialAction
+        :param device: Some device to point at
         :param idtag: String. Element unique identifier
         :param name: String. Contingency name
         :param code: String. Contingency code name
@@ -32,19 +35,19 @@ class RemedialAction(EditableDevice):
         :param group: RemedialActionGroup. RemedialAction group
         """
 
-        EditableDevice.__init__(self,
-                                idtag=idtag,
-                                code=code,
-                                name=name,
-                                device_type=DeviceType.RemedialActionDevice)
+        PointerDeviceParent.__init__(self,
+                                     idtag=idtag,
+                                     device=device,
+                                     code=code,
+                                     name=name,
+                                     device_type=DeviceType.RemedialActionDevice,
+                                     comment=comment)
 
         # Contingency type
-        self.device_idtag = device_idtag
         self._prop: ContingencyOperationTypes = prop
         self._value = value
         self._group: RemedialActionGroup = group
 
-        self.register(key='device_idtag', units='', tpe=str, definition='Unique ID', editable=False)
         self.register(key='prop', units='', tpe=ContingencyOperationTypes,
                       definition=f'Object property to change')
         self.register(key='value', units='', tpe=float, definition='Property value')

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Devices/Associations/emission_gas.py

@@ -40,7 +40,7 @@ class EmissionGas(EditableDevice):
 
         self.register(key='cost', units='e/t', tpe=float, definition='Cost of emissions (e / ton)',
                       profile_name='cost_prof')
-        self.register(key='color', units='', tpe=str, definition='Color to paint')
+        self.register(key='color', units='', tpe=str, definition='Color to paint', is_color=True)
 
     @property
     def cost_prof(self) -> Profile:

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Devices/Associations/fuel.py

@@ -37,7 +37,7 @@ class Fuel(EditableDevice):
 
         self.register(key='cost', units='e/t', tpe=float, definition='Cost of fuel (e / ton)',
                       profile_name='cost_prof')
-        self.register(key='color', units='', tpe=str, definition='Color to paint')
+        self.register(key='color', units='', tpe=str, definition='Color to paint', is_color=True)
 
     @property
     def cost_prof(self) -> Profile:

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Devices/Associations/technology.py

@@ -36,4 +36,4 @@ class Technology(EditableDevice):
         self.register(key='name2', units='', tpe=str, definition='Name 2 of the technology')
         self.register(key='name3', units='', tpe=str, definition='Name 3 of the technology')
         self.register(key='name4', units='', tpe=str, definition='Name 4 of the technology')
-        self.register(key='color', units='', tpe=str, definition='Color to paint')
+        self.register(key='color', units='', tpe=str, definition='Color to paint', is_color=True)

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Devices/Fluid/fluid_node.py

@@ -97,7 +97,8 @@ class FluidNode(PhysicalDevice):
                       definition='Flow of fluid coming from the rain',
                       profile_name='inflow_prof')
 
-        self.register(key='color', units='', tpe=str, definition='Color to paint the device in the map diagram')
+        self.register(key='color', units='', tpe=str, definition='Color to paint the device in the map diagram',
+                      is_color=True)
 
     @property
     def spillage_cost_prof(self) -> Profile:

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Devices/Fluid/fluid_path.py

@@ -58,7 +58,8 @@ class FluidPath(PhysicalDevice):
         self.register(key='min_flow', units="m3/s", tpe=float, definition="Minimum flow")
         self.register(key='max_flow', units="m3/s", tpe=float, definition="Maximum flow")
         self.register(key='locations', units='', tpe=SubObjectType.LineLocations, definition='Locations', editable=False)
-        self.register(key='color', units='', tpe=str, definition='Color to paint the device in the map diagram')
+        self.register(key='color', units='', tpe=str, definition='Color to paint the device in the map diagram',
+                      is_color=True)
 
     def copy(self):
         """

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Devices/Parents/branch_parent.py

@@ -194,7 +194,8 @@ class BranchParent(PhysicalDevice):
 
         self.register('ysh', units="p.u.", tpe=SubObjectType.AdmittanceMatrix,
                       definition='Shunt admittance matrix of the branch', editable=False, display=False)
-        self.register(key='color', units='', tpe=str, definition='Color to paint the element in the map diagram')
+        self.register(key='color', units='', tpe=str, definition='Color to paint the element in the map diagram',
+                      is_color=True)
 
     @property
     def bus_from(self) -> Bus:

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Devices/Parents/editable_device.py

@@ -113,7 +113,9 @@ class GCProp:
                  profile_name: str = '',
                  display: bool = True,
                  editable: bool = True,
-                 old_names: List[str] = None):
+                 old_names: List[str] = None,
+                 is_color: bool = False,
+                 is_date: bool = False):
         """
         GridCal property
         :param prop_name:
@@ -123,6 +125,8 @@ class GCProp:
         :param profile_name: name of the associated profile property
         :param display: Display the property in the GUI
         :param editable: Is this editable?
+        :param is_color: Is this a color? i.e. the tpe is str, but it represents a color
+        :param is_date: Is this a date? i.e. the tpe is int but represents a date
         """
 
         self.name = prop_name
@@ -139,6 +143,10 @@ class GCProp:
 
         self.editable = editable
 
+        self.is_color = is_color
+
+        self.is_date = is_date
+
         self.old_names = old_names if old_names is not None else list()
 
         self.selected_to_merge = True  # only applicable if we want to apply the value of this property on merge
@@ -389,7 +397,9 @@ class EditableDevice:
                  profile_name: str = '',
                  display: bool = True,
                  editable: bool = True,
-                 old_names: List[str] = None):
+                 old_names: List[str] = None,
+                 is_color: bool = False,
+                 is_date: bool = False):
         """
         Register property
         The property must exist, and if provided, the profile_name property must exist too
@@ -412,7 +422,9 @@ class EditableDevice:
                       profile_name=profile_name,
                       display=display,
                       editable=editable,
-                      old_names=old_names)
+                      old_names=old_names,
+                      is_color=is_color,
+                      is_date=is_date)
 
         if key in self.registered_properties.keys():
             raise Exception(f"Property {key} already registered!")

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Devices/Parents/generator_parent.py

@@ -79,7 +79,7 @@ class GeneratorParent(InjectionParent):
 
         self.control_cn = control_cn
 
-        self.P = float(P)
+        self._P = float(P)
         self._P_prof = Profile(default_value=self.P, data_type=float)
 
         # Maximum dispatched power in MW
@@ -109,6 +109,25 @@ class GeneratorParent(InjectionParent):
                       definition='Is the unit available for SRAP participation?',
                       editable=True, profile_name="srap_enabled_prof")
 
+    @property
+    def P(self)->float:
+        """
+        Get the active power value
+        :return: float
+        """
+        return self._P
+
+    @P.setter
+    def P(self, val: float):
+        """
+        Set active power value
+        :param val: some float
+        """
+        try:
+            self._P = float(val)
+        except ValueError:
+            print("The value you're trying to set into P is not a float :(")
+
     @property
     def control_bus_prof(self) -> Profile:
         """

gridcalengine-5.3.43/GridCalEngine/Devices/Parents/physical_device.py

@@ -0,0 +1,108 @@
+# 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
+import datetime
+from typing import Union
+from GridCalEngine.Devices.Parents.editable_device import EditableDevice
+from GridCalEngine.Devices.Aggregation.modelling_authority import ModellingAuthority
+from GridCalEngine.enumerations import DeviceType
+
+
+class PhysicalDevice(EditableDevice):
+    """
+    Parent class for Injections, Branches, Buses and other physical devices
+    """
+
+    def __init__(self,
+                 name: str,
+                 idtag: Union[str, None],
+                 code: str,
+                 device_type: DeviceType):
+        """
+        PhysicalDevice
+        :param name: Name of the device
+        :param idtag: unique id of the device (if None or "" a new one is generated)
+        :param code: secondary code for compatibility
+        :param device_type: DeviceType
+        """
+
+        EditableDevice.__init__(self,
+                                name=name,
+                                idtag=idtag,
+                                code=code,
+                                device_type=device_type)
+
+        self.modelling_authority: Union[ModellingAuthority, None] = None
+
+        self._commissioned_date: int = 0
+        self._decommissioned_date: int = 0
+
+        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',
+                      is_date=True)
+        self.register(key='decommissioned_date', units='', tpe=int, definition='Decommissioned date of the asset',
+                      is_date=True)
+
+    @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)

gridcalengine-5.3.43/GridCalEngine/Devices/Parents/pointer_device_parent.py

@@ -0,0 +1,73 @@
+# 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 typing import Union
+from GridCalEngine.Devices.Parents.editable_device import EditableDevice
+from GridCalEngine.enumerations import DeviceType
+
+
+class PointerDeviceParent(EditableDevice):
+    """
+    Investment
+    """
+
+    def __init__(self,
+                 idtag: Union[str, None],
+                 device: EditableDevice,
+                 name: str,
+                 code: str,
+                 comment: str,
+                 device_type: DeviceType):
+        """
+        Investment
+        :param idtag: String. Element unique identifier
+        :param device: Device to point at
+        :param name: String. Contingency name
+        :param code: String. Contingency code name
+        :param comment: Comment
+        """
+
+        EditableDevice.__init__(self,
+                                idtag=idtag,
+                                code=code,
+                                name=name,
+                                device_type=device_type,
+                                comment=comment)
+
+        self._device_idtag: str = device.idtag if device is not None else ""
+        self._tpe: DeviceType = device.device_type if device is not None else DeviceType.NoDevice
+
+        self.register(key='device_idtag', units='', tpe=str, definition='Unique ID', editable=False)
+        self.register(key='tpe', units='', tpe=DeviceType, definition='Device type', editable=False)
+
+    @property
+    def device_idtag(self) -> str:
+        """
+        Group of investments
+        :return:
+        """
+        return self._device_idtag
+
+    @device_idtag.setter
+    def device_idtag(self, val: str):
+        if isinstance(val, str):
+            self._device_idtag = val
+        else:
+            raise ValueError(f"device_idtag must be a string not {val}")
+
+    @property
+    def tpe(self) -> DeviceType:
+        """
+        Display the group category
+        :return:
+        """
+        return self._tpe
+
+    @tpe.setter
+    def tpe(self, val: DeviceType):
+        if isinstance(val, DeviceType):
+            self._tpe = val
+        else:
+            raise ValueError(f"tpe must be a string not {val}")

{gridcalengine-5.3.41 → gridcalengine-5.3.43}/GridCalEngine/Devices/assets.py

@@ -8,7 +8,7 @@ import pandas as pd
 from typing import List, Dict, Tuple, Union, Any, Set, Generator
 import datetime as dateslib
 
-from GridCalEngine.basic_structures import IntVec, StrVec
+from GridCalEngine.basic_structures import IntVec, StrVec, Vec
 import GridCalEngine.Devices as dev
 from GridCalEngine.Devices.types import ALL_DEV_TYPES, BRANCH_TYPES, INJECTION_DEVICE_TYPES, FLUID_TYPES
 from GridCalEngine.Devices.Parents.editable_device import GCPROP_TYPES
@@ -401,6 +401,13 @@ class Assets:
         """
         self._time_profile = pd.to_datetime(arr, unit='s')
 
+    def get_time_deltas_in_hours(self) -> Vec:
+        """
+        Get the time increments in hours
+        :return: array of time deltas where the first delta is 1
+        """
+        return np.r_[1.0, np.diff(self.get_unix_time() / 3600)]
+
     def get_time_profile_as_list(self):
         """
         Get the profiles dictionary