From 80b1e422ad1fc09dc01d3f6e48a6e44eefa8ef22 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= <patrik@proxima.snft.de>
Date: Mon, 26 Aug 2024 13:59:22 +0200
Subject: [PATCH 01/13] Remove broken link

---
 docs/whatsnew/v0-3-2.rst | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/docs/whatsnew/v0-3-2.rst b/docs/whatsnew/v0-3-2.rst
index e9765f7a4..d9ca30af7 100644
--- a/docs/whatsnew/v0-3-2.rst
+++ b/docs/whatsnew/v0-3-2.rst
@@ -19,8 +19,7 @@ New components
 Documentation
 ####################
 
-* Revision of the `outputlib documentation
-  <https://oemof-solph.readthedocs.io/en/v0.3.2/oemof_outputlib.html>`_.
+* Revision of the outputlib documentation.
 
 Other changes
 ####################

From c5cd8a4c8dd0892d76050995e10a3ac234febdcd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= <patrik@proxima.snft.de>
Date: Mon, 26 Aug 2024 14:08:53 +0200
Subject: [PATCH 02/13] Add length check (seting it) for sequences

For now, sequences that are too long are allowed.
We might want to warn in these cases.
---
 src/oemof/solph/_plumbing.py                  | 16 ++++++++
 .../components/_extraction_turbine_chp.py     |  6 +--
 .../solph/components/_generic_storage.py      | 33 +++++++--------
 .../components/experimental/_sink_dsm.py      | 19 ++++-----
 .../solph/flows/_investment_flow_block.py     | 10 ++++-
 .../solph/flows/_non_convex_flow_block.py     | 40 +++++++++++++++----
 src/oemof/solph/flows/_simple_flow_block.py   | 22 +++++++---
 .../flows/experimental/_electrical_line.py    |  4 +-
 8 files changed, 102 insertions(+), 48 deletions(-)

diff --git a/src/oemof/solph/_plumbing.py b/src/oemof/solph/_plumbing.py
index bb6ed5b80..4e7864ae3 100644
--- a/src/oemof/solph/_plumbing.py
+++ b/src/oemof/solph/_plumbing.py
@@ -56,6 +56,22 @@ def sequence(iterable_or_scalar):
         return _FakeSequence(value=iterable_or_scalar)
 
 
+def valid_sequence(sequence, length: int) -> bool:
+    if sequence[0] is None:
+        return False
+
+    if isinstance(sequence, _FakeSequence):
+        sequence.size = length
+        return True
+    if isinstance(sequence, np.ndarray):
+        if sequence.size >= length:
+            return True
+        else:
+            raise ValueError(f"Lentgh of {sequence} should be {length}")
+
+    return False
+
+
 class _FakeSequence:
     """Emulates a list whose length is not known in advance.
 
diff --git a/src/oemof/solph/components/_extraction_turbine_chp.py b/src/oemof/solph/components/_extraction_turbine_chp.py
index cef1a6152..dc8fb393b 100644
--- a/src/oemof/solph/components/_extraction_turbine_chp.py
+++ b/src/oemof/solph/components/_extraction_turbine_chp.py
@@ -23,8 +23,8 @@
 from pyomo.environ import BuildAction
 from pyomo.environ import Constraint
 
-from oemof.solph._plumbing import sequence as solph_sequence
-from oemof.solph.components._converter import Converter
+from oemof.solph._plumbing import sequence
+from oemof.solph.components import Converter
 
 
 class ExtractionTurbineCHP(Converter):
@@ -87,7 +87,7 @@ def __init__(
             custom_attributes=custom_attributes,
         )
         self.conversion_factor_full_condensation = {
-            k: solph_sequence(v)
+            k: sequence(v)
             for k, v in conversion_factor_full_condensation.items()
         }
 
diff --git a/src/oemof/solph/components/_generic_storage.py b/src/oemof/solph/components/_generic_storage.py
index a9c5e1c8a..4a7b23c75 100644
--- a/src/oemof/solph/components/_generic_storage.py
+++ b/src/oemof/solph/components/_generic_storage.py
@@ -38,7 +38,8 @@
 
 from oemof.solph._helpers import check_node_object_for_missing_attribute
 from oemof.solph._options import Investment
-from oemof.solph._plumbing import sequence as solph_sequence
+from oemof.solph._plumbing import sequence
+from oemof.solph._plumbing import valid_sequence
 
 
 class GenericStorage(Node):
@@ -224,19 +225,15 @@ def __init__(
 
         self.initial_storage_level = initial_storage_level
         self.balanced = balanced
-        self.loss_rate = solph_sequence(loss_rate)
-        self.fixed_losses_relative = solph_sequence(fixed_losses_relative)
-        self.fixed_losses_absolute = solph_sequence(fixed_losses_absolute)
-        self.inflow_conversion_factor = solph_sequence(
-            inflow_conversion_factor
-        )
-        self.outflow_conversion_factor = solph_sequence(
-            outflow_conversion_factor
-        )
-        self.max_storage_level = solph_sequence(max_storage_level)
-        self.min_storage_level = solph_sequence(min_storage_level)
-        self.fixed_costs = solph_sequence(fixed_costs)
-        self.storage_costs = solph_sequence(storage_costs)
+        self.loss_rate = sequence(loss_rate)
+        self.fixed_losses_relative = sequence(fixed_losses_relative)
+        self.fixed_losses_absolute = sequence(fixed_losses_absolute)
+        self.inflow_conversion_factor = sequence(inflow_conversion_factor)
+        self.outflow_conversion_factor = sequence(outflow_conversion_factor)
+        self.max_storage_level = sequence(max_storage_level)
+        self.min_storage_level = sequence(min_storage_level)
+        self.fixed_costs = sequence(fixed_costs)
+        self.storage_costs = sequence(storage_costs)
         self.invest_relation_input_output = invest_relation_input_output
         self.invest_relation_input_capacity = invest_relation_input_capacity
         self.invest_relation_output_capacity = invest_relation_output_capacity
@@ -603,7 +600,7 @@ def _objective_expression(self):
 
         if m.es.periods is not None:
             for n in self.STORAGES:
-                if n.fixed_costs[0] is not None:
+                if valid_sequence(n.fixed_costs, len(m.PERIODS)):
                     fixed_costs += sum(
                         n.nominal_storage_capacity
                         * n.fixed_costs[pp]
@@ -615,7 +612,7 @@ def _objective_expression(self):
         storage_costs = 0
 
         for n in self.STORAGES:
-            if n.storage_costs[0] is not None:
+            if valid_sequence(n.storage_costs, len(m.TIMESTEPS)):
                 storage_costs += (
                     self.storage_content[n, 0] * n.storage_costs[0]
                 )
@@ -1861,7 +1858,7 @@ def _objective_expression(self):
                     period_investment_costs[p] += investment_costs_increment
 
             for n in self.INVESTSTORAGES:
-                if n.investment.fixed_costs[0] is not None:
+                if valid_sequence(n.investment.fixed_costs, len(m.PERIODS)):
                     lifetime = n.investment.lifetime
                     for p in m.PERIODS:
                         range_limit = min(
@@ -1879,7 +1876,7 @@ def _objective_expression(self):
                         )
 
             for n in self.EXISTING_INVESTSTORAGES:
-                if n.investment.fixed_costs[0] is not None:
+                if valid_sequence(n.investment.fixed_costs, len(m.PERIODS)):
                     lifetime = n.investment.lifetime
                     age = n.investment.age
                     range_limit = min(
diff --git a/src/oemof/solph/components/experimental/_sink_dsm.py b/src/oemof/solph/components/experimental/_sink_dsm.py
index 1d910f54e..4645a5899 100644
--- a/src/oemof/solph/components/experimental/_sink_dsm.py
+++ b/src/oemof/solph/components/experimental/_sink_dsm.py
@@ -38,6 +38,7 @@
 
 from oemof.solph._options import Investment
 from oemof.solph._plumbing import sequence
+from oemof.solph._plumbing import valid_sequence
 from oemof.solph.components._sink import Sink
 
 
@@ -703,7 +704,7 @@ def _objective_expression(self):
                         * (1 + m.discount_rate) ** (-m.es.periods_years[p])
                     )
 
-                if g.fixed_costs[0] is not None:
+                if valid_sequence(g.fixed_costs, len(m.PERIODS)):
                     fixed_costs += sum(
                         max(g.max_capacity_up, g.max_capacity_down)
                         * g.fixed_costs[pp]
@@ -1434,7 +1435,7 @@ def _objective_expression(self):
                         * (1 + m.discount_rate) ** (-m.es.periods_years[p])
                     )
 
-                if g.investment.fixed_costs[0] is not None:
+                if valid_sequence(g.investment.fixed_costs, len(m.PERIODS)):
                     lifetime = g.investment.lifetime
                     for p in m.PERIODS:
                         range_limit = min(
@@ -1452,7 +1453,7 @@ def _objective_expression(self):
                         )
 
             for g in self.EXISTING_INVESTDSM:
-                if g.investment.fixed_costs[0] is not None:
+                if valid_sequence(g.investment.fixed_costs, len(m.PERIODS)):
                     lifetime = g.investment.lifetime
                     age = g.investment.age
                     range_limit = min(
@@ -2198,7 +2199,7 @@ def _objective_expression(self):
                         * (1 + m.discount_rate) ** (-m.es.periods_years[p])
                     )
 
-                if g.fixed_costs[0] is not None:
+                if valid_sequence(g.fixed_costs, len(m.PERIODS)):
                     fixed_costs += sum(
                         max(g.max_capacity_up, g.max_capacity_down)
                         * g.fixed_costs[pp]
@@ -3290,7 +3291,7 @@ def _objective_expression(self):
                         * (1 + m.discount_rate) ** (-m.es.periods_years[p])
                     )
 
-                if g.investment.fixed_costs[0] is not None:
+                if valid_sequence(g.investment.fixed_costs, len(m.PERIODS)):
                     lifetime = g.investment.lifetime
                     for p in m.PERIODS:
                         range_limit = min(
@@ -3308,7 +3309,7 @@ def _objective_expression(self):
                         )
 
             for g in self.EXISTING_INVESTDSM:
-                if g.investment.fixed_costs[0] is not None:
+                if valid_sequence(g.investment.fixed_costs, len(m.PERIODS)):
                     lifetime = g.investment.lifetime
                     age = g.investment.age
                     range_limit = min(
@@ -4391,7 +4392,7 @@ def _objective_expression(self):
                         * (1 + m.discount_rate) ** (-m.es.periods_years[p])
                     )
 
-                if g.fixed_costs[0] is not None:
+                if valid_sequence(g.fixed_costs, len(m.PERIODS)):
                     fixed_costs += sum(
                         max(g.max_capacity_up, g.max_capacity_down)
                         * g.fixed_costs[pp]
@@ -5791,7 +5792,7 @@ def _objective_expression(self):
                         * (1 + m.discount_rate) ** (-m.es.periods_years[p])
                     )
 
-                if g.investment.fixed_costs[0] is not None:
+                if valid_sequence(g.investment.fixed_costs, len(m.PERIODS)):
                     lifetime = g.investment.lifetime
                     for p in m.PERIODS:
                         range_limit = min(
@@ -5809,7 +5810,7 @@ def _objective_expression(self):
                         )
 
             for g in self.EXISTING_INVESTDSM:
-                if g.investment.fixed_costs[0] is not None:
+                if valid_sequence(g.investment.fixed_costs, len(m.PERIODS)):
                     lifetime = g.investment.lifetime
                     age = g.investment.age
                     range_limit = min(
diff --git a/src/oemof/solph/flows/_investment_flow_block.py b/src/oemof/solph/flows/_investment_flow_block.py
index 99efec0dc..bb0ee5d2c 100644
--- a/src/oemof/solph/flows/_investment_flow_block.py
+++ b/src/oemof/solph/flows/_investment_flow_block.py
@@ -29,6 +29,8 @@
 from pyomo.core import Var
 from pyomo.core.base.block import ScalarBlock
 
+from oemof.solph._plumbing import valid_sequence
+
 
 class InvestmentFlowBlock(ScalarBlock):
     r"""Block for all flows with :attr:`Investment` being not None.
@@ -1007,7 +1009,9 @@ def _objective_expression(self):
                     period_investment_costs[p] += investment_costs_increment
 
             for i, o in self.INVESTFLOWS:
-                if m.flows[i, o].investment.fixed_costs[0] is not None:
+                if valid_sequence(
+                    m.flows[i, o].investment.fixed_costs, len(m.PERIODS)
+                ):
                     lifetime = m.flows[i, o].investment.lifetime
                     for p in m.PERIODS:
                         range_limit = min(
@@ -1022,7 +1026,9 @@ def _objective_expression(self):
                         )
 
             for i, o in self.EXISTING_INVESTFLOWS:
-                if m.flows[i, o].investment.fixed_costs[0] is not None:
+                if valid_sequence(
+                    m.flows[i, o].investment.fixed_costs, len(m.PERIODS)
+                ):
                     lifetime = m.flows[i, o].investment.lifetime
                     age = m.flows[i, o].investment.age
                     range_limit = min(
diff --git a/src/oemof/solph/flows/_non_convex_flow_block.py b/src/oemof/solph/flows/_non_convex_flow_block.py
index aa1cf457c..31b870ca0 100644
--- a/src/oemof/solph/flows/_non_convex_flow_block.py
+++ b/src/oemof/solph/flows/_non_convex_flow_block.py
@@ -25,6 +25,8 @@
 from pyomo.core import Var
 from pyomo.core.base.block import ScalarBlock
 
+from oemof.solph._plumbing import valid_sequence
+
 
 class NonConvexFlowBlock(ScalarBlock):
     r"""
@@ -327,7 +329,9 @@ def _startup_costs(self):
 
             if m.es.periods is None:
                 for i, o in self.STARTUPFLOWS:
-                    if m.flows[i, o].nonconvex.startup_costs[0] is not None:
+                    if valid_sequence(
+                        m.flows[i, o].nonconvex.startup_costs, len(m.TIMESTEPS)
+                    ):
                         startup_costs += sum(
                             self.startup[i, o, t]
                             * m.flows[i, o].nonconvex.startup_costs[t]
@@ -335,7 +339,9 @@ def _startup_costs(self):
                         )
             else:
                 for i, o in self.STARTUPFLOWS:
-                    if m.flows[i, o].nonconvex.startup_costs[0] is not None:
+                    if valid_sequence(
+                        m.flows[i, o].nonconvex.startup_costs, len(m.TIMESTEPS)
+                    ):
                         startup_costs += sum(
                             self.startup[i, o, t]
                             * m.flows[i, o].nonconvex.startup_costs[t]
@@ -361,7 +367,10 @@ def _shutdown_costs(self):
 
             if m.es.periods is None:
                 for i, o in self.SHUTDOWNFLOWS:
-                    if m.flows[i, o].nonconvex.shutdown_costs[0] is not None:
+                    if valid_sequence(
+                        m.flows[i, o].nonconvex.shutdown_costs,
+                        len(m.TIMESTEPS),
+                    ):
                         shutdown_costs += sum(
                             self.shutdown[i, o, t]
                             * m.flows[i, o].nonconvex.shutdown_costs[t]
@@ -369,7 +378,10 @@ def _shutdown_costs(self):
                         )
             else:
                 for i, o in self.SHUTDOWNFLOWS:
-                    if m.flows[i, o].nonconvex.shutdown_costs[0] is not None:
+                    if valid_sequence(
+                        m.flows[i, o].nonconvex.shutdown_costs,
+                        len(m.TIMESTEPS),
+                    ):
                         shutdown_costs += sum(
                             self.shutdown[i, o, t]
                             * m.flows[i, o].nonconvex.shutdown_costs[t]
@@ -395,7 +407,10 @@ def _activity_costs(self):
 
             if m.es.periods is None:
                 for i, o in self.ACTIVITYCOSTFLOWS:
-                    if m.flows[i, o].nonconvex.activity_costs[0] is not None:
+                    if valid_sequence(
+                        m.flows[i, o].nonconvex.activity_costs,
+                        len(m.TIMESTEPS),
+                    ):
                         activity_costs += sum(
                             self.status[i, o, t]
                             * m.flows[i, o].nonconvex.activity_costs[t]
@@ -403,7 +418,10 @@ def _activity_costs(self):
                         )
             else:
                 for i, o in self.ACTIVITYCOSTFLOWS:
-                    if m.flows[i, o].nonconvex.activity_costs[0] is not None:
+                    if valid_sequence(
+                        m.flows[i, o].nonconvex.activity_costs,
+                        len(m.TIMESTEPS),
+                    ):
                         activity_costs += sum(
                             self.status[i, o, t]
                             * m.flows[i, o].nonconvex.activity_costs[t]
@@ -429,7 +447,10 @@ def _inactivity_costs(self):
 
             if m.es.periods is None:
                 for i, o in self.INACTIVITYCOSTFLOWS:
-                    if m.flows[i, o].nonconvex.inactivity_costs[0] is not None:
+                    if valid_sequence(
+                        m.flows[i, o].nonconvex.inactivity_costs,
+                        len(m.TIMESTEPS),
+                    ):
                         inactivity_costs += sum(
                             (1 - self.status[i, o, t])
                             * m.flows[i, o].nonconvex.inactivity_costs[t]
@@ -437,7 +458,10 @@ def _inactivity_costs(self):
                         )
             else:
                 for i, o in self.INACTIVITYCOSTFLOWS:
-                    if m.flows[i, o].nonconvex.inactivity_costs[0] is not None:
+                    if valid_sequence(
+                        m.flows[i, o].nonconvex.inactivity_costs,
+                        len(m.TIMESTEPS),
+                    ):
                         inactivity_costs += sum(
                             (1 - self.status[i, o, t])
                             * m.flows[i, o].nonconvex.inactivity_costs[t]
diff --git a/src/oemof/solph/flows/_simple_flow_block.py b/src/oemof/solph/flows/_simple_flow_block.py
index 7cf21bced..e7d8d6841 100644
--- a/src/oemof/solph/flows/_simple_flow_block.py
+++ b/src/oemof/solph/flows/_simple_flow_block.py
@@ -26,6 +26,8 @@
 from pyomo.core import Var
 from pyomo.core.base.block import ScalarBlock
 
+from oemof.solph._plumbing import valid_sequence
+
 
 class SimpleFlowBlock(ScalarBlock):
     r"""Flow block with definitions for standard flows.
@@ -172,12 +174,16 @@ def _create_variables(self, group):
         )
         # set upper bound of gradient variable
         for i, o, f in group:
-            if m.flows[i, o].positive_gradient_limit[0] is not None:
+            if valid_sequence(
+                m.flows[i, o].positive_gradient_limit, len(m.TIMESTEPS)
+            ):
                 for t in m.TIMESTEPS:
                     self.positive_gradient[i, o, t].setub(
                         f.positive_gradient_limit[t] * f.nominal_value
                     )
-            if m.flows[i, o].negative_gradient_limit[0] is not None:
+            if valid_sequence(
+                m.flows[i, o].negative_gradient_limit, len(m.TIMESTEPS)
+            ):
                 for t in m.TIMESTEPS:
                     self.negative_gradient[i, o, t].setub(
                         f.negative_gradient_limit[t] * f.nominal_value
@@ -429,7 +435,9 @@ def _objective_expression(self):
 
         if m.es.periods is None:
             for i, o in m.FLOWS:
-                if m.flows[i, o].variable_costs[0] is not None:
+                if valid_sequence(
+                    m.flows[i, o].variable_costs, len(m.TIMESTEPS)
+                ):
                     for t in m.TIMESTEPS:
                         variable_costs += (
                             m.flow[i, o, t]
@@ -439,7 +447,9 @@ def _objective_expression(self):
 
         else:
             for i, o in m.FLOWS:
-                if m.flows[i, o].variable_costs[0] is not None:
+                if valid_sequence(
+                    m.flows[i, o].variable_costs, len(m.TIMESTEPS)
+                ):
                     for p, t in m.TIMEINDEX:
                         variable_costs += (
                             m.flow[i, o, t]
@@ -464,7 +474,7 @@ def _objective_expression(self):
 
             # Fixed costs for units with limited lifetime
             for i, o in self.LIFETIME_FLOWS:
-                if m.flows[i, o].fixed_costs[0] is not None:
+                if valid_sequence(m.flows[i, o].fixed_costs, len(m.TIMESTEPS)):
                     range_limit = min(
                         m.es.end_year_of_optimization,
                         m.flows[i, o].lifetime,
@@ -477,7 +487,7 @@ def _objective_expression(self):
                     )
 
             for i, o in self.LIFETIME_AGE_FLOWS:
-                if m.flows[i, o].fixed_costs[0] is not None:
+                if valid_sequence(m.flows[i, o].fixed_costs, len(m.TIMESTEPS)):
                     range_limit = min(
                         m.es.end_year_of_optimization,
                         m.flows[i, o].lifetime - m.flows[i, o].age,
diff --git a/src/oemof/solph/flows/experimental/_electrical_line.py b/src/oemof/solph/flows/experimental/_electrical_line.py
index 2b5e2eb85..ad08f99ff 100644
--- a/src/oemof/solph/flows/experimental/_electrical_line.py
+++ b/src/oemof/solph/flows/experimental/_electrical_line.py
@@ -25,7 +25,7 @@
 from pyomo.environ import Set
 from pyomo.environ import Var
 
-from oemof.solph._plumbing import sequence as solph_sequence
+from oemof.solph._plumbing import sequence
 from oemof.solph.buses.experimental._electrical_bus import ElectricalBus
 from oemof.solph.flows._flow import Flow
 
@@ -75,7 +75,7 @@ def __init__(self, **kwargs):
             nonconvex=kwargs.get("nonconvex"),
             custom_attributes=kwargs.get("costom_attributes"),
         )
-        self.reactance = solph_sequence(kwargs.get("reactance", 0.00001))
+        self.reactance = sequence(kwargs.get("reactance", 0.00001))
 
         self.input = kwargs.get("input")
         self.output = kwargs.get("output")

From caab94a711b23086cb24afcf2160df5bb4f28c8b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= <patrik@proxima.snft.de>
Date: Mon, 26 Aug 2024 14:25:42 +0200
Subject: [PATCH 03/13] Let CI run on release branches

---
 .github/workflows/codeql.yml      | 5 ++++-
 .github/workflows/lint.yml        | 1 +
 .github/workflows/packaging.yml   | 5 ++++-
 .github/workflows/tox_checks.yml  | 1 +
 .github/workflows/tox_pytests.yml | 1 +
 5 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
index d18c1a3e1..624ae6f25 100644
--- a/.github/workflows/codeql.yml
+++ b/.github/workflows/codeql.yml
@@ -2,7 +2,10 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ "dev", "master" ]
+    branches:
+      - dev
+      - master
+      - 'release/**'
   pull_request:
     branches: [ "dev" ]
   schedule:
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 8a4a7fff9..3e5f73159 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -5,6 +5,7 @@ on:
     branches:
       - master
       - dev
+      - 'release/**'
   pull_request:
 
 jobs:
diff --git a/.github/workflows/packaging.yml b/.github/workflows/packaging.yml
index 874a5bfb7..d53aa82b8 100644
--- a/.github/workflows/packaging.yml
+++ b/.github/workflows/packaging.yml
@@ -3,7 +3,10 @@ name: packaging
 on:
   # Make sure packaging process is not broken
   push:
-    branches: [master, dev]
+    branches:
+      - master
+      - dev
+      - 'release/**'
   pull_request:
   # Make a package for release
   release:
diff --git a/.github/workflows/tox_checks.yml b/.github/workflows/tox_checks.yml
index f575ed022..5553b0acf 100644
--- a/.github/workflows/tox_checks.yml
+++ b/.github/workflows/tox_checks.yml
@@ -6,6 +6,7 @@ on:
     branches:
       - master
       - dev
+      - 'release/**'
   pull_request:
 
   workflow_dispatch:
diff --git a/.github/workflows/tox_pytests.yml b/.github/workflows/tox_pytests.yml
index 48f4845a8..240459535 100644
--- a/.github/workflows/tox_pytests.yml
+++ b/.github/workflows/tox_pytests.yml
@@ -5,6 +5,7 @@ on:
     branches:
       - master
       - dev
+      - 'release/**'
   pull_request:
 
   workflow_dispatch:

From 3e66f74a9dd549e27c837bd7b9ec09c5e45fe7d0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= <patrik@proxima.snft.de>
Date: Mon, 26 Aug 2024 14:38:10 +0200
Subject: [PATCH 04/13] Add test for valid_sequence(...)

---
 tests/test_plumbing.py | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/tests/test_plumbing.py b/tests/test_plumbing.py
index b51187be8..c2ddc3764 100644
--- a/tests/test_plumbing.py
+++ b/tests/test_plumbing.py
@@ -11,6 +11,7 @@
 
 from oemof.solph._plumbing import _FakeSequence
 from oemof.solph._plumbing import sequence
+from oemof.solph._plumbing import valid_sequence
 
 
 def test_fake_sequence():
@@ -63,3 +64,20 @@ def test_sequence():
     seq_ab = sequence("ab")
     assert isinstance(seq_ab, str)
     assert seq_ab == "ab"
+
+
+def test_valid_sequence():
+    np_array = np.array([0, 1, 2, 3, 4])
+    assert valid_sequence(np_array, 5)
+
+    # it's not that long
+    with pytest.raises(ValueError):
+        valid_sequence(np_array, 1337)
+
+    fake_sequence = _FakeSequence(42)
+    assert valid_sequence(fake_sequence, 5)
+    assert len(fake_sequence) == 5
+
+    # possible for any length
+    assert valid_sequence(fake_sequence, 1337)
+    assert len(fake_sequence) == 1337

From 03e0c9ffa6857577da54e4a54ab1a94ea11a3228 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= <patrik@proxima.snft.de>
Date: Mon, 26 Aug 2024 14:46:36 +0200
Subject: [PATCH 05/13] Add test for an invalid sequence

---
 tests/test_plumbing.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/tests/test_plumbing.py b/tests/test_plumbing.py
index c2ddc3764..d5fb7da38 100644
--- a/tests/test_plumbing.py
+++ b/tests/test_plumbing.py
@@ -81,3 +81,5 @@ def test_valid_sequence():
     # possible for any length
     assert valid_sequence(fake_sequence, 1337)
     assert len(fake_sequence) == 1337
+
+    assert not valid_sequence("abc", 3)

From 164d96a4b1d256bd2751cab02f0322698f9917f1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= <patrik@salacia.snft.de>
Date: Mon, 26 Aug 2024 16:32:26 +0200
Subject: [PATCH 06/13] Update docstrings of _plumbing

---
 src/oemof/solph/_plumbing.py | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/src/oemof/solph/_plumbing.py b/src/oemof/solph/_plumbing.py
index 4e7864ae3..f4fec8d15 100644
--- a/src/oemof/solph/_plumbing.py
+++ b/src/oemof/solph/_plumbing.py
@@ -19,8 +19,8 @@
 
 def sequence(iterable_or_scalar):
     """Checks if an object is iterable (except string) or scalar and returns
-    the original sequence if object is an iterable and an 'emulated'
-    sequence object of class _Sequence if object is a scalar or string.
+    the an numpy array of the sequence if object is an iterable or an
+    'emulated'  sequence object of class _FakeSequence if object is a scalar.
 
     Parameters
     ----------
@@ -57,6 +57,11 @@ def sequence(iterable_or_scalar):
 
 
 def valid_sequence(sequence, length: int) -> bool:
+    """Checks if an object is a numpy array of at least the given length
+    or an 'emulated' sequence object of class _FakeSequence.
+    The latter is set to the required lenght.
+
+    """
     if sequence[0] is None:
         return False
 

From 0c394ed6337cc2eb46956d9e0d189ea3c591a4a1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= <patrik@salacia.snft.de>
Date: Mon, 26 Aug 2024 17:06:37 +0200
Subject: [PATCH 07/13] Add _FakeSequence fix to changelog

---
 docs/changelog.rst       |  1 +
 docs/whatsnew/v0-5-5.rst | 12 ++++++++++++
 2 files changed, 13 insertions(+)
 create mode 100644 docs/whatsnew/v0-5-5.rst

diff --git a/docs/changelog.rst b/docs/changelog.rst
index 63c0c0356..7f0fe3d06 100644
--- a/docs/changelog.rst
+++ b/docs/changelog.rst
@@ -9,6 +9,7 @@ These are new features and improvements of note in each release
     :backlinks: top
 
 
+.. include::  whatsnew/v0-5-5.rst
 .. include::  whatsnew/v0-5-4.rst
 .. include::  whatsnew/v0-5-3.rst
 .. include::  whatsnew/v0-5-2.rst
diff --git a/docs/whatsnew/v0-5-5.rst b/docs/whatsnew/v0-5-5.rst
new file mode 100644
index 000000000..c8afd9a9c
--- /dev/null
+++ b/docs/whatsnew/v0-5-5.rst
@@ -0,0 +1,12 @@
+v0.5.5 ()
+--------------------------
+
+Bug fixes
+#########
+
+* Fix iterating over _FakeSequence objects
+
+Contributors
+############
+
+* Patrik Schönfeldt

From 71af2ba7bdcfdad88564c3184c5d5c4d065d2658 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= <patrik@salacia.snft.de>
Date: Mon, 26 Aug 2024 21:08:23 +0200
Subject: [PATCH 08/13] Delete ignored data from integration tests

---
 .../test_scripts/test_solph/test_generic_caes/generic_caes.csv  | 1 -
 .../test_solph/test_generic_caes/test_generic_caes.py           | 2 +-
 tests/test_scripts/test_solph/test_generic_chp/ccet.csv         | 1 -
 .../test_solph/test_generic_chp/test_generic_chp.py             | 2 +-
 4 files changed, 2 insertions(+), 4 deletions(-)

diff --git a/tests/test_scripts/test_solph/test_generic_caes/generic_caes.csv b/tests/test_scripts/test_solph/test_generic_caes/generic_caes.csv
index 0c00956b4..1658a9f4c 100644
--- a/tests/test_scripts/test_solph/test_generic_caes/generic_caes.csv
+++ b/tests/test_scripts/test_solph/test_generic_caes/generic_caes.csv
@@ -238,4 +238,3 @@ timestep,price_el_sink,price_el_source
 237,-33.57,33.57
 238,-30.51,30.51
 239,-30.57,30.57
-240,-29.28,29.28
diff --git a/tests/test_scripts/test_solph/test_generic_caes/test_generic_caes.py b/tests/test_scripts/test_solph/test_generic_caes/test_generic_caes.py
index dc40286cb..8c9e041e4 100644
--- a/tests/test_scripts/test_solph/test_generic_caes/test_generic_caes.py
+++ b/tests/test_scripts/test_solph/test_generic_caes/test_generic_caes.py
@@ -34,7 +34,7 @@ def test_gen_caes():
     data = pd.read_csv(full_filename)
 
     # select periods
-    periods = len(data) - 1
+    periods = len(data)
 
     # create an energy system
     idx = pd.date_range("1/1/2017", periods=periods, freq="h")
diff --git a/tests/test_scripts/test_solph/test_generic_chp/ccet.csv b/tests/test_scripts/test_solph/test_generic_chp/ccet.csv
index ec231419f..185a1f1a2 100644
--- a/tests/test_scripts/test_solph/test_generic_chp/ccet.csv
+++ b/tests/test_scripts/test_solph/test_generic_chp/ccet.csv
@@ -198,4 +198,3 @@ timestep,demand_th,price_el,Eta_el_max_woDH,P_max_woDH,Eta_el_min_woDH,P_min_woD
 197,0.97,-50,0.53,199.73,0.43,80.65,0.19,31.71,0.19
 198,0.98,-50,0.53,199.73,0.43,80.65,0.19,31.71,0.19
 199,0.99,-50,0.53,199.73,0.43,80.65,0.19,31.71,0.19
-200,1,-50,0.53,199.73,0.43,80.65,0.19,31.71,0.19
diff --git a/tests/test_scripts/test_solph/test_generic_chp/test_generic_chp.py b/tests/test_scripts/test_solph/test_generic_chp/test_generic_chp.py
index 6c9f8c423..c5770d279 100644
--- a/tests/test_scripts/test_solph/test_generic_chp/test_generic_chp.py
+++ b/tests/test_scripts/test_solph/test_generic_chp/test_generic_chp.py
@@ -28,7 +28,7 @@ def test_gen_chp():
     data = pd.read_csv(full_filename)
 
     # select periods
-    periods = len(data) - 1
+    periods = len(data)
 
     # create an energy system
     idx = pd.date_range("1/1/2017", periods=periods, freq="h")

From 32f9857fc85ddc8d95b712aef890bf303cde7c9d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= <patrik@salacia.snft.de>
Date: Mon, 26 Aug 2024 21:09:14 +0200
Subject: [PATCH 09/13] Warn about sequences that are too long

---
 src/oemof/solph/_plumbing.py | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

diff --git a/src/oemof/solph/_plumbing.py b/src/oemof/solph/_plumbing.py
index f4fec8d15..10e9f423d 100644
--- a/src/oemof/solph/_plumbing.py
+++ b/src/oemof/solph/_plumbing.py
@@ -10,7 +10,7 @@
 SPDX-License-Identifier: MIT
 
 """
-
+import warnings
 from collections import abc
 from itertools import repeat
 
@@ -69,10 +69,20 @@ def valid_sequence(sequence, length: int) -> bool:
         sequence.size = length
         return True
     if isinstance(sequence, np.ndarray):
-        if sequence.size >= length:
+        if sequence.size == length:
+            return True
+        # --- BEGIN: To be removed for versions >= v0.6 ---
+        elif sequence.size > length:
+            warnings.warn(
+                "Sequence longer than needed"
+                f" ({sequence.size} items instead of {length})."
+                " This will be trated as an error in the future.",
+                FutureWarning,
+            )
             return True
+        # --- END ---
         else:
-            raise ValueError(f"Lentgh of {sequence} should be {length}")
+            raise ValueError(f"Lentgh of {sequence} should be {length}.")
 
     return False
 

From f7e72ae28fa340355e082a21025d099ae6d05bda Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= <patrik@salacia.snft.de>
Date: Mon, 26 Aug 2024 21:29:29 +0200
Subject: [PATCH 10/13] Test for long sequence warning

---
 tests/test_plumbing.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/tests/test_plumbing.py b/tests/test_plumbing.py
index d5fb7da38..618f2df7d 100644
--- a/tests/test_plumbing.py
+++ b/tests/test_plumbing.py
@@ -70,6 +70,9 @@ def test_valid_sequence():
     np_array = np.array([0, 1, 2, 3, 4])
     assert valid_sequence(np_array, 5)
 
+    with pytest.warns(FutureWarning, match="Sequence longer than needed"):
+        valid_sequence(np_array, 4)
+
     # it's not that long
     with pytest.raises(ValueError):
         valid_sequence(np_array, 1337)

From f6f5339e3eccea7dbd99e2408be5e0ab1843cb9a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= <patrik@proxima.snft.de>
Date: Thu, 29 Aug 2024 12:37:42 +0200
Subject: [PATCH 11/13] Forbid valid_sequence to overwrite existing length

---
 src/oemof/solph/_plumbing.py | 12 +++++++++---
 tests/test_plumbing.py       |  8 +++++++-
 2 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/src/oemof/solph/_plumbing.py b/src/oemof/solph/_plumbing.py
index 10e9f423d..77c8ffb09 100644
--- a/src/oemof/solph/_plumbing.py
+++ b/src/oemof/solph/_plumbing.py
@@ -59,15 +59,21 @@ def sequence(iterable_or_scalar):
 def valid_sequence(sequence, length: int) -> bool:
     """Checks if an object is a numpy array of at least the given length
     or an 'emulated' sequence object of class _FakeSequence.
-    The latter is set to the required lenght.
+    If unset, the latter is set to the required lenght.
 
     """
     if sequence[0] is None:
         return False
 
     if isinstance(sequence, _FakeSequence):
-        sequence.size = length
-        return True
+        if sequence.size is None:
+            sequence.size = length
+
+        if sequence.size == length:
+            return True
+        else:
+            return False
+
     if isinstance(sequence, np.ndarray):
         if sequence.size == length:
             return True
diff --git a/tests/test_plumbing.py b/tests/test_plumbing.py
index 618f2df7d..f97ff96c1 100644
--- a/tests/test_plumbing.py
+++ b/tests/test_plumbing.py
@@ -81,8 +81,14 @@ def test_valid_sequence():
     assert valid_sequence(fake_sequence, 5)
     assert len(fake_sequence) == 5
 
-    # possible for any length
+    # wil not automatically overwrite size
+    assert not valid_sequence(fake_sequence, 1337)
+    assert len(fake_sequence) == 5
+
+    # manually overwriting length is still possible
+    fake_sequence.size = 1337
     assert valid_sequence(fake_sequence, 1337)
     assert len(fake_sequence) == 1337
 
+    # strings are no valid sequences
     assert not valid_sequence("abc", 3)

From c775b91a37d26b0d90a010ea1958cd2f25bab127 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= <patrik@proxima.snft.de>
Date: Thu, 29 Aug 2024 13:27:35 +0200
Subject: [PATCH 12/13] Release version 0.5.5

---
 src/oemof/solph/__init__.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/oemof/solph/__init__.py b/src/oemof/solph/__init__.py
index ebdb22c2c..7f58c9578 100644
--- a/src/oemof/solph/__init__.py
+++ b/src/oemof/solph/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.5.4"
+__version__ = "0.5.5"
 
 from . import buses
 from . import components

From e9c0c56a26d0c8fad004ed64e6a310031e6875eb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrik=20Sch=C3=B6nfeldt?= <patrik@proxima.snft.de>
Date: Thu, 29 Aug 2024 13:59:18 +0200
Subject: [PATCH 13/13] Add v0.5.5 release date

---
 docs/whatsnew/v0-5-5.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/whatsnew/v0-5-5.rst b/docs/whatsnew/v0-5-5.rst
index c8afd9a9c..944d2e1b8 100644
--- a/docs/whatsnew/v0-5-5.rst
+++ b/docs/whatsnew/v0-5-5.rst
@@ -1,4 +1,4 @@
-v0.5.5 ()
+v0.5.5 (August 29th, 2024)
 --------------------------
 
 Bug fixes