GridCalEngine 5.1.4__tar.gz → 5.1.5__tar.gz

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Aggregation/area.py

@@ -41,9 +41,9 @@ class GenericAreaGroup(EditableDevice):
         self.latitude = latitude
         self.longitude = longitude
 
-        self.register(key='longitude', units='deg', tpe=float, definition='longitude of the bus.', profile_name='',
+        self.register(key='longitude', units='deg', tpe=float, definition='longitude.', profile_name='',
                       editable=False)
-        self.register(key='latitude', units='deg', tpe=float, definition='latitude of the bus.', profile_name='',
+        self.register(key='latitude', units='deg', tpe=float, definition='latitude.', profile_name='',
                       editable=False)
 
 

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Aggregation/contingency.py

@@ -118,19 +118,3 @@ class Contingency(EditableDevice):
     def category(self, val):
         # self.group.category = val
         pass
-
-    def get_properties_dict(self, version=3):
-        """
-        Get json dictionary
-        :return:
-        """
-
-        return {
-            'id': self.idtag,
-            'name': self.name,
-            'name_code': self.code,
-            'group': self._group.idtag,
-            'device_uuid': self.device_idtag,
-            'prop': self.prop,
-            'value': self.value,
-        }

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Aggregation/emission_gas.py

@@ -70,20 +70,3 @@ class EmissionGas(EditableDevice):
             self._cost_prof.set(arr=val)
         else:
             raise Exception(str(type(val)) + 'not supported to be set into a cost_prof')
-
-    def get_properties_dict(self, version=3):
-
-        data = {'id': self.idtag,
-                'name': self.name,
-                'code': self.code,
-                'cost': self.cost,
-                }
-        return data
-
-    def get_profiles_dict(self, version=3):
-        data = {'id': self.idtag}
-        return data
-
-    def get_units_dict(self, version=3):
-        data = {}
-        return data

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Aggregation/fuel.py

@@ -67,20 +67,3 @@ class Fuel(EditableDevice):
             self._cost_prof.set(arr=val)
         else:
             raise Exception(str(type(val)) + 'not supported to be set into a cost_prof')
-
-    def get_properties_dict(self, version=3):
-        data = {'id': self.idtag,
-                'name': self.name,
-                'code': self.code,
-                'cost': self.cost,
-                }
-        return data
-
-    def get_profiles_dict(self, version=3):
-        data = {'id': self.idtag,
-                'cost': self.cost_prof}
-        return data
-
-    def get_units_dict(self, version=3):
-        data = {}
-        return data

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Aggregation/investment.py

@@ -49,14 +49,14 @@ class Investment(EditableDevice):
                                 idtag=idtag,
                                 code=code,
                                 name=name,
-                                device_type=DeviceType.InvestmentDevice)
+                                device_type=DeviceType.InvestmentDevice,
+                                comment=comment)
 
         # Contingency type
         self.device_idtag = device_idtag
         self.CAPEX = CAPEX
         self.OPEX = OPEX
         self._group: InvestmentsGroup = group
-        self.comment = comment
 
         self.register(key='device_idtag', units='', tpe=str, definition='Unique ID')
         self.register(key='CAPEX', units='Me', tpe=float,
@@ -64,7 +64,6 @@ class Investment(EditableDevice):
         self.register(key='OPEX', units='Me', tpe=float,
                       definition='Operation expenditures. Maintenance costs among other recurrent costs.')
         self.register(key='group', units='', tpe=DeviceType.InvestmentsGroupDevice, definition='Investment group')
-        self.register(key='comment', units='', tpe=str, definition='Comments')
 
     @property
     def group(self) -> InvestmentsGroup:
@@ -90,20 +89,3 @@ class Investment(EditableDevice):
     def category(self, val):
         # self.group.category = val
         pass
-
-    def get_properties_dict(self, version=3):
-        """
-        Get json dictionary
-        :return:
-        """
-
-        return {
-            'id': self.idtag,
-            'name': self.name,
-            'name_code': self.code,
-            'group': self._group,
-            'device_idtag': self.device_idtag,
-            'CAPEX': self.CAPEX,
-            'OPEX': self.OPEX,
-            'comment': self.comment
-        }

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Aggregation/investments_group.py

@@ -41,24 +41,10 @@ class InvestmentsGroup(EditableDevice):
                                 name=name,
                                 idtag=idtag,
                                 code='',
-                                device_type=DeviceType.InvestmentsGroupDevice)
+                                device_type=DeviceType.InvestmentsGroupDevice,
+                                comment=comment)
 
         # Contingency type
         self.category = category
-        self.comment = comment
 
         self.register(key='category', units='', tpe=str, definition='Some tag to category the contingency group')
-
-        self.register(key='comment', units='', tpe=str, definition='Some comment')
-
-    def get_properties_dict(self, version=3):
-        """
-        Get json dictionary
-        :return:
-        """
-
-        return {
-            'id': self.idtag,
-            'name': self.name,
-            'category': self.category,
-        }

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Aggregation/technology.py

@@ -48,21 +48,3 @@ class Technology(EditableDevice):
         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')
-
-    def get_properties_dict(self, version=3):
-        data = {'id': self.idtag,
-                'name': self.name,
-                'name2': self.name2,
-                'name3': self.name3,
-                'name4': self.name4,
-                'code': self.code
-                }
-        return data
-
-    def get_profiles_dict(self, version=3):
-        data = {'id': self.idtag}
-        return data
-
-    def get_units_dict(self, version=3):
-        data = {}
-        return data

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Aggregation/zone.py

@@ -46,5 +46,4 @@ class Zone(GenericAreaGroup):
 
         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")
+        self.register(key="area", units="", tpe=DeviceType.AreaDevice, definition="Area of this zone.")

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Associations/generator_emission.py

@@ -54,21 +54,3 @@ class GeneratorEmission(EditableDevice):
         self.register(key='emission', units='', tpe=DeviceType.EmissionGasDevice, definition='Emission')
         self.register(key='rate', units='t/MWh', tpe=float,
                       definition='Emissions rate of the gas in the generator (t/MWh)')
-
-    def get_properties_dict(self, version=3):
-        data = {'id': self.idtag,
-                'name': self.name,
-                'code': self.code,
-                'generator': self.generator,
-                'emission': self.emission,
-                'rate': self.rate
-                }
-        return data
-
-    def get_profiles_dict(self, version=3):
-        data = {'id': self.idtag}
-        return data
-
-    def get_units_dict(self, version=3):
-        data = {}
-        return data

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Associations/generator_fuel.py

@@ -55,20 +55,3 @@ class GeneratorFuel(EditableDevice):
         self.register(key='rate', units='t/MWh', tpe=float,
                       definition='Fuel consumption rate in the generator')
 
-    def get_properties_dict(self, version=3):
-        data = {'id': self.idtag,
-                'name': self.name,
-                'code': self.code,
-                'generator': self.generator,
-                'fuel': self.fuel,
-                'rate': self.rate
-                }
-        return data
-
-    def get_profiles_dict(self, version=3):
-        data = {'id': self.idtag}
-        return data
-
-    def get_units_dict(self, version=3):
-        data = {}
-        return data

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Associations/generator_technology.py

@@ -54,21 +54,3 @@ class GeneratorTechnology(EditableDevice):
         self.register(key='technology', units='', tpe=DeviceType.Technology, definition='Technology object')
         self.register(key='proportion', units='p.u.', tpe=float,
                       definition='Share of the generator associated to the technology')
-
-    def get_properties_dict(self, version=3):
-        data = {'id': self.idtag,
-                'name': self.name,
-                'code': self.code,
-                'generator': self.generator,
-                'technology': self.technology,
-                'proportion': self.proportion
-                }
-        return data
-
-    def get_profiles_dict(self, version=3):
-        data = {'id': self.idtag}
-        return data
-
-    def get_units_dict(self, version=3):
-        data = {}
-        return data

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Branches/branch.py

@@ -374,42 +374,6 @@ class Branch(BranchParent):
             data.append(obj)
         return data
 
-    def get_properties_dict(self, version=3):
-        """
-        Get json dictionary
-        :return:
-        """
-
-        d = {'id': self.idtag,
-             'type': 'branch',
-             'phases': 'ps',
-             'name': self.name,
-             'from': self.bus_from.idtag,
-             'to': self.bus_to.idtag,
-             'active': self.active,
-             'rate': self.rate,
-             'r': self.R,
-             'x': self.X,
-             'g': self.G,
-             'b': self.B,
-             'length': self.length,
-             'tap_module': self.tap_module,
-             'bus_to_regulated': self.bus_to_regulated,
-             'vset': self.vset,
-             'temp_base': self.temp_base,
-             'temp_oper': self.temp_oper,
-             'alpha': self.alpha,
-             'tap_angle': self.angle,
-             'branch_type': str(self.branch_type),
-             'active_profile': [],
-             'rate_prof': []}
-
-        if self.active_prof is not None:
-            d['active_profile'] = self.active_prof.tolist()
-            d['rate_prof'] = self.rate_prof.tolist()
-
-        return d
-
     def plot_profiles(self, time_series=None, my_index=0, show_fig=True):
         """
         Plot the time series results of this object

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Branches/switch.py

@@ -137,70 +137,6 @@ class Switch(BranchParent):
             data.append(obj)
         return data
 
-    def get_properties_dict(self, version=3):
-        """
-        Get json dictionary
-        :return:
-        """
-        if version == 2:
-            d = {'id': self.idtag,
-                 'type': 'Switch',
-                 'phases': 'ps',
-                 'name': self.name,
-                 'name_code': self.code,
-                 'bus_from': self.bus_from.idtag,
-                 'bus_to': self.bus_to.idtag,
-                 'active': self.active,
-
-                 'rate': self.rate,
-
-                 'r': self.R,
-                 'x': self.X
-                 }
-        elif version == 3:
-            d = {'id': self.idtag,
-                 'type': 'Switch',
-                 'phases': 'ps',
-                 'name': self.name,
-                 'name_code': self.code,
-                 'bus_from': self.bus_from.idtag,
-                 'bus_to': self.bus_to.idtag,
-                 'active': self.active,
-
-                 'rate': self.rate,
-                 'contingency_factor1': self.contingency_factor,
-                 'contingency_factor2': self.contingency_factor,
-                 'contingency_factor3': self.contingency_factor,
-
-                 'r': self.R,
-                 'x': self.X
-                 }
-        else:
-            d = dict()
-
-        return d
-
-    def get_profiles_dict(self, version=3):
-        """
-
-        :return:
-        """
-        if self.active_prof is not None:
-            active_prof = self.active_prof.tolist()
-        else:
-            active_prof = list()
-
-        return {'id': self.idtag,
-                'active': active_prof}
-
-    def get_units_dict(self, version=3):
-        """
-        Get units of the values
-        """
-        return {'rate': 'MW',
-                'r': 'p.u.',
-                'x': 'p.u.'}
-
     def plot_profiles(self, time_series=None, my_index=0, show_fig=True):
         """
         Plot the time series results of this object

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Parents/editable_device.py

@@ -157,7 +157,8 @@ class EditableDevice:
                  name: str,
                  idtag: Union[str, None],
                  code: str,
-                 device_type: DeviceType):
+                 device_type: DeviceType,
+                 comment: str = ""):
         """
         Class to generalize any editable device
         :param name: Asset's name
@@ -174,18 +175,24 @@ class EditableDevice:
 
         self.device_type: DeviceType = device_type
 
+        self.comment: str = comment
+
         # list of registered properties. This is supremelly useful when accessing via the Table and Tree models
         self.property_list: List[GCProp] = list()
 
+        # dictionary of properties
         self.registered_properties: Dict[str, GCProp] = dict()
 
+        # list of properties that cannot be edited
         self.non_editable_properties: List[str] = list()
 
+
         self.properties_with_profile: Dict[str, Optional[Any]] = dict()
 
         self.register(key='idtag', units='', tpe=str, definition='Unique ID', editable=False)
-        self.register(key='name', units='', tpe=str, definition='Name of the branch.')
+        self.register(key='name', units='', tpe=str, definition='Name of the device.')
         self.register(key='code', units='', tpe=str, definition='Secondary ID')
+        self.register(key='comment', units='', tpe=str, definition='User comment')
 
     def __str__(self) -> str:
         """
@@ -646,40 +653,6 @@ class EditableDevice:
         """
         return getattr(self, prop.profile_name)
 
-    def get_properties_dict(self, version=3):
-        """
-
-        :param version:
-        :return:
-        """
-        return dict()
-
-    def get_units_dict(self, version=3):
-        """
-
-        :param version:
-        :return:
-        """
-        return dict()
-
-    def get_profiles_dict(self, version=3):
-        """
-
-        :param version:
-        :return:
-        """
-
-        """
-        {'id': self.idtag,
-        'active': active_prof,
-        'rate': rate_prof}
-        """
-        data = {'id': self.idtag}
-        for property_name, profile_name in self.properties_with_profile.items():
-            data[property_name] = profile_name
-
-        return data
-
     def copy(self):
         """
         Create a deep copy of this object

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Parents/generator_parent.py

@@ -167,43 +167,6 @@ class GeneratorParent(InjectionParent):
         else:
             raise Exception(str(type(val)) + 'not supported to be set into srap_enabled_prof')
 
-    def get_properties_dict(self, version=3):
-        """
-        Get json dictionary
-        :return:
-        """
-        if version in [2, 3]:
-            return {'id': self.idtag,
-                    'type': 'load',
-                    'phases': 'ps',
-                    'name': self.name,
-                    'name_code': self.code,
-                    'bus': self.bus.idtag,
-                    'active': bool(self.active),
-                    'p': self.P,
-                    'shedding_cost': self.Cost
-                    }
-        else:
-            return dict()
-
-    def get_profiles_dict(self, version=3):
-        """
-
-        :return:
-        """
-
-        if self.active_prof is not None:
-            active_profile = self.active_prof.tolist()
-            P_prof = self.P_prof.tolist()
-
-        else:
-            active_profile = list()
-            P_prof = list()
-
-        return {'id': self.idtag,
-                'active': active_profile,
-                'p': P_prof}
-
     def get_S(self) -> complex:
         """
 

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Parents/load_parent.py

@@ -139,47 +139,6 @@ class LoadParent(InjectionParent):
         """
         return self.P_prof.toarray() + 1j * self.Q_prof.toarray()
 
-    def get_properties_dict(self, version=3):
-        """
-        Get json dictionary
-        :return:
-        """
-        if version in [2, 3]:
-            return {'id': self.idtag,
-                    'type': 'load',
-                    'phases': 'ps',
-                    'name': self.name,
-                    'name_code': self.code,
-                    'bus': self.bus.idtag,
-                    'active': bool(self.active),
-                    'p': self.P,
-                    'q': self.Q,
-                    'shedding_cost': self.Cost
-                    }
-        else:
-            return dict()
-
-    def get_profiles_dict(self, version=3):
-        """
-
-        :return:
-        """
-
-        if self.active_prof is not None:
-            active_profile = self.active_prof.tolist()
-            P_prof = self.P_prof.tolist()
-            Q_prof = self.Q_prof.tolist()
-
-        else:
-            active_profile = list()
-            P_prof = list()
-            Q_prof = list()
-
-        return {'id': self.idtag,
-                'active': active_profile,
-                'p': P_prof,
-                'q': Q_prof}
-
     def plot_profiles(self, time=None, show_fig=True):
         """
         Plot the time series results of this object

{GridCalEngine-5.1.4 → GridCalEngine-5.1.5}/GridCalEngine/Devices/Parents/shunt_parent.py

@@ -174,47 +174,6 @@ class ShuntParent(InjectionParent):
         else:
             raise Exception(str(type(val)) + 'not supported to be set into a B_prof')
 
-    def get_properties_dict(self, version=3):
-        """
-        Get json dictionary
-        :return:
-        """
-        if version in [2, 3]:
-            return {'id': self.idtag,
-                    'type': 'load',
-                    'phases': 'ps',
-                    'name': self.name,
-                    'name_code': self.code,
-                    'bus': self.bus.idtag,
-                    'active': bool(self.active),
-                    'g': self.G,
-                    'b': self.B,
-                    'shedding_cost': self.Cost
-                    }
-        else:
-            return dict()
-
-    def get_profiles_dict(self, version=3):
-        """
-
-        :return:
-        """
-
-        if self.active_prof is not None:
-            active_profile = self.active_prof.tolist()
-            G_prof = self.G_prof.tolist()
-            B_prof = self.B_prof.tolist()
-
-        else:
-            active_profile = list()
-            G_prof = list()
-            B_prof = list()
-
-        return {'id': self.idtag,
-                'active': active_profile,
-                'g': G_prof,
-                'b': B_prof}
-
     def plot_profiles(self, time=None, show_fig=True):
         """
         Plot the time series results of this object