GridCalEngine 5.3.34__tar.gz → 5.3.36__tar.gz

{gridcalengine-5.3.34 → gridcalengine-5.3.36}/GridCalEngine/Compilers/circuit_to_data.py

@@ -69,7 +69,7 @@ def set_bus_control_voltage(i: int,
     """
     if bus_data.bus_types[i] != BusMode.Slack_tpe.value:  # if it is not Slack
         if remote_control and j > -1 and j != i:
-            # remove voltage control
+            # delete voltage control
             # bus_data.bus_types[j] = BusMode.PQV_tpe.value  # remote bus to PQV type
             bus_data.set_bus_mode(j, BusMode.PQV_tpe)
             # bus_data.bus_types[i] = BusMode.P_tpe.value  # local bus to P type
@@ -120,7 +120,7 @@ def set_bus_control_voltage_vsc(i: int,
     """
     if bus_data.bus_types[i] != BusMode.Slack_tpe.value:  # if it is not Slack
         if remote_control and j > -1 and j != i:
-            # remove voltage control
+            # delete voltage control
             # bus_data.bus_types[j] = BusMode.PQV_tpe.value  # remote bus to PQV type
             # bus_data.set_bus_mode(j, BusMode.PQV_tpe)
             bus_data.is_p_controlled[j] = True

{gridcalengine-5.3.34 → gridcalengine-5.3.36}/GridCalEngine/DataStructures/passive_branch_data.py

@@ -45,8 +45,6 @@ class PassiveBranchData(BranchParentData):
         self.m_taps = SparseObjectArray(n=self.nelm)
         self.tau_taps = SparseObjectArray(n=self.nelm)
 
-        self.k: Vec = np.ones(nelm, dtype=float)
-
         self.virtual_tap_t: Vec = np.ones(self.nelm, dtype=float)
         self.virtual_tap_f: Vec = np.ones(self.nelm, dtype=float)
 
@@ -92,8 +90,6 @@ class PassiveBranchData(BranchParentData):
         data.m_taps = self.m_taps.slice(elm_idx)
         data.tau_taps = self.tau_taps.slice(elm_idx)
 
-        data.k = self.k[elm_idx]
-
         data.virtual_tap_f = self.virtual_tap_f[elm_idx]
         data.virtual_tap_t = self.virtual_tap_t[elm_idx]
 
@@ -125,7 +121,6 @@ class PassiveBranchData(BranchParentData):
         data.conn = self.conn.copy()  # winding connection
         data.m_taps = self.m_taps.copy()
         data.tau_taps = self.tau_taps.copy()
-        data.k = self.k.copy()
 
         data.virtual_tap_f = self.virtual_tap_f.copy()
         data.virtual_tap_t = self.virtual_tap_t.copy()

{gridcalengine-5.3.34 → gridcalengine-5.3.36}/GridCalEngine/Devices/Branches/line.py

@@ -195,7 +195,8 @@ class Line(BranchParent):
                                  'for transformers0% for lines.')
 
         self.register(key='circuit_idx', units='', tpe=int,
-                      definition='Circuit index, used for multiple circuits sharing towers (starts at zero)')
+                      definition='Circuit index, used for multiple circuits sharing towers (starts at zero)',
+                      editable=False)
 
         self.register(key='length', units='km', tpe=float, definition='Length of the line (not used for calculation)')
         self.register(key='temp_base', units='ºC', tpe=float, definition='Base temperature at which R was measured.')
@@ -307,9 +308,31 @@ class Line(BranchParent):
 
     @circuit_idx.setter
     def circuit_idx(self, value):
-        if value >= 0:
+        if value > 0:
             self._circuit_idx = int(value)
 
+            if self.auto_update_enabled:
+                print("No impedance updates are being done, use the apply_template method to update the impedance values")
+
+
+    def set_circuit_idx(self, val: int, obj: Union[OverheadLineType, UndergroundLineType, SequenceLineType]):
+        """
+        Set the circuit_idx with additional behavior based on the is_user_action flag. Ensure that the template exists and is valid.
+        :param value: The value to set
+        """
+        # If the user is setting the circuit index, ensure that the template exists and is valid
+        if obj is None:
+            raise Exception("Template must be set before changing the circuit index.")
+        if not isinstance(obj, (OverheadLineType, UndergroundLineType, SequenceLineType)):
+            raise Exception("Invalid template type. Must be OverheadLineType, UndergroundLineType, or SequenceLineType.")
+        if val >= obj.n_circuits:
+            raise Exception("Circuit index exceeds the number of circuits in the template.")
+        if val <= 0:
+            raise Exception("Circuit index must be greater than 0.")
+        else:
+            if val > 0:
+                self._circuit_idx = int(val)
+
     @property
     def length(self) -> float:
         """

{gridcalengine-5.3.34 → gridcalengine-5.3.36}/GridCalEngine/Devices/Branches/overhead_line_type.py

@@ -59,7 +59,7 @@ class WireInTower:
 
         self._phase: int = phase
 
-        self.circuit_index: int = 0
+        self.circuit_index: int = 1
 
         self.phase_type: str = ""
 
@@ -94,7 +94,7 @@ class WireInTower:
         if phase == 0:
             self._phase = phase
             self.phase_type = "N"
-            self.circuit_index = 0
+            self.circuit_index = 1
 
         elif (phase - 1) % 3 == 0:
             self._phase = phase
@@ -345,7 +345,7 @@ class OverheadLineType(EditableDevice):
     def get_ys(self, circuit_idx: int, Sbase: float, length: float, Vnom: float):
         """
         get the series admittance matrix in p.u. (total)
-        :param circuit_idx: Circuit index (starting by 0)
+        :param circuit_idx: Circuit index (starting by 1)
         :param Sbase: Base power (MVA)
         :param length: Line length (km)
         :param Vnom: Nominal voltage (kV)
@@ -353,7 +353,7 @@ class OverheadLineType(EditableDevice):
         """
         Zbase = (Vnom * Vnom) / Sbase
 
-        k = (3 * circuit_idx) + np.array([0, 1, 2])
+        k = (3 * (circuit_idx - 1)) + np.array([0, 1, 2])
         z = self.z_abc[np.ix_(k, k)] * length / Zbase
         y = np.linalg.inv(z)
         return y
@@ -361,7 +361,7 @@ class OverheadLineType(EditableDevice):
     def get_ysh(self, circuit_idx: int, Sbase: float, length: float, Vnom: float):
         """
         get the shunt admittance matrix in p.u. (total)
-        :param circuit_idx: Circuit index (starting by 0)
+        :param circuit_idx: Circuit index (starting by 1)
         :param Sbase: Base power (MVA)
         :param length: Line length (km)
         :param Vnom: Nominal voltage (kV)
@@ -369,7 +369,7 @@ class OverheadLineType(EditableDevice):
         """
         Zbase = (Vnom * Vnom) / Sbase
         Ybase = 1 / Zbase
-        k = (3 * circuit_idx) + np.array([0, 1, 2])
+        k = (3 * (circuit_idx - 1)) + np.array([0, 1, 2])
         y = self.y_abc[np.ix_(k, k)] * length * -1e6 / Ybase
         return y
 
@@ -533,17 +533,17 @@ class OverheadLineType(EditableDevice):
     def get_sequence_values(self, circuit_idx: int, seq: int = 1):
         """
         Get the positive sequence values R1 [Ohm], X1[Ohm] and Bsh1 [S].
-        :param circuit_idx: Circuit indexation (starts at 0)
+        :param circuit_idx: Circuit indexation (starts at 1)
         :param seq: Sequence number (0, 1, 2)
         :return: R1 [Ohm], X1[Ohm] and Bsh1 [S]
         """
         self.compute()
         if self.z_seq is not None and self.y_seq is not None:
-            a1 = 3 * circuit_idx + seq
+            a1 = 3 * (circuit_idx - 1) + seq
             R1 = self.z_seq[a1, a1].real
             X1 = self.z_seq[a1, a1].imag
             Bsh1 = self.y_seq[a1, a1].imag * 1e6
-            I_kA = self.Imax[circuit_idx]
+            I_kA = self.Imax[circuit_idx - 1]
             return R1, X1, Bsh1, I_kA
         else:
             warn(f"{self.name} tower is incorrect :(")
@@ -564,12 +564,12 @@ class OverheadLineType(EditableDevice):
         Zbase = (Vn * Vn) / Sbase
         Ybase = 1 / Zbase
 
-        a0 = 3 * circuit_index
+        a0 = 3 * (circuit_index - 1)
         R0 = self.z_seq[a0, a0].real
         X0 = self.z_seq[a0, a0].imag
         Bsh0 = self.y_seq[a0, a0].imag * 1e6
 
-        a1 = 3 * circuit_index + 1
+        a1 = 3 * (circuit_index - 1) + 1
         R1 = self.z_seq[a1, a1].real
         X1 = self.z_seq[a1, a1].imag
         Bsh1 = self.y_seq[a1, a1].imag * 1e6
@@ -602,7 +602,7 @@ class OverheadLineType(EditableDevice):
         y2 = 1j * Bsh0 * length * 1e-6 / Ybase
 
         # get the rating in MVA = kA * kV
-        rate = self.Imax[circuit_index] * Vn * np.sqrt(3)
+        rate = self.Imax[circuit_index - 1] * Vn * np.sqrt(3)
 
         return R1, X1, B1, R0, X0, B0, rate
 
@@ -674,7 +674,7 @@ def kron_reduction(mat, keep, embed):
     Perform the Kron reduction
     :param mat: primitive matrix
     :param keep: indices to keep
-    :param embed: indices to remove / embed
+    :param embed: indices to delete / embed
     :return:
     """
     Zaa = mat[np.ix_(keep, keep)]
@@ -700,7 +700,7 @@ def wire_bundling(phases_set: List[int], primitive: Mat, phases_vector: IntVec):
 
         if len(wires_indices) > 1:
 
-            # get the first wire and remove it from the wires list
+            # get the first wire and delete it from the wires list
             i = wires_indices[0]
 
             # wires to keep

{gridcalengine-5.3.34 → gridcalengine-5.3.36}/GridCalEngine/Devices/Branches/vsc.py

@@ -32,7 +32,6 @@ class VSC(BranchParent):
                  active=True,
                  rate=1e-9,
                  kdp=-0.05,
-                 k=1.0,
                  alpha1=0.0001,
                  alpha2=0.015,
                  alpha3=0.2,

{gridcalengine-5.3.34 → gridcalengine-5.3.36}/GridCalEngine/Devices/Diagrams/base_diagram.py

@@ -160,6 +160,7 @@ class BaseDiagram:
         self._min_bus_width: float = min_bus_width
         self._max_bus_width: float = max_bus_width
         self._arrow_size: float = arrow_size
+        self._use_api_colors: bool = False
 
         self._palette = palette
         self._default_bus_voltage: float = default_bus_voltage
@@ -267,6 +268,14 @@ class BaseDiagram:
     def default_bus_voltage(self, value: float):
         self._default_bus_voltage = value
 
+    @property
+    def use_api_colors(self) -> bool:
+        return self._use_api_colors
+
+    @use_api_colors.setter
+    def use_api_colors(self, value: bool):
+        self._use_api_colors = value
+
     def set_point(self, device: ALL_DEV_TYPES, location: Union[GraphicLocation, MapLocation]):
         """
 
@@ -286,7 +295,7 @@ class BaseDiagram:
             group.set_point(device, location)
             self.data[str(device.device_type.value)] = group
         else:
-            # the category does exists, add point
+            # the category does exist, add point
             d.set_point(device, location)  # the category, exists, just add
 
     def delete_device(self, device: ALL_DEV_TYPES) -> Union[object, None]:
@@ -300,7 +309,7 @@ class BaseDiagram:
             d = self.data.get(str(device.device_type.value), None)
 
             if d:
-                # the category does exist, delete from it
+                # the category does exist, delete_with_dialogue from it
                 return d.delete_device(device=device)
             else:
                 # not found so we're ok
@@ -350,7 +359,7 @@ class BaseDiagram:
                 "min_bus_width": self.min_bus_width,
                 "max_bus_width": self.max_bus_width,
                 "arrow_size": self.arrow_size,
-
+                "use_api_colors": self.use_api_colors,
                 "palette": self.palette.value,
                 "default_bus_voltage": self.default_bus_voltage,
                 'data': data}
@@ -377,6 +386,7 @@ class BaseDiagram:
         self.arrow_size: float = data.get("arrow_size", 1)
         self.palette = Colormaps(data.get("palette", 'GridCal'))
         self.default_bus_voltage = data.get("default_bus_voltage", 10)
+        self.use_api_colors = data.get("use_api_colors", False)
 
         if data['type'] == 'bus-branch':
             self.diagram_type = DiagramType.Schematic

{gridcalengine-5.3.34 → gridcalengine-5.3.36}/GridCalEngine/Devices/Parents/editable_device.py

@@ -637,7 +637,7 @@ class EditableDevice:
                 # return the normal property
                 return getattr(self, prop.name)
 
-    def set_vaule(self, prop: GCProp, t_idx: Union[None, int], value: Any) -> None:
+    def set_value(self, prop: GCProp, t_idx: Union[None, int], value: Any) -> None:
         """
         Return value regardless of the property index
         :param prop: GCProp

{gridcalengine-5.3.34 → gridcalengine-5.3.36}/GridCalEngine/Devices/Substation/connectivity_node.py

@@ -13,14 +13,17 @@ from GridCalEngine.enumerations import DeviceType
 
 class ConnectivityNode(PhysicalDevice):
 
-    def __init__(self, name='CN',
+    def __init__(self,
+                 name='CN',
                  idtag=None,
                  code='',
                  dc: bool = False,
                  default_bus: Union[None, Bus] = None,
                  voltage_level: Union[VoltageLevel, None] = None,
                  internal: bool = False,
-                 Vnom: float = 10.0):
+                 Vnom: float = 10.0,
+                 xpos=0,
+                 ypos=0):
         """
         Constructor
         :param name: Name of the connectivity node
@@ -31,6 +34,8 @@ class ConnectivityNode(PhysicalDevice):
         :param voltage_level: Substation of this connectivity node (optional)
         :param internal: Is internal?
         :param Vnom: Nominal voltage in kV
+        :param xpos: x position in px
+        :param ypos: y position in px
         """
         PhysicalDevice.__init__(self,
                                 name=name,
@@ -50,6 +55,9 @@ class ConnectivityNode(PhysicalDevice):
 
         self.Vnom = float(Vnom) if voltage_level is None else voltage_level.Vnom
 
+        self.x = float(xpos)
+        self.y = float(ypos)
+
         self.register(key='Vnom', units='kV', tpe=float, definition='Nominal line voltage of the cn.')
 
         self.register(key="dc", tpe=bool, definition="is this a DC connectivity node?")
@@ -63,6 +71,11 @@ class ConnectivityNode(PhysicalDevice):
         self.register(key="voltage_level", tpe=DeviceType.VoltageLevelDevice,
                       definition="Voltage level of this connectivity node (optional)")
 
+        self.register(key='x', units='px', tpe=float, definition='x position in pixels.', profile_name='',
+                      editable=False)
+        self.register(key='y', units='px', tpe=float, definition='y position in pixels.', profile_name='',
+                      editable=False)
+
     @property
     def bus(self) -> Bus:
         """

{gridcalengine-5.3.34 → gridcalengine-5.3.36}/GridCalEngine/Devices/assets.py

@@ -1016,7 +1016,7 @@ class Assets:
         self.delete_winding(obj.winding1)
         self.delete_winding(obj.winding2)
         self.delete_winding(obj.winding3)
-        self.delete_bus(obj.bus0, delete_associated=True)  # also remove the middle bus
+        self.delete_bus(obj.bus0, delete_associated=True)  # also delete the middle bus
 
     # ------------------------------------------------------------------------------------------------------------------
     # Windings
@@ -1249,7 +1249,7 @@ class Assets:
         :param delete_associated: Delete the associated branches and injections
         """
 
-        # remove associated Branches in reverse order
+        # delete associated Branches in reverse order
         for branch_list in self.get_branch_lists():
             for i in range(len(branch_list) - 1, -1, -1):
                 if branch_list[i].bus_from == obj:
@@ -1263,7 +1263,7 @@ class Assets:
                     else:
                         branch_list[i].bus_to = None
 
-        # remove the associated injection devices
+        # 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 == obj:
@@ -1272,23 +1272,23 @@ class Assets:
                     else:
                         inj_list[i].bus = None
 
-        # remove associations in connectivity nodes
+        # delete associations in connectivity nodes
         deleted_cn = set()
         for cn in self._connectivity_nodes:
             if cn.bus == obj:
                 deleted_cn.add(cn)
-                self.delete_connectivity_node(cn)  # remove the association
+                self.delete_connectivity_node(cn)  # delete the association
 
-        # remove associations in bus_bars
+        # delete associations in bus_bars
         for bb in self.bus_bars:
             if bb.cn in deleted_cn:
                 self.delete_bus_bar(bb)
 
-        # remove the bus itself
+        # delete the bus itself
         try:
             self._buses.remove(obj)
         except ValueError:
-            print(f"Could not remove {obj.name}")
+            print(f"Could not delete {obj.name}")
 
     def get_buses_by(self, filter_elements: List[Union[dev.Area, dev.Country, dev.Zone]]) -> List[dev.Bus]:
         """
@@ -1903,6 +1903,16 @@ class Assets:
         except ValueError:
             pass
 
+    def get_batteries_indexing_dict(self) -> Dict[str, int]:
+        """
+        Get a dictionary that relates the battery uuid's with their index
+        :return: Dict[str, int]
+        """
+        gen_index_dict: Dict[str, int] = dict()
+        for k, elm in enumerate(self.batteries):
+            gen_index_dict[elm.idtag] = k  # associate the idtag to the index
+        return gen_index_dict
+
     # ------------------------------------------------------------------------------------------------------------------
     # Static generator
     # ------------------------------------------------------------------------------------------------------------------
@@ -2564,7 +2574,7 @@ class Assets:
 
     def delete_line_template_dependency(self, obj):
         """
-        Search a branch template from lines and transformers and delete it
+        Search a branch template from lines and transformers and delete_with_dialogue it
         :param obj:
         :return:
         """
@@ -2733,7 +2743,7 @@ class Assets:
 
     def delete_transformer_template_dependency(self, obj: dev.TransformerType):
         """
-        Search a branch template from lines and transformers and delete it
+        Search a branch template from lines and transformers and delete_with_dialogue it
         :param obj:
         :return:
         """
@@ -2880,7 +2890,7 @@ class Assets:
         :return:
         """
         if len(selected_objects) > 1:
-            # remove the first SE from the list and keep it
+            # delete the first SE from the list and keep it
             base = selected_objects.pop(0)
 
             for elm in self.voltage_levels:
@@ -3389,7 +3399,7 @@ class Assets:
         except ValueError:
             pass
 
-        # delete references in the remedial action groups
+        # delete_with_dialogue references in the remedial action groups
         for rag in self._remedial_action_groups:
             if rag.conn_group is not None:
                 if rag.conn_group == obj:
@@ -3528,7 +3538,7 @@ class Assets:
         """
         Delete zone
         :param obj: index
-        :param del_group: delete the group?
+        :param del_group: delete_with_dialogue the group?
         """
         try:
             self._investments.remove(obj)
@@ -3902,6 +3912,13 @@ class Assets:
             index_dict[elm.idtag] = k  # associate the idtag to the index
         return index_dict
 
+    def get_technology_names(self) -> StrVec:
+        """
+
+        :return:
+        """
+        return np.array([elm.name for elm in self._technologies])
+
     # ------------------------------------------------------------------------------------------------------------------
     # Modelling authority
     # ------------------------------------------------------------------------------------------------------------------
@@ -4160,7 +4177,7 @@ class Assets:
                 for assoc in to_del:
                     elm.emissions.remove(assoc)
 
-        # delete the gas
+        # delete_with_dialogue the gas
         try:
             self._emission_gases.remove(obj)
         except ValueError:
@@ -4207,7 +4224,7 @@ class Assets:
         Delete fluid node
         :param obj: FluidNode
         """
-        # delete dependencies
+        # delete_with_dialogue dependencies
         for fluid_path in reversed(self._fluid_paths):
             if fluid_path.source == obj or fluid_path.target == obj:
                 self.delete_fluid_path(fluid_path)
@@ -4858,7 +4875,7 @@ class Assets:
         """
         Delete the dependencies that may come with a branch
         :param obj: branch object or any object
-        :param delete_groups: delete empty groups too?
+        :param delete_groups: delete_with_dialogue empty groups too?
         :return:
         """
         for elm in self.contingencies:
@@ -5702,7 +5719,7 @@ class Assets:
     def delete_element(self, obj: ALL_DEV_TYPES) -> None:
         """
         Get set of elements and their parent nodes
-        :param obj: device object to delete
+        :param obj: device object to delete_with_dialogue
         :return: Nothing
         """
 
@@ -5874,6 +5891,9 @@ class Assets:
         elif obj.device_type == DeviceType.FacilityDevice:
             self.delete_facility(obj)
 
+        elif obj.device_type == DeviceType.LineLocation:
+            pass
+
         else:
             raise Exception('Element type not understood ' + str(obj.device_type))
 
@@ -6014,7 +6034,7 @@ class Assets:
 
     def clear(self) -> None:
         """
-        Clear the multi-circuit (remove the bus and branch objects)
+        Clear the multi-circuit (delete the bus and branch objects)
         """
 
         for key, elm_list in self.template_objects_dict.items():