transshipment.main() - Code Metrics - Inspection of "Add examples from oemof-examples" - oemof/oemof-solph - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — dev (#850)

by Uwe

created 2022-11-10 19:41 UTC

transshipment.main() B

↳ Parent: transshipment

Complexity

Conditions

Size

Total Lines	78
Code Lines	45

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	45
dl	0
loc	78
rs	8.8
c	0
b	0
f	0
cc	2
nop	0

How to fix Long Method

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

"""
General description:
---------------------
This script shows how use the custom component `solph.custom.Link` to build
a simple transshipment model.


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

    pip install oemof.solph[examples]

To draw the graph pygraphviz is required, installed by:

    pip install pygraphviz

License
-------
Simon Hilpert - 12.12.2017 - [email protected]

`MIT license <https://github.com/oemof/oemof-solph/blob/dev/LICENSE>`_
"""
import networkx as nx
import pandas as pd
from matplotlib import pyplot as plt
from oemof.network.graph import create_nx_graph

# oemof imports
from oemof.solph import Bus
from oemof.solph import EnergySystem
from oemof.solph import Flow
from oemof.solph import Investment
from oemof.solph import Model
from oemof.solph import components as cmp
from oemof.solph import processing
from oemof.solph import views
from oemof.solph.components.experimental import Link

try:
    import pygraphviz as pygz
except ModuleNotFoundError:
    pygz = None


def draw_graph(

    grph,
    edge_labels=True,
    node_color="#AFAFAF",
    edge_color="#CFCFCF",
    plot=True,
    node_size=2000,
    with_labels=True,
    arrows=True,
    layout="neato",
):
    """
    Draw a graph. This function will be removed in future versions.

    Parameters
    ----------
    grph : networkxGraph
        A graph to draw.
    edge_labels : boolean
        Use nominal values of flow as edge label
    node_color : dict or string
        Hex color code oder matplotlib color for each node. If string, all
        colors are the same.

    edge_color : string
        Hex color code oder matplotlib color for edge color.

    plot : boolean
        Show matplotlib plot.

    node_size : integer
        Size of nodes.

    with_labels : boolean
        Draw node labels.

    arrows : boolean
        Draw arrows on directed edges. Works only if an optimization_model has
        been passed.
    layout : string
        networkx graph layout, one of: neato, dot, twopi, circo, fdp, sfdp.
    """
    if isinstance(node_color, dict):
        node_color = [node_color.get(g, "#AFAFAF") for g in grph.nodes()]

    # set drawing options
    options = {
        "prog": "dot",
        "with_labels": with_labels,
        "node_color": node_color,
        "edge_color": edge_color,
        "node_size": node_size,
        "arrows": arrows,
    }

    # draw graph
    pos = nx.drawing.nx_agraph.graphviz_layout(grph, prog=layout)

    nx.draw(grph, pos=pos, **options)

    # add edge labels for all edges
    if edge_labels is True and plt:
        labels = nx.get_edge_attributes(grph, "weight")
        nx.draw_networkx_edge_labels(grph, pos=pos, edge_labels=labels)

    # show output
    if plot is True:
        plt.show()


def main():
    datetimeindex = pd.date_range("1/1/2017", periods=3, freq="H")

    es = EnergySystem(timeindex=datetimeindex, infer_last_interval=False)

    b_0 = Bus(label="b_0")

    b_1 = Bus(label="b_1")

    es.add(b_0, b_1)

    es.add(
        Link(
            label="line_0",
            inputs={b_0: Flow(), b_1: Flow()},
            outputs={
                b_1: Flow(investment=Investment()),
                b_0: Flow(investment=Investment()),
            },
            conversion_factors={(b_0, b_1): 0.95, (b_1, b_0): 0.9},
            limit_direction=False,
        )
    )

    es.add(
        cmp.Source(
            label="gen_0",
            outputs={b_0: Flow(nominal_value=100, variable_costs=50)},
        )
    )

    es.add(
        cmp.Source(
            label="gen_1",
            outputs={b_1: Flow(nominal_value=100, variable_costs=50)},
        )
    )

    es.add(
        cmp.Sink(
            label="load_0", inputs={b_0: Flow(nominal_value=150, fix=[0, 1])}
        )
    )

    es.add(
        cmp.Sink(
            label="load_1", inputs={b_1: Flow(nominal_value=150, fix=[1, 0])}
        )
    )

    m = Model(energysystem=es)

    # m.write('transshipment.lp', io_options={'symbolic_solver_labels': True})

    m.solve(solver="cbc", solve_kwargs={"tee": True, "keepfiles": False})

    m.results()

    graph = create_nx_graph(es, m)

    if pygz is not None:
        draw_graph(
            graph,
            plot=True,
            layout="neato",
            node_size=3000,
            node_color={"b_0": "#cd3333", "b_1": "#7EC0EE", "b_2": "#eeac7e"},
        )

    results = processing.results(m)

    print(views.node(results, "gen_0"))
    print(views.node(results, "gen_1"))

    views.node(results, "line_0")["sequences"].plot(kind="bar")

    # look at constraints of Links in the pyomo model LinkBlock
    m.LinkBlock.pprint()


if __name__ == "__main__":
    main()


1		# -- coding: utf-8 --
2
3		"""
4		General description:
5		---------------------
6		This script shows how use the custom component `solph.custom.Link` to build
7		a simple transshipment model.
8
9
10		Installation requirements
11		-------------------------
12		This example requires oemof.solph (v0.5.x), install by:
13
14		pip install oemof.solph[examples]
15
16		To draw the graph pygraphviz is required, installed by:
17
18		pip install pygraphviz
19
20		License
21		-------
22		Simon Hilpert - 12.12.2017 - [email protected]
23
24		`MIT license <https://github.com/oemof/oemof-solph/blob/dev/LICENSE>`_
25		"""
26		import networkx as nx
27		import pandas as pd
28		from matplotlib import pyplot as plt
29		from oemof.network.graph import create_nx_graph
30
31		# oemof imports
32		from oemof.solph import Bus
33		from oemof.solph import EnergySystem
34		from oemof.solph import Flow
35		from oemof.solph import Investment
36		from oemof.solph import Model
37		from oemof.solph import components as cmp
38		from oemof.solph import processing
39		from oemof.solph import views
40		from oemof.solph.components.experimental import Link
41
42		try:
43		import pygraphviz as pygz
44		except ModuleNotFoundError:
45		pygz = None
46
47
48	View Code Duplication	def draw_graph(
		0 ignored issues – show Duplication introduced 2022-06-24 10:10 UTC by Report Bug Copy Issue Report This code seems to be duplicated in your project. Loading history...
49		grph,
50		edge_labels=True,
51		node_color="#AFAFAF",
52		edge_color="#CFCFCF",
53		plot=True,
54		node_size=2000,
55		with_labels=True,
56		arrows=True,
57		layout="neato",
58		):
59		"""
60		Draw a graph. This function will be removed in future versions.
61
62		Parameters
63		----------
64		grph : networkxGraph
65		A graph to draw.
66		edge_labels : boolean
67		Use nominal values of flow as edge label
68		node_color : dict or string
69		Hex color code oder matplotlib color for each node. If string, all
70		colors are the same.
71
72		edge_color : string
73		Hex color code oder matplotlib color for edge color.
74
75		plot : boolean
76		Show matplotlib plot.
77
78		node_size : integer
79		Size of nodes.
80
81		with_labels : boolean
82		Draw node labels.
83
84		arrows : boolean
85		Draw arrows on directed edges. Works only if an optimization_model has
86		been passed.
87		layout : string
88		networkx graph layout, one of: neato, dot, twopi, circo, fdp, sfdp.
89		"""
90		if isinstance(node_color, dict):
91		node_color = [node_color.get(g, "#AFAFAF") for g in grph.nodes()]
92
93		# set drawing options
94		options = {
95		"prog": "dot",
96		"with_labels": with_labels,
97		"node_color": node_color,
98		"edge_color": edge_color,
99		"node_size": node_size,
100		"arrows": arrows,
101		}
102
103		# draw graph
104		pos = nx.drawing.nx_agraph.graphviz_layout(grph, prog=layout)
105
106		nx.draw(grph, pos=pos, **options)
107
108		# add edge labels for all edges
109		if edge_labels is True and plt:
110		labels = nx.get_edge_attributes(grph, "weight")
111		nx.draw_networkx_edge_labels(grph, pos=pos, edge_labels=labels)
112
113		# show output
114		if plot is True:
115		plt.show()
116
117
118		def main():
119		datetimeindex = pd.date_range("1/1/2017", periods=3, freq="H")
120
121		es = EnergySystem(timeindex=datetimeindex, infer_last_interval=False)
122
123		b_0 = Bus(label="b_0")
124
125		b_1 = Bus(label="b_1")
126
127		es.add(b_0, b_1)
128
129		es.add(
130		Link(
131		label="line_0",
132		inputs={b_0: Flow(), b_1: Flow()},
133		outputs={
134		b_1: Flow(investment=Investment()),
135		b_0: Flow(investment=Investment()),
136		},
137		conversion_factors={(b_0, b_1): 0.95, (b_1, b_0): 0.9},
138		limit_direction=False,
139		)
140		)
141
142		es.add(
143		cmp.Source(
144		label="gen_0",
145		outputs={b_0: Flow(nominal_value=100, variable_costs=50)},
146		)
147		)
148
149		es.add(
150		cmp.Source(
151		label="gen_1",
152		outputs={b_1: Flow(nominal_value=100, variable_costs=50)},
153		)
154		)
155
156		es.add(
157		cmp.Sink(
158		label="load_0", inputs={b_0: Flow(nominal_value=150, fix=[0, 1])}
159		)
160		)
161
162		es.add(
163		cmp.Sink(
164		label="load_1", inputs={b_1: Flow(nominal_value=150, fix=[1, 0])}
165		)
166		)
167
168		m = Model(energysystem=es)
169
170		# m.write('transshipment.lp', io_options={'symbolic_solver_labels': True})
171
172		m.solve(solver="cbc", solve_kwargs={"tee": True, "keepfiles": False})
173
174		m.results()
175
176		graph = create_nx_graph(es, m)
177
178		if pygz is not None:
179		draw_graph(
180		graph,
181		plot=True,
182		layout="neato",
183		node_size=3000,
184		node_color={"b_0": "#cd3333", "b_1": "#7EC0EE", "b_2": "#eeac7e"},
185		)
186
187		results = processing.results(m)
188
189		print(views.node(results, "gen_0"))
190		print(views.node(results, "gen_1"))
191
192		views.node(results, "line_0")["sequences"].plot(kind="bar")
193
194		# look at constraints of Links in the pyomo model LinkBlock
195		m.LinkBlock.pprint()
196
197
198		if __name__ == "__main__":
199		main()
200

oemof / oemof-solph

Pull Request — dev (#850)

transshipment.main() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like