oemof's visualisation package

Installation

Use pypi to install the latest version. You can install the version just to plot graphs on oemof-solph results with .. code:: bash

pip install git+https://github.com/oemof/oemof_visio.git

or you can install the extra requirements to also produce an image of the energy system

pip install git+https://github.com/oemof/oemof_visio.git[network]

You can also clone this repository and install locally with

pip install .

or

pip install .[network]

Special for Windows in case of optional network setting: download Graphviz (https://graphviz.org/download/) install it on your system -> activate "add PATH" variables during installation process otherwise the executable cannot be found. Afterwards, restart your environment.

Examples

Have a look at the plotting examples at the 'oemof_example' repository to learn how to create the following examples.

(scientifically correct)

(smooth)

Render energy system

To render the component of an energy system, you can insert this code before you turn your EnergySytem instance into a model (not well suited for very large models).

from oemof_visio import ESGraphRenderer
esgr = ESGraphRenderer(
    <your EnergySystem instance>,
    legend=True,
    filepath="full path including filename without extension",
    img_format="pdf"
)
esgr.render()

Sankey diagramm

To produce a sankey diagramm from the raw oemof-solph results you can use this code snippet into your own model file

import plotly.io as pio

from oemof_visio import ESGraphRenderer
esgr = ESGraphRenderer(<your EnergySystem instance>)

# after the solve method of the model has been called
results = solph.processing.results(model)
fig_dict = esgr.sankey(results)
pio.show(fig_dict)