Merge pull request #1190 from oemof/release/v0.5

Release/v0.5

Author: p-snft

.github/workflows/lint.yml

@@ -15,12 +15,12 @@ jobs:
 
     steps:
       - name: Check out Git repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: "3.10"
 
       - name: Install Python dependencies
         run: pip install black flake8

.github/workflows/packaging.yml

@@ -19,10 +19,10 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.9]
+        python-version: ["3.10"]
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:

.github/workflows/tox_checks.yml

@@ -31,15 +31,15 @@ jobs:
       - name: Install LaTeX
         run: sudo apt install dvipng rubber texlive-latex-extra
       - name: Git clone
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
-      - name: Set up Python ${{ env.default_python || '3.9' }}
+      - name: Set up Python ${{ env.default_python || '3.10' }}
         uses: actions/setup-python@v5
         with:
-          python-version: "${{ env.default_python || '3.9' }}"
+          python-version: "${{ env.default_python || '3.10' }}"
 
       - name: Pip cache
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ matrix.toxenv }}-${{ hashFiles('tox.ini', 'setup.py') }}

.github/workflows/tox_pytests.yml

@@ -17,10 +17,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.9, "3.10", "3.11"]
+        python-version: ["3.10", "3.11"]
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
     - name: Install cbc
       run: sudo apt install coinor-cbc
     - name: Set up Python ${{ matrix.python-version }}

docs/changelog.rst

@@ -9,6 +9,7 @@ These are new features and improvements of note in each release
     :backlinks: top
 
 
+.. include::  whatsnew/v0-5-7.rst
 .. include::  whatsnew/v0-5-6.rst
 .. include::  whatsnew/v0-5-5.rst
 .. include::  whatsnew/v0-5-4.rst

docs/whatsnew/v0-5-7.rst

@@ -0,0 +1,27 @@
+v0.5.7 (April 25th, 2025)
+--------------------------
+
+New features
+############
+
+* Introduce option Model.solve(allow_nonoptimal=False) that raises
+  an error if no optimal solution is found. (Backported from v0.6.)
+
+Bug fixes
+#########
+
+* storage_costs are now considered also for GenericStorage with a
+  capacity that is subject to an Investment.
+
+Known issues
+############
+
+* Indexing of storage with capacity investment is off by one.
+* Related: Storage limits not applied for last time step.
+* Some links in the documentation are no longer valid.
+
+Contributors
+############
+
+* Eva Schischke
+* Patrik Schönfeldt

pyproject.toml

@@ -47,13 +47,14 @@ classifiers = [
     "Operating System :: OS Independent",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: Implementation :: CPython",
     "Topic :: Utilities",
 ]
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 dependencies = [
     "blinker",
     "dill",

src/oemof/solph/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.5.6"
+__version__ = "0.5.7"
 
 from . import buses
 from . import components

src/oemof/solph/_models.py

@@ -213,7 +213,9 @@ def results(self):
         """
         return processing.results(self)
 
-    def solve(self, solver="cbc", solver_io="lp", **kwargs):
+    def solve(
+        self, solver="cbc", solver_io="lp", allow_nonoptimal=True, **kwargs
+    ):
         r"""Takes care of communication with solver to solve the model.
 
         Parameters
@@ -222,6 +224,9 @@ def solve(self, solver="cbc", solver_io="lp", **kwargs):
             solver to be used e.g. "cbc", "glpk", "gurobi", "cplex"
         solver_io : string
             pyomo solver interface file format: "lp", "python", "nl", etc.
+        allow_nonoptimal : bool
+            if set to false, an error will be raised
+            if no optimal solution is found
         \**kwargs : keyword arguments
             Possible keys can be set see below:
 
@@ -248,23 +253,29 @@ def solve(self, solver="cbc", solver_io="lp", **kwargs):
 
         solver_results = opt.solve(self, **solve_kwargs)
 
-        status = solver_results["Solver"][0]["Status"]
-        termination_condition = solver_results["Solver"][0][
-            "Termination condition"
-        ]
+        status = solver_results.Solver.Status
+        termination_condition = solver_results.Solver.Termination_condition
+
+        self.es.results = solver_results
+        self.solver_results = solver_results
 
         if status == "ok" and termination_condition == "optimal":
             logging.info("Optimization successful...")
         else:
             msg = (
-                "Optimization ended with status {0} and termination "
-                "condition {1}"
-            )
-            warnings.warn(
-                msg.format(status, termination_condition), UserWarning
+                f"The solver did not return an optimal solution. "
+                f"Instead the optimization ended with\n "
+                f"    - status: {status}\n"
+                f"    - termination condition: {termination_condition}"
             )
-        self.es.results = solver_results
-        self.solver_results = solver_results
+
+            if allow_nonoptimal:
+                msg += "\n In the future, this will be treated as an error."
+                warnings.warn(
+                    msg.format(status, termination_condition), UserWarning
+                )
+            else:
+                raise RuntimeError(msg)
 
         return solver_results
 

src/oemof/solph/components/_generic_storage.py

@@ -1212,7 +1212,7 @@ def _create(self, group=None):
 
         # ######################### Variables  ################################
         self.storage_content = Var(
-            self.INVESTSTORAGES, m.TIMESTEPS, within=NonNegativeReals
+            self.INVESTSTORAGES, m.TIMEPOINTS, within=NonNegativeReals
         )
 
         def _storage_investvar_bound_rule(block, n, p):
@@ -1751,6 +1751,7 @@ def _objective_expression(self):
             return 0
 
         investment_costs = 0
+        storage_costs = 0
         period_investment_costs = {p: 0 for p in m.PERIODS}
         fixed_costs = 0
 
@@ -1889,10 +1890,24 @@ def _objective_expression(self):
                         for pp in range(range_limit)
                     )
 
+        for n in self.INVESTSTORAGES:
+            if valid_sequence(n.storage_costs, len(m.TIMESTEPS)):
+                storage_costs += (
+                    self.storage_content[n, 0] * n.storage_costs[0]
+                )
+                for t in m.TIMESTEPS:
+                    storage_costs += (
+                        self.storage_content[n, t + 1] * n.storage_costs[t + 1]
+                    )
+
+        self.storage_costs = Expression(expr=storage_costs)
+
         self.investment_costs = Expression(expr=investment_costs)
         self.period_investment_costs = period_investment_costs
         self.fixed_costs = Expression(expr=fixed_costs)
-        self.costs = Expression(expr=investment_costs + fixed_costs)
+        self.costs = Expression(
+            expr=investment_costs + fixed_costs + storage_costs
+        )
 
         return self.costs