Simplify testing by creating a Element Library

Author: FBumann

tests/conftest.py

@@ -61,26 +61,21 @@ def coal():
         return fx.Bus('Kohle')
 
     @staticmethod
-    def all_standard():
+    def defaults():
         """Get all standard buses at once"""
         return [Buses.electricity(), Buses.heat(), Buses.gas()]
 
-    @staticmethod
-    def all_with_coal():
-        """Get all buses including coal"""
-        return [Buses.electricity(), Buses.heat(), Buses.gas(), Buses.coal()]
-
 
 class Effects:
     """Standard effects used across flow systems"""
 
     @staticmethod
-    def costs_standard():
+    def costs():
         return fx.Effect('costs', '€', 'Kosten', is_standard=True, is_objective=True)
 
     @staticmethod
-    def costs_only():
-        return fx.Effect('Costs', '€', 'Kosten', is_standard=True, is_objective=True)
+    def co2():
+        return fx.Effect('CO2', 'kg', 'CO2_e-Emissionen')
 
     @staticmethod
     def co2_with_costs_share():
@@ -89,23 +84,10 @@ def co2_with_costs_share():
             'kg',
             'CO2_e-Emissionen',
             specific_share_to_other_effects_operation={'costs': 0.2},
-            maximum_operation_per_hour=1000,
         )
 
     @staticmethod
-    def co2_simple():
-        return fx.Effect('CO2', 'kg', 'CO2_e-Emissionen', specific_share_to_other_effects_operation={'costs': 0.2})
-
-    @staticmethod
-    def co2_basic():
-        return fx.Effect('CO2', 'kg', 'CO2_e-Emissionen')
-
-    @staticmethod
-    def primary_energy_limited():
-        return fx.Effect('PE', 'kWh_PE', 'Primärenergie', maximum_total=3.5e3)
-
-    @staticmethod
-    def primary_energy_basic():
+    def primary_energy():
         return fx.Effect('PE', 'kWh_PE', 'Primärenergie')
 
 
@@ -351,23 +333,17 @@ class Sources:
     """Energy sources"""
 
     @staticmethod
-    def gas_with_co2():
+    def gas_with_costs_and_co2():
         """Standard gas tariff with CO2 emissions"""
-        return fx.Source(
-            'Gastarif', source=fx.Flow('Q_Gas', bus='Gas', size=1000, effects_per_flow_hour={'costs': 0.04, 'CO2': 0.3})
-        )
+        source = Sources.gas_with_costs()
+        source.source.effects_per_flow_hour = {'costs': 0.04, 'CO2': 0.3}
+        return source
 
     @staticmethod
-    def gas_simple():
+    def gas_with_costs():
         """Simple gas tariff without CO2"""
-        return fx.Source('Gastarif', source=fx.Flow('Q_Gas', 'Gas', size=1000, effects_per_flow_hour=0.04))
-
-    @staticmethod
-    def gas_with_price(gas_price):
-        """Gas tariff with variable pricing"""
         return fx.Source(
-            'Gastarif',
-            source=fx.Flow('Q_Gas', bus='Gas', size=1000, effects_per_flow_hour={'costs': gas_price, 'CO2': 0.3}),
+            'Gastarif', source=fx.Flow(label='Q_Gas', bus='Gas', size=1000, effects_per_flow_hour={'costs': 0.04})
         )
 
 
@@ -386,20 +362,21 @@ def simple_flow_system() -> fx.FlowSystem:
     base_timesteps = pd.date_range('2020-01-01', periods=9, freq='h', name='time')
 
     # Define effects
-    costs = Effects.costs_standard()
+    costs = Effects.costs()
     co2 = Effects.co2_with_costs_share()
+    co2.maximum_operation_per_hour = 1000
 
     # Create components
     boiler = Converters.Boilers.simple()
     chp = Converters.CHPs.simple()
     storage = Storage.simple()
     heat_load = Sinks.heat_load(base_thermal_load)
-    gas_tariff = Sources.gas_with_co2()
+    gas_tariff = Sources.gas_with_costs_and_co2()
     electricity_feed_in = Sinks.electricity_feed_in(base_electrical_price)
 
     # Create flow system
     flow_system = fx.FlowSystem(base_timesteps)
-    flow_system.add_elements(*Buses.all_standard())
+    flow_system.add_elements(*Buses.defaults())
     flow_system.add_elements(storage, costs, co2, boiler, heat_load, gas_tariff, electricity_feed_in, chp)
 
     return flow_system
@@ -415,22 +392,23 @@ def simple_flow_system_scenarios() -> fx.FlowSystem:
     base_timesteps = pd.date_range('2020-01-01', periods=9, freq='h', name='time')
 
     # Define effects
-    costs = Effects.costs_standard()
+    costs = Effects.costs()
     co2 = Effects.co2_with_costs_share()
+    co2.maximum_operation_per_hour = 1000
 
     # Create components
     boiler = Converters.Boilers.simple()
     chp = Converters.CHPs.simple()
     storage = Storage.simple()
     heat_load = Sinks.heat_load(base_thermal_load)
-    gas_tariff = Sources.gas_with_co2()
+    gas_tariff = Sources.gas_with_costs_and_co2()
     electricity_feed_in = Sinks.electricity_feed_in(base_electrical_price)
 
     # Create flow system
     flow_system = fx.FlowSystem(
         base_timesteps, scenarios=pd.Index(['A', 'B', 'C']), weights=np.array([0.5, 0.25, 0.25])
     )
-    flow_system.add_elements(*Buses.all_standard())
+    flow_system.add_elements(*Buses.defaults())
     flow_system.add_elements(storage, costs, co2, boiler, heat_load, gas_tariff, electricity_feed_in, chp)
 
     return flow_system
@@ -444,12 +422,12 @@ def basic_flow_system() -> fx.FlowSystem:
     thermal_load = LoadProfiles.random_thermal(10)
     p_el = LoadProfiles.random_electrical(10)
 
-    costs = Effects.costs_only()
+    costs = Effects.costs()
     heat_load = Sinks.heat_load(thermal_load)
-    gas_source = Sources.gas_simple()
+    gas_source = Sources.gas_with_costs()
     electricity_sink = Sinks.electricity_feed_in(p_el)
 
-    flow_system.add_elements(*Buses.all_standard())
+    flow_system.add_elements(*Buses.defaults())
     flow_system.add_elements(costs, heat_load, gas_source, electricity_sink)
 
     return flow_system
@@ -465,15 +443,17 @@ def flow_system_complex() -> fx.FlowSystem:
     flow_system = fx.FlowSystem(pd.date_range('2020-01-01', periods=9, freq='h', name='time'))
 
     # Define the components and flow_system
-    costs = Effects.costs_standard()
-    co2 = Effects.co2_simple()
-    pe = Effects.primary_energy_limited()
+    costs = Effects.costs()
+    co2 = Effects.co2()
+    co2.specific_share_to_other_effects_operation = {'costs': 0.2}
+    pe = Effects.primary_energy()
+    pe.maximum_total = 3.5e3
 
     heat_load = Sinks.heat_load(thermal_load)
-    gas_tariff = Sources.gas_with_co2()
+    gas_tariff = Sources.gas_with_costs_and_co2()
     electricity_feed_in = Sinks.electricity_feed_in(electrical_load)
 
-    flow_system.add_elements(*Buses.all_standard())
+    flow_system.add_elements(*Buses.defaults())
     flow_system.add_elements(costs, co2, pe, heat_load, gas_tariff, electricity_feed_in)
 
     boiler = Converters.Boilers.complex()
@@ -544,8 +524,12 @@ def flow_system_long():
     )
 
     # Add buses and effects using library
-    flow_system.add_elements(*Buses.all_with_coal())
-    flow_system.add_elements(Effects.costs_standard(), Effects.co2_basic(), Effects.primary_energy_basic())
+    flow_system.add_elements(*Buses.defaults(), Buses.coal())
+
+    flow_system.add_elements(Effects.costs(), Effects.co2(), Effects.primary_energy())
+
+    gas = Sources.gas_with_costs()
+    gas.source.effects_per_flow_hour = {'costs': gas_price, 'CO2': 0.3}
 
     # Add loads and sources - mix of library and special elements
     flow_system.add_elements(
@@ -560,8 +544,6 @@ def flow_system_long():
             'Kohletarif',
             source=fx.Flow('Q_Kohle', bus='Kohle', size=1000, effects_per_flow_hour={'costs': 4.6, 'CO2': 0.3}),
         ),
-        # Gas tariff with variable pricing using library
-        Sources.gas_with_price(gas_price),
         # Special electricity feed-in with time series
         fx.Sink('Einspeisung', sink=fx.Flow('P_el', bus='Strom', size=1000, effects_per_flow_hour=p_feed_in)),
         # Special electricity purchase tariff
@@ -633,12 +615,12 @@ def basic_flow_system_linopy(timesteps_linopy) -> fx.FlowSystem:
     thermal_load = LoadProfiles.random_thermal(10)
     p_el = LoadProfiles.random_electrical(10)
 
-    costs = Effects.costs_only()
+    costs = Effects.costs()
     heat_load = Sinks.heat_load(thermal_load)
-    gas_source = Sources.gas_simple()
+    gas_source = Sources.gas_with_costs()
     electricity_sink = Sinks.electricity_feed_in(p_el)
 
-    flow_system.add_elements(*Buses.all_standard())
+    flow_system.add_elements(*Buses.defaults())
     flow_system.add_elements(costs, heat_load, gas_source, electricity_sink)
 
     return flow_system