Merge pull request #68 from oemof/feature/excess-attributes

Add functionality to Excess similar as Shortage

src/oemof/tabular/facades.py

@@ -1576,9 +1576,35 @@ def __init__(self, *args, **kwargs):
 
         self.bus = kwargs.get("bus")
 
-        self.marginal_cost = kwargs.get("marginal_cost")
+        self.marginal_cost = kwargs.get("marginal_cost", 0)
+
+        self.capacity = kwargs.get("capacity")
+
+        self.capacity_potential = kwargs.get(
+            "capacity_potential", float("+inf")
+        )
+
+        self.capacity_cost = kwargs.get("capacity_cost")
+
+        self.capacity_minimum = kwargs.get("capacity_minimum")
+
+        self.expandable = bool(kwargs.get("expandable", False))
+
+        self.input_parameters = kwargs.get("input_parameters", {})
+
+        self.build_solph_components()
+
+    def build_solph_components(self):
+        """
+        """
+        f = Flow(
+            nominal_value=self._nominal_value(),
+            variable_costs=self.marginal_cost,
+            investment=self._investment(),
+            **self.input_parameters
+        )
 
-        self.inputs.update({self.bus: Flow(variable_costs=self.marginal_cost)})
+        self.inputs.update({self.bus: f})
 
 
 class Shortage(Dispatchable):

tests/_files/lp_files/excess.lp

@@ -0,0 +1,30 @@
+\* Source Pyomo model name=Model *\
+
+min
+objective:
++10 flow(electricity_excess_0)
++10 flow(electricity_excess_1)
++10 flow(electricity_excess_2)
+
+s.t.
+
+c_e_Bus_balance(electricity_0)_:
++1 flow(electricity_excess_0)
+= 0
+
+c_e_Bus_balance(electricity_1)_:
++1 flow(electricity_excess_1)
+= 0
+
+c_e_Bus_balance(electricity_2)_:
++1 flow(electricity_excess_2)
+= 0
+
+c_e_ONE_VAR_CONSTANT:
+ONE_VAR_CONSTANT = 1.0
+
+bounds
+   0 <= flow(electricity_excess_0) <= 1000
+   0 <= flow(electricity_excess_1) <= 1000
+   0 <= flow(electricity_excess_2) <= 1000
+end

tests/test_constraints.py

@@ -5,12 +5,12 @@
 
 import pandas as pd
 
+from oemof import solph
 from oemof.solph import helpers
-import oemof.solph as solph
 
 from oemof.tabular.facades import (BackpressureTurbine, Commodity, Conversion,
-                                   Dispatchable, ExtractionTurbine, Link, Load,
-                                   Reservoir, Storage, Volatile)
+                                   Dispatchable, Excess, ExtractionTurbine,
+                                   Link, Load, Reservoir, Storage, Volatile)
 
 
 def chop_trailing_whitespace(lines):
@@ -345,6 +345,21 @@ def test_dispatchable(self):
 
         self.compare_to_reference_lp("dispatchable.lp")
 
+    def test_excess(self):
+        bus = solph.Bus("electricity")
+
+        excess = Excess(
+            label='excess',
+            bus=bus,
+            carrier='electricity',
+            tech='excess',
+            capacity=1000,
+            marginal_cost=10,
+        )
+        self.energysystem.add(bus, excess)
+
+        self.compare_to_reference_lp("excess.lp")
+
     def test_link(self):
         r"""
         """

tests/test_examples.py

@@ -1,11 +1,9 @@
+import importlib
 import pathlib
-
 import pkg_resources as pkg
 
 from oemof.network.energy_system import EnergySystem as ES
-
 from oemof.tabular.facades import TYPEMAP
-
 # The import below is only used to monkey patch `EnergySystem`.
 # Hence the `noqa` because otherwise, style checkers would complain about an
 # unused import.
@@ -70,7 +68,6 @@ def test_custom_foreign_keys(monkeypatch):
         "OEMOF_TABULAR_FOREIGN_KEYS_FILE",
         ROOT_DIR / "tests" / "custom_foreign_keys.json"
     )
-    import importlib
     importlib.reload(oemof.tabular.config.config)
     oemof.tabular.datapackage.building.infer_metadata(
         path=str(