Create electricity import as a subclass of electricity producer with priceprofile

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Added
 - ESDL profile reading and writing for different types: influxdb and postgres, and inline (in ESDL file).
+- Import (a subclass of electricity source) is supported in Mesido.
 
 ## Changed
 - Code generalization in asset sizing mixin

examples/heating_and_cooling/model/Heating and cooling and elec network with return network with costs.esdl

@@ -1,9 +1,9 @@
 <?xml version='1.0' encoding='UTF-8'?>
-<esdl:EnergySystem xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:esdl="http://www.tno.nl/esdl" id="78ab6018-fdd7-4ad6-bd6e-2d8a38feeb57_with_return_network" description="" esdlVersion="v2401" name="Heating and cooling network with return network" version="25">
+<esdl:EnergySystem xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:esdl="http://www.tno.nl/esdl" id="78ab6018-fdd7-4ad6-bd6e-2d8a38feeb57_with_return_network" description="" esdlVersion="v2401" name="Heating and cooling and elec network with return network with costs" version="26">
   <energySystemInformation xsi:type="esdl:EnergySystemInformation" id="bf7d18e8-40c0-4234-af50-a0c72991b8fd">
     <carriers xsi:type="esdl:Carriers" id="222f232f-3510-4270-8e2c-9e713d69f5cc">
       <carrier xsi:type="esdl:HeatCommodity" id="001521ea-9f10-4745-ac3b-6e0c767e16b2" supplyTemperature="22.0" name="LT"/>
-      <carrier xsi:type="esdl:HeatCommodity" id="001521ea-9f10-4745-ac3b-6e0c767e16b2_ret" returnTemperature="8.0" name="LT_ret"/>
+      <carrier xsi:type="esdl:HeatCommodity" id="001521ea-9f10-4745-ac3b-6e0c767e16b2_ret" returnTemperature="11.0" name="LT_ret"/>
       <carrier xsi:type="esdl:ElectricityCommodity" id="b81ab0d3-6d2b-473f-9598-0e7b8760749f" name="Elect" voltage="230.0"/>
     </carriers>
   </energySystemInformation>
@@ -287,20 +287,20 @@
           <point xsi:type="esdl:Point" lat="51.98819497940513" lon="4.378428802710231" CRS="WGS84"/>
         </geometry>
       </asset>
-      <asset xsi:type="esdl:ElectricityProducer" id="d3ed25cb-3856-4277-afa8-ca804862f496" name="ElectricityProducer_1" power="2500000.0">
-        <geometry xsi:type="esdl:Point" lat="51.99808809408472" lon="4.365025475857443" CRS="WGS84"/>
-        <port xsi:type="esdl:OutPort" id="a500d0e9-9e23-49c5-90ab-43a5809821b0" name="Out" connectedTo="62c3380c-7b7a-4426-9e22-ad9efcf19cf7" carrier="b81ab0d3-6d2b-473f-9598-0e7b8760749f"/>
-      </asset>
       <asset xsi:type="esdl:ElectricityCable" id="187925f3-097c-462b-864c-c373195726d4" name="ElectricityCable_1879" length="196.1" capacity="2500000.0">
         <geometry xsi:type="esdl:Line" CRS="WGS84">
           <point xsi:type="esdl:Point" lat="51.99808809408472" lon="4.365025475857443"/>
           <point xsi:type="esdl:Point" lat="51.99793997825118" lon="4.365361717291578"/>
           <point xsi:type="esdl:Point" lat="51.99760488512543" lon="4.3633744366711555"/>
           <point xsi:type="esdl:Point" lat="51.99782979186225" lon="4.3632351591223815"/>
         </geometry>
-        <port xsi:type="esdl:InPort" id="62c3380c-7b7a-4426-9e22-ad9efcf19cf7" name="In" connectedTo="a500d0e9-9e23-49c5-90ab-43a5809821b0" carrier="b81ab0d3-6d2b-473f-9598-0e7b8760749f"/>
+        <port xsi:type="esdl:InPort" id="62c3380c-7b7a-4426-9e22-ad9efcf19cf7" name="In" connectedTo="361aeaa0-ecf5-4078-bc5d-50dd37f33bc4" carrier="b81ab0d3-6d2b-473f-9598-0e7b8760749f"/>
         <port xsi:type="esdl:OutPort" id="be9d7a12-4d81-488c-9ec6-936092994c7e" name="Out" connectedTo="fb51a9ba-6b9a-4fc1-a156-362f65f7b812" carrier="b81ab0d3-6d2b-473f-9598-0e7b8760749f"/>
       </asset>
+      <asset xsi:type="esdl:Import" id="5a6ca582-0096-4851-b4af-dbc8bc8e6bfb" name="Import_5a6c" power="2500000.0">
+        <geometry xsi:type="esdl:Point" lat="51.99811993935465" lon="4.364812005688062"/>
+        <port xsi:type="esdl:OutPort" id="361aeaa0-ecf5-4078-bc5d-50dd37f33bc4" name="Out" connectedTo="62c3380c-7b7a-4426-9e22-ad9efcf19cf7" carrier="b81ab0d3-6d2b-473f-9598-0e7b8760749f"/>
+      </asset>
       <area xsi:type="esdl:Area" name="Residential_1" id="336b2e6a-d5cd-4bdd-872e-05b9c8f1622f">
         <geometry xsi:type="esdl:Polygon" CRS="WGS84">
           <exterior xsi:type="esdl:SubPolygon">

examples/heating_and_cooling/src/run_case.py

@@ -87,12 +87,7 @@ def heating_cooling_case(self):
         np.testing.assert_array_less(1e3, results[f"{a_1_id}__fixed_operational_cost"])
         np.testing.assert_array_less(1e3, results[f"{hp_1_id}__investment_cost"])
         np.testing.assert_array_less(1e3, results[f"{hp_1_id}__installation_cost"])
-        # TODO: The heat pump __variable_operational_cost check below will fail due the heat pump
-        # variable cost not including the electricty profile. The intend of this example case
-        # is to include a elect cost profile which still has to be
-        # accounted for via the "Import" asset. Once this asset is catered for in MESIDO it has to
-        # replace the elect producer in this example.
-        np.testing.assert_array_less(1e3, results[f"{hp_1_id}__variable_operational_cost"])
+        np.testing.assert_array_less(2, results[f"{hp_1_id}__variable_operational_cost"])
         np.testing.assert_array_less(1e3, results[f"{hp_1_id}__fixed_operational_cost"])
         np.testing.assert_array_less(1e3, results[f"{ac_1_id}__investment_cost"])
         np.testing.assert_array_less(1e3, results[f"{ac_1_id}__installation_cost"])

src/mesido/esdl/asset_to_component_base.py

@@ -295,6 +295,11 @@ class _AssetToComponentBase:
             "fixedMaintenanceCosts": "optional",
             "fixedOperationalCosts": "optional",
         },
+        "electricity_import": {
+            "investmentCosts": "optional",
+            "installationCosts": "optional",
+            "variableOperationalCosts": "optional",
+        },
         "heat_source": {  # Includes GeothermalSource, ResidualHeatSource, HeatProducer,
             # GasHeater, ElectricBoiler
             "investmentCosts": "required",
@@ -349,6 +354,8 @@ class _AssetToComponentBase:
         "CoolingDemand": "heat_demand",
         "Electrolyzer": "electrolyzer",
         "ElectricBoiler": "heat_source",
+        "Import": "electricity_import",
+        "ElectricityProducer": "electricity_source",
         "GasDemand": "gas_demand",
         "GasHeater": "heat_source",
         "GasStorage": "gas_tank_storage",

src/mesido/esdl/esdl_heat_model.py

@@ -60,6 +60,7 @@
     Transformer,
     WindPark,
 )
+from mesido.pycml.component_library.milp.electricity.electricity_import import ElectricityImport
 
 # Importing workflow utilities at module import time can create circular
 # imports when workflows import ESDL mixins. Import locally where needed.
@@ -1903,7 +1904,8 @@ def convert_import(self, asset: Asset) -> Tuple[Any, MODIFIERS]:
         if isinstance(asset.out_ports[0].carrier, esdl.esdl.GasCommodity):
             return self.convert_gas_source(asset)
         elif isinstance(asset.out_ports[0].carrier, esdl.esdl.ElectricityCommodity):
-            return self.convert_electricity_source(asset)
+            _, modifiers = self.convert_electricity_source(asset)
+            return ElectricityImport, modifiers
         else:
             raise RuntimeError(
                 f"Commodity of type {type(asset.out_ports[0].carrier)} for asset Import "

src/mesido/financial_mixin.py

@@ -1163,9 +1163,15 @@ def __variable_operational_cost_constraints(self, ensemble_member):
             variable_operational_cost_coefficient = parameters[  # euro / Wh
                 f"{es}.variable_operational_cost_coefficient"
             ]
+
+            price_profile = self.__get_electricity_price_profile_or_zero()
+
             sum_ = ca.sum1(
                 variable_operational_cost_coefficient * elec_produced_w[1:] * timesteps_hr
             )  # [euro/Wh] * [W] * [hr]
+            if es in self.energy_system_components.get("electricity_import", []):
+                sum_ += ca.sum1(price_profile[1:] * elec_produced_w[1:] * timesteps_hr)
+
             constraints.append(((variable_operational_cost - sum_) / nominal, 0.0, 0.0))
 
         # for a in self.heat_network_components.get("ates", []):

src/mesido/pycml/component_library/milp/electricity/electricity_import.py

@@ -0,0 +1,24 @@
+from mesido.pycml.pycml_mixin import add_variables_documentation_automatically
+
+from .. import ElectricitySource
+
+
+@add_variables_documentation_automatically
+class ElectricityImport(ElectricitySource):
+    """
+    The electricity import is an electricity source component used to import electrical power and
+    provide that to the energy system, which can handle production profiles and electricity price
+    profiles.
+
+    Variables created:
+        {add_variable_names_for_documentation_here}
+
+    Parameters:
+        name : The name of the asset. \n
+        modifiers : Dictionary with asset information.
+    """
+
+    def __init__(self, name, **modifiers):
+        super().__init__(name, **modifiers)
+
+        self.component_subtype = "electricity_import"

tests/models/unit_cases_electricity/source_sink_cable/input/timeseries_with_e_price.csv

@@ -0,0 +1,4 @@
+DateTime,ElectricityDemand_2af6,Electricity
+1-1-2019 00:00,500,1.00E-04
+1-1-2019 01:00,1000,2.00E-04
+1-1-2019 02:00,1500,1.00E-04

tests/models/unit_cases_electricity/source_sink_cable/model/electricity_import_and_e_price.esdl

@@ -0,0 +1,33 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<esdl:EnergySystem xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:esdl="http://www.tno.nl/esdl" esdlVersion="v2107" version="5" name="electricity_import_and_e_price" id="b9a86f6b-02b4-4ab3-b2f3-608647c28e0e" description="Single source, single sink">
+  <energySystemInformation xsi:type="esdl:EnergySystemInformation" id="2bb5f647-e4ff-490a-9642-ccf9274d9c40">
+    <carriers xsi:type="esdl:Carriers" id="f6672aa2-7723-4945-92fa-b99846f58c92">
+      <carrier xsi:type="esdl:ElectricityCommodity" voltage="230.0" id="a04bdbac-5198-477b-9989-d99c3c001eaf" name="Electricity"/>
+    </carriers>
+  </energySystemInformation>
+  <instance xsi:type="esdl:Instance" id="67052ed2-f139-4936-9cd8-b4c419bf2cfa" name="Untitled instance">
+    <area xsi:type="esdl:Area" id="960acb90-32e0-4754-821d-f53e5567974b" name="Untitled area">
+      <asset xsi:type="esdl:ElectricityDemand" name="ElectricityDemand_2af6" id="2af646f3-f6ec-4086-baf6-df08a225c7d9" power="1000.0">
+        <geometry xsi:type="esdl:Point" lat="51.965990113174335" lon="4.420500415549058"/>
+        <port xsi:type="esdl:InPort" name="In" id="3f5a40fd-1a3e-4bd0-a0da-7bca9f891328" connectedTo="d0d25328-6989-4933-ba30-7f9e1b47b8a0" carrier="a04bdbac-5198-477b-9989-d99c3c001eaf"/>
+      </asset>
+      <asset xsi:type="esdl:ElectricityCable" length="245.5" name="ElectricityCable_238f" id="238feeba-231f-49b6-b5fc-ae3bfee9e6a5" capacity="32660.0">
+        <geometry xsi:type="esdl:Line" CRS="WGS84">
+          <point xsi:type="esdl:Point" lat="51.96477860380529" lon="4.417126178741456"/>
+          <point xsi:type="esdl:Point" lat="51.965849481781945" lon="4.4202589988708505"/>
+        </geometry>
+        <port xsi:type="esdl:InPort" name="In" id="86f5473a-c2de-488f-9193-7aa8fe14edad" connectedTo="2354a995-ba7b-45c4-a81e-770d242dd476" carrier="a04bdbac-5198-477b-9989-d99c3c001eaf"/>
+        <port xsi:type="esdl:OutPort" name="Out" id="d0d25328-6989-4933-ba30-7f9e1b47b8a0" connectedTo="3f5a40fd-1a3e-4bd0-a0da-7bca9f891328" carrier="a04bdbac-5198-477b-9989-d99c3c001eaf"/>
+      </asset>
+      <asset xsi:type="esdl:Import" id="7e33c9d1-2d56-4706-885c-954a1fc31e00" name="Import" power="1000.0">
+        <geometry xsi:type="esdl:Point" lat="51.96483987957858" lon="4.416455609789729"/>
+        <port xsi:type="esdl:OutPort" id="2354a995-ba7b-45c4-a81e-770d242dd476" name="Out" connectedTo="86f5473a-c2de-488f-9193-7aa8fe14edad" carrier="a04bdbac-5198-477b-9989-d99c3c001eaf"/>
+        <costInformation xsi:type="esdl:CostInformation" id="62c042b1-89de-41ba-9bad-ed78958bab0d">
+          <variableOperationalCosts xsi:type="esdl:SingleValue" id="ac61e6e8-7964-4c8f-a278-c4164d97b03e" value="10.0">
+            <profileQuantityAndUnit xsi:type="esdl:QuantityAndUnitType" physicalQuantity="COST" description="Cost in EUR/MWh" id="2752c66e-865e-4f6b-a72a-eed7c35f3d3d" unit="EURO" perMultiplier="MEGA" perUnit="WATTHOUR"/>
+          </variableOperationalCosts>
+        </costInformation>
+      </asset>
+    </area>
+  </instance>
+</esdl:EnergySystem>

tests/models/unit_cases_electricity/source_sink_cable/src/example.py

@@ -1,3 +1,4 @@
+from mesido.esdl.esdl_additional_vars_mixin import ESDLAdditionalVarsMixin
 from mesido.esdl.esdl_mixin import ESDLMixin
 from mesido.esdl.esdl_parser import ESDLFileParser
 from mesido.esdl.profile_parser import ProfileReaderFromFile
@@ -149,6 +150,15 @@ class ElectricityProblem(
     pass
 
 
+class ElectricityProblemPriceProfile(ESDLAdditionalVarsMixin, ElectricityProblem):
+    """
+    Problem to check the behaviour of a electricity import, cable, demand network.
+    ESDLAdditionalVarsMixin is needed to read e-price profile in input csv
+    """
+
+    pass
+
+
 class ElectricityProblemMaxCurr(
     PhysicsMixin,
     LinearizedOrderGoalProgrammingMixin,

tests/test_electric_source_sink.py

@@ -7,7 +7,11 @@
 
 import numpy as np
 
-from utils_tests import demand_matching_test, electric_power_conservation_test
+from utils_tests import (
+    cost_calculation_test,
+    demand_matching_test,
+    electric_power_conservation_test,
+)
 
 # TODO: still have to make test where elecitricity direction is switched:
 # e.g. 2 nodes, with at each node a producer and consumer, first one node medium demand, second
@@ -76,6 +80,46 @@ def test_source_sink_pv_csv_profile(self):
         # Check electricity producers max sizes are equal
         np.testing.assert_allclose(results[f"{pv_id}__max_size"], results[f"{e_prod_id}__max_size"])
 
+    def test_electricity_import_sink(self):
+        """
+        Tests for an electricity network that consist out of electricity import, cable and sink.
+
+        Checks:
+        - Check for energy conservation with consumed power, lost power and imported power.
+        - Check that variable operation cost of electricity import is calculated via electricity
+          price profile, variable operational cost coefficient and imported power.
+        """
+
+        import models.unit_cases_electricity.source_sink_cable.src.example as example
+        from models.unit_cases_electricity.source_sink_cable.src.example import (
+            ElectricityProblemPriceProfile,
+        )
+
+        base_folder = Path(example.__file__).resolve().parent.parent
+
+        solution = run_esdl_mesido_optimization(
+            ElectricityProblemPriceProfile,
+            base_folder=base_folder,
+            esdl_file_name="electricity_import_and_e_price.esdl",
+            esdl_parser=ESDLFileParser,
+            profile_reader=ProfileReaderFromFile,
+            input_timeseries_file="timeseries_with_e_price.csv",
+        )
+        results = solution.extract_results()
+        name_to_id_map = solution.esdl_asset_name_to_id_map
+
+        import_id = name_to_id_map["Import"]
+
+        # Check energy conservation
+        electric_power_conservation_test(solution, results)
+
+        # Check variable operation cost calculation
+        np.testing.assert_array_less(0.2, results[f"{import_id}__variable_operational_cost"])
+        np.testing.assert_array_less(
+            0.00005, solution.get_timeseries("Electricity.price_profile").values
+        )
+        cost_calculation_test(solution, results)
+
     def test_source_sink(self):
         """
         Tests for an electricity network that consist out of a source, a cable and a sink.