storage_costs.storage_costs_example() - Code Metrics - Inspection of "Merge pull request #1170 from oemof/feature/exampl..." - oemof/oemof-solph - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev ( 468d85...f4c061 )

by Patrik

created 2025-03-11 11:37 UTC

storage_costs.storage_costs_example() B

↳ Parent: storage_costs.main()

Complexity

Conditions

Size

Total Lines	108
Code Lines	69

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	69
dl	0
loc	108
rs	8.0145
c	0
b	0
f	0
cc	1
nop	0

How to fix Long Method

# -*- coding: utf-8 -*-

"""
General description
-------------------
Example that shows the parameter `storage_costs` of `GenericStorage`.
A battery is used to make profit from fluctuating electricity prices.
For a battery without storage costs, it is beneficial to be empty
the end of the time horizon of the optimisation. For a battery that
assumes the average revenue, energy is kept at the end.

Code
----
Download source code: :download:`storage_costs.py </../examples/storage_costs/storage_costs.py>`

.. dropdown:: Click to display code

    .. literalinclude:: /../examples/storage_costs/storage_costs.py
        :language: python
        :lines: 36-

Installation requirements
-------------------------
This example requires oemof.solph (v0.5.x) and matplotlib, install by:

.. code:: bash

    pip install oemof.solph[examples] matplotlib


License
-------
`MIT license <https://github.com/oemof/oemof-solph/blob/dev/LICENSE>`_
"""

import numpy as np
import pandas as pd
from matplotlib import pyplot as plt

from oemof import solph


def main(optimize=True):
    # create an energy system
    idx = pd.date_range("1/1/2023", periods=13, freq="h")
    es = solph.EnergySystem(timeindex=idx, infer_last_interval=False)

    # power bus
    bel = solph.Bus(label="bel")
    es.add(bel)

    es.add(
        solph.components.Source(
            label="source_el",
            outputs={bel: solph.Flow()},
        )
    )

    es.add(
        solph.components.Sink(
            label="sink_el",
            inputs={bel: solph.Flow()},
        )
    )

    electricity_price = np.array(
        [
            0.38,
            0.31,
            0.32,
            0.33,
            0.37,
            0.32,
            0.33,
            0.34,
            0.39,
            0.38,
            0.37,
            0.35,
            0.35,
        ]
    )

    # Electric Storage 1
    # Costs are designed in a way that storing energy is benificial until the
    # last four time steps but emptying it is not a good option.
    battery1 = solph.components.GenericStorage(
        label="battery 1",
        nominal_capacity=10,
        inputs={
            bel: solph.Flow(
                nominal_capacity=1,
                variable_costs=electricity_price,
            )
        },
        outputs={
            bel: solph.Flow(
                nominal_capacity=1,
                variable_costs=-electricity_price,
            )
        },
        initial_storage_level=0.5,
        balanced=False,
    )
    es.add(battery1)

    # storages that balance our fluctuating costs
    # Electric Storage 2
    battery2 = solph.components.GenericStorage(
        label="battery 2",
        nominal_capacity=10,
        inputs={
            bel: solph.Flow(
                nominal_capacity=1,
                variable_costs=electricity_price,
            )
        },
        outputs={
            bel: solph.Flow(
                nominal_capacity=1,
                variable_costs=-electricity_price,
            )
        },
        storage_costs=12 * [0] + [-np.mean(electricity_price)],
        initial_storage_level=0.5,
        balanced=False,
    )
    es.add(battery2)

    if optimize is False:
        return es

    # create an optimization problem and solve it
    model = solph.Model(es)

    # solve model
    model.solve(solver="cbc")

    # create result object
    results = solph.processing.results(model)

    plt.plot(
        results[(battery1, None)]["sequences"],
        label="content w/o storage costs",
    )
    plt.plot(
        results[(battery2, None)]["sequences"],
        label="content w/ storage revenue",
    )
    plt.legend()
    plt.grid()

    plt.show()


if __name__ == "__main__":
    storage_costs_example()



1			# -- coding: utf-8 --
2
3			"""
4			General description
5			-------------------
6			Example that shows the parameter `storage_costs` of `GenericStorage`.
7			A battery is used to make profit from fluctuating electricity prices.
8			For a battery without storage costs, it is beneficial to be empty
9			the end of the time horizon of the optimisation. For a battery that
10			assumes the average revenue, energy is kept at the end.
11
12			Code
13			----
14			Download source code: :download:`storage_costs.py </../examples/storage_costs/storage_costs.py>`
15
16			.. dropdown:: Click to display code
17
18			.. literalinclude:: /../examples/storage_costs/storage_costs.py
19			:language: python
20			:lines: 36-
21
22			Installation requirements
23			-------------------------
24			This example requires oemof.solph (v0.5.x) and matplotlib, install by:
25
26			.. code:: bash
27
28			pip install oemof.solph[examples] matplotlib
29
30
31			License
32			-------
33			`MIT license <https://github.com/oemof/oemof-solph/blob/dev/LICENSE>`_
34			"""
35
36			import numpy as np
37			import pandas as pd
38			from matplotlib import pyplot as plt
39
40			from oemof import solph
41
42
43			def main(optimize=True):
44			# create an energy system
45			idx = pd.date_range("1/1/2023", periods=13, freq="h")
46			es = solph.EnergySystem(timeindex=idx, infer_last_interval=False)
47
48			# power bus
49			bel = solph.Bus(label="bel")
50			es.add(bel)
51
52			es.add(
53			solph.components.Source(
54			label="source_el",
55			outputs={bel: solph.Flow()},
56			)
57			)
58
59			es.add(
60			solph.components.Sink(
61			label="sink_el",
62			inputs={bel: solph.Flow()},
63			)
64			)
65
66			electricity_price = np.array(
67			[
68			0.38,
69			0.31,
70			0.32,
71			0.33,
72			0.37,
73			0.32,
74			0.33,
75			0.34,
76			0.39,
77			0.38,
78			0.37,
79			0.35,
80			0.35,
81			]
82			)
83
84			# Electric Storage 1
85			# Costs are designed in a way that storing energy is benificial until the
86			# last four time steps but emptying it is not a good option.
87			battery1 = solph.components.GenericStorage(
88			label="battery 1",
89			nominal_capacity=10,
90			inputs={
91			bel: solph.Flow(
92			nominal_capacity=1,
93			variable_costs=electricity_price,
94			)
95			},
96			outputs={
97			bel: solph.Flow(
98			nominal_capacity=1,
99			variable_costs=-electricity_price,
100			)
101			},
102			initial_storage_level=0.5,
103			balanced=False,
104			)
105			es.add(battery1)
106
107			# storages that balance our fluctuating costs
108			# Electric Storage 2
109			battery2 = solph.components.GenericStorage(
110			label="battery 2",
111			nominal_capacity=10,
112			inputs={
113			bel: solph.Flow(
114			nominal_capacity=1,
115			variable_costs=electricity_price,
116			)
117			},
118			outputs={
119			bel: solph.Flow(
120			nominal_capacity=1,
121			variable_costs=-electricity_price,
122			)
123			},
124			storage_costs=12 * [0] + [-np.mean(electricity_price)],
125			initial_storage_level=0.5,
126			balanced=False,
127			)
128			es.add(battery2)
129
130			if optimize is False:
131			return es
132
133			# create an optimization problem and solve it
134			model = solph.Model(es)
135
136			# solve model
137			model.solve(solver="cbc")
138
139			# create result object
140			results = solph.processing.results(model)
141
142			plt.plot(
143			results[(battery1, None)]["sequences"],
144			label="content w/o storage costs",
145			)
146			plt.plot(
147			results[(battery2, None)]["sequences"],
148			label="content w/ storage revenue",
149			)
150			plt.legend()
151			plt.grid()
152
153			plt.show()
154
155
156			if __name__ == "__main__":
157			storage_costs_example()
			0 ignored issues – show Comprehensibility Best Practice introduced 2025-02-28 16:08 UTC by Report Bug Copy Issue Report The variable `storage_costs_example` does not seem to be defined. Loading history...
158

oemof / oemof-solph

Push — dev ( 468d85...f4c061 )

storage_costs.storage_costs_example() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like