Skip to main content

oemof’s visualisation package badge

Installation

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

pip install oemof.visio

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

pip install oemof.visio[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)

docs/io_plot.png

(smooth)

docs/io_plot_smooth_pre.png

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)

Metadata

Release files for oemof.visio 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for oemof.visio 0.0.2
File Size Uploaded
oemof_visio-0.0.2.tar.gz 128.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for oemof.visio 0.0.2
File Interpreter ABI Platform
oemof_visio-0.0.2-py3-none-any.whl Python 3 none any Details

Total release size: 138.9 kB

Release files / oemof_visio-0.0.2.tar.gz

Download URL oemof_visio-0.0.2.tar.gz
Size 128.9 kB
Tags Source
SHA-256 checksum
How to use checksums
7d1ea68b45b0ee976c6f45d7cbfb8dda6a8bd59ad75ebffe6ea11320f13d00a4
BLAKE2b-256 checksum
How to use checksums
952f1a6904fd4deb2b9b28866849fc66575077eb758a651617158b25bacd7479
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release files / oemof_visio-0.0.2-py3-none-any.whl

Download URL oemof_visio-0.0.2-py3-none-any.whl
Size 10.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e4ad18c63eb2fbd9c430b2564c3b9fc34a38599279eba41c435949774029a1fa
BLAKE2b-256 checksum
How to use checksums
1b851696726e7e19ff8d6e33ee1f72cb161f90bddbe035696cf6784e23d1336e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page