Features/network 0.5

AUTHORS.rst

@@ -12,6 +12,7 @@ Authors
 * Clemens Wingenbach
 * Cord Kaldemeyer
 * Daniel Rank
+* David Fuhrländer
 * Elisa Gaudchau
 * Elisa Papadis
 * Fabian Büllesbach

docs/usage.rst

@@ -810,10 +810,10 @@ This small example of PV, grid and SinkDSM shows how to use the component
 
     # Create Energy System
     es = solph.EnergySystem(timeindex=datetimeindex)
-    Node.registry = es
 
     # Create bus representing electricity grid
     b_elec = solph.buses.Bus(label='Electricity bus')
+    es.add(b_elec)
 
     # Create a back supply
     grid = solph.components.Source(label='Grid',
@@ -822,6 +822,7 @@ This small example of PV, grid and SinkDSM shows how to use the component
                                 nominal_value=10000,
                                 variable_costs=50)}
                         )
+    es.add(grid)
 
     # PV supply from time series
     s_wind = solph.components.Source(label='wind',
@@ -830,6 +831,7 @@ This small example of PV, grid and SinkDSM shows how to use the component
                                   fix=data['pv'],
                                   nominal_value=3.5)}
                           )
+    es.add(s_wind)
 
     # Create DSM Sink
     demand_dsm = solph.custom.SinkDSM(label="DSM",
@@ -843,6 +845,7 @@ This small example of PV, grid and SinkDSM shows how to use the component
                                       max_capacity_down=1,
                                       approach="DIW",
                                       cost_dsm_down=5)
+    es.add(demand_dsm)
 
 Yielding the following results
 

examples/emission_constraint/emission_constraint.py

@@ -47,8 +47,8 @@ def main():
                 bel: solph.Flow(
                     nominal_value=100,
                     variable_costs=10,
-                    emission_factor=0.01,
                     fix=[0.1, 0.2, 0.3],
+                    custom_attributes={"emission_factor": 0.01},
                 )
             },
         )
@@ -58,7 +58,12 @@ def main():
     energysystem.add(
         solph.components.Source(
             label="gas-source",
-            outputs={bgas: solph.Flow(variable_costs=10, emission_factor=0.2)},
+            outputs={
+                bgas: solph.Flow(
+                    variable_costs=10,
+                    custom_attributes={"emission_factor": 0.2},
+                )
+            },
         )
     )
 

examples/flow_count_limit/flow_count_limit.py

@@ -35,9 +35,9 @@ def main():
     energy_system = solph.EnergySystem(
         timeindex=pd.date_range("1/1/2012", periods=4, freq="H")
     )
-    Node.registry = energy_system
 
     bel = solph.Bus(label="bel")
+    energy_system.add(bel)
 
     # There are a sink and a source, both creating a revenue (negative cost),
     # so it would be optimal to use both at the same time. To suppress this,
@@ -48,54 +48,64 @@ def main():
     #        ...)
     # But also any existing one (e.g. "emission_factor") can be used.
 
-    solph.components.Source(
-        label="source1",
-        outputs={
-            bel: solph.Flow(
-                nonconvex=solph.NonConvex(),
-                nominal_value=210,
-                variable_costs=[-1, -5, -1, -1],
-                max=[1, 1, 1, 0],
-                my_keyword=True,
-            )
-        },
+    energy_system.add(
+        solph.components.Source(
+            label="source1",
+            outputs={
+                bel: solph.Flow(
+                    nonconvex=solph.NonConvex(),
+                    nominal_value=210,
+                    variable_costs=[-1, -5, -1, -1],
+                    max=[1, 1, 1, 0],
+                    custom_attributes={"my_keyword": True},
+                )
+            },
+        )
     )
 
     # Note: The keyword is also defined when set to False.
-    solph.components.Sink(
-        label="sink1",
-        inputs={
-            bel: solph.Flow(
-                nonconvex=solph.NonConvex(),
-                variable_costs=[-2, -1, -2, -2],
-                nominal_value=250,
-                max=[1, 1, 1, 0],
-                my_keyword=False,
-            )
-        },
+    energy_system.add(
+        solph.components.Sink(
+            label="sink1",
+            inputs={
+                bel: solph.Flow(
+                    nonconvex=solph.NonConvex(),
+                    variable_costs=[-2, -1, -2, -2],
+                    nominal_value=250,
+                    max=[1, 1, 1, 0],
+                    custom_attributes={"my_keyword": False},
+                )
+            },
+        )
     )
 
     # Should be ignored because my_keyword is not defined.
-    solph.components.Source(
-        label="source2",
-        outputs={
-            bel: solph.Flow(
-                variable_costs=1,
-                nonconvex=solph.NonConvex(),
-                max=[1, 1, 1, 0],
-                nominal_value=145,
-            )
-        },
+    energy_system.add(
+        solph.components.Source(
+            label="source2",
+            outputs={
+                bel: solph.Flow(
+                    variable_costs=1,
+                    nonconvex=solph.NonConvex(),
+                    max=[1, 1, 1, 0],
+                    nominal_value=145,
+                )
+            },
+        )
     )
 
     # Should be ignored because it is not NonConvex.
-    solph.components.Sink(
-        label="sink2",
-        inputs={
-            bel: solph.Flow(
-                my_keyword=True, fix=[0, 1, 1, 0], nominal_value=130
-            )
-        },
+    energy_system.add(
+        solph.components.Sink(
+            label="sink2",
+            inputs={
+                bel: solph.Flow(
+                    custom_attributes={"my_keyword": True},
+                    fix=[0, 1, 1, 0],
+                    nominal_value=130,
+                )
+            },
+        )
     )
 
     model = solph.Model(energy_system)

examples/generic_invest_limit/example_generic_invest.py

@@ -50,7 +50,10 @@
 import logging
 import os
 
-import matplotlib.pyplot as plt
+try:
+    import matplotlib.pyplot as plt
+except ModuleNotFoundError:
+    plt = None
 
 from oemof import solph
 

examples/gradient_example/gradient_example.py

@@ -130,8 +130,8 @@ def main():
             outputs={
                 bel: flows.Flow(
                     nominal_value=10e5,
-                    negative_gradient={"ub": gradient},
-                    positive_gradient={"ub": gradient},
+                    negative_gradient_limit=gradient,
+                    positive_gradient_limit=gradient,
                 )
             },
             conversion_factors={bel: 0.58},

examples/invest_nonconvex_flow_examples/house_with_nonconvex_investment.py

@@ -78,8 +78,10 @@ def heat_demand(d):
                 max=1.0,
                 min=0.9,
                 variable_costs=0.1,
-                minimum_uptime=5,
-                initial_status=1,
+                nonconvex=solph.NonConvex(
+                    minimum_uptime=5,
+                    initial_status=1,
+                ),
                 investment=solph.Investment(
                     ep_costs=epc,
                     minimum=1.0,

examples/invest_nonconvex_flow_examples/house_without_nonconvex_investment.py

@@ -88,9 +88,10 @@ def solar_thermal(d):
                 min=0.4,
                 max=1.0,
                 variable_costs=0.1,
-                minimum_uptime=2,
-                initial_status=1,
-                nonconvex=solph.NonConvex(),
+                nonconvex=solph.NonConvex(
+                    minimum_uptime=2,
+                    initial_status=1,
+                ),
             )
         },
     )

setup.py

@@ -78,12 +78,12 @@ def read(*names, **kwargs):
     install_requires=[
         "blinker",
         "dill",
-        "numpy",
+        "numpy < 1.24",
         "pandas",
         "pyomo >= 6.0.0, < 7.0",
         "networkx",
         "oemof.tools >= 0.4.2",
-        "oemof.network",
+        "oemof.network >= 0.5.0a1",
     ],
     extras_require={
         "dev": [

src/oemof/solph/_helpers.py

@@ -8,6 +8,8 @@
 SPDX-FileCopyrightText: Cord Kaldemeyer
 SPDX-FileCopyrightText: Stephan Günther
 SPDX-FileCopyrightText: Birgit Schachler
+SPDX-FileCopyrightText: David Fuhrländer
+SPDX-FileCopyrightText: Johannes Röder
 
 SPDX-License-Identifier: MIT
 
@@ -29,12 +31,16 @@ def check_node_object_for_missing_attribute(obj, attribute):
 
     """
     if not getattr(obj, attribute):
-        msg = (
-            "Attribute <{0}> is missing in Node <{1}> of {2}.\n"
-            "If this is intended and you know what you are doing you can"
-            "disable the SuspiciousUsageWarning globally."
-        )
-        warn(
-            msg.format(attribute, obj.label, type(obj)),
-            debugging.SuspiciousUsageWarning,
-        )
+        warn_if_missing_attribute(obj, attribute)
+
+
+def warn_if_missing_attribute(obj, attribute):
+    msg = (
+        "Attribute <{0}> is missing in Node <{1}> of {2}.\n"
+        "If this is intended and you know what you are doing you can"
+        "disable the SuspiciousUsageWarning globally."
+    )
+    warn(
+        msg.format(attribute, obj.label, type(obj)),
+        debugging.SuspiciousUsageWarning,
+    )

src/oemof/solph/_models.py

@@ -348,21 +348,15 @@ def _add_parent_block_sets(self):
         )
 
         self.BIDIRECTIONAL_FLOWS = po.Set(
-            initialize=[
-                k
-                for (k, v) in self.flows.items()
-                if hasattr(v, "bidirectional")
-            ],
+            initialize=[k for (k, v) in self.flows.items() if v.bidirectional],
             ordered=True,
             dimen=2,
             within=self.FLOWS,
         )
 
         self.UNIDIRECTIONAL_FLOWS = po.Set(
             initialize=[
-                k
-                for (k, v) in self.flows.items()
-                if not hasattr(v, "bidirectional")
+                k for (k, v) in self.flows.items() if not v.bidirectional
             ],
             ordered=True,
             dimen=2,