Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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 .. 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)

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.2a1

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.2a1
File Size Uploaded
oemof_visio-0.0.2a1.tar.gz 127.8 kB Details

Built distribution (wheel)

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

Total release size: 137.8 kB

Release files / oemof_visio-0.0.2a1.tar.gz

Download URL oemof_visio-0.0.2a1.tar.gz
Size 127.8 kB
Tags Source
SHA-256 checksum
How to use checksums
1d82de58f937ef6e4c57fbcaf60fba8a18a5466554dadb172562f9c810dd686d
BLAKE2b-256 checksum
How to use checksums
29ec5edc0b87ba8e22c5b1012566d90cf2ec2a26a83cb65e764d4de80635bcad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.1

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

Download URL oemof_visio-0.0.2a1-py3-none-any.whl
Size 10.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
89af0dcb37c5d7ce4769faedf240cb330cc6736d2c292dc2a0e2bb7f919be0a1
BLAKE2b-256 checksum
How to use checksums
129c6841048cd799d0837886ad8297f4ef93c51642a2b651aa20034ad7266945
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.1
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