oemof.outputlib package

Submodules

oemof.outputlib.devplots module

class oemof.outputlib.devplots.stackplot(**kwargs)[source]

Bases: object

Creates a plot around a bus with all inputs as bar plots and all outputs as lineplots.

Parameters:
  • plot_dc (dictionary of pandas.DataFrame) – A dictionary with the keys ‘in’ and ‘out’ containing a DataFrame with all input time series (‘in’) and all output time series ‘out’.
  • es (oemof.core.EnergySystem object) – An EnergySystem object containing a results dictionary.
plot_dc

dictionary of pandas.DataFrame

A dictionary with the keys ‘in’ and ‘out’ containing a DataFrame with all input time series (‘in’) and all output time series ‘out’.

es

oemof.core.EnergySystem object

An EnergySystem object containing a results dictionary.

Note

The EnergySystem object needs to have a results dictionary.

core(eid, ax, kind, prange, **kwargs)[source]

Plotting a DataFrame of the dictionary.

Parameters:
  • eid (str) – The key of the plot_dc dictionary.
  • ax (matplotlib artist object) – If an artist object is passed the plot will be added to this artist object.
  • kind (string) – The type of the plot (‘bar’, ‘line’, ...). See the pandas plot documentation for more information.
  • prange (range of the pandas index) – The range of the pandas.DataFrame to be plotted. The range should be of the same time a the DataFrame index.
Returns:
Return type:

matplotlib artis object
create_fig(figw=24, figh=14, fontl=14, fontg=19)[source]

Creating a matplotlib figure object.

Parameters:
  • figw (float or int) – Width of the figure object (default: 24).
  • figh (float or int) – Height of the figure object (default: 14).
  • fontg (float or int) – General font size within the plot (default: 19).
  • fontl (float or int) – Font size of the legend (default: 14).
create_io_df(uid)[source]

Create a dictionary of DataFrames containing all time series around a bus.

The returned dictionary has two keys (‘in’, ‘out’) that contain the DataFrame of the incoming and outgonig flows of the bus.

Parameters:uid (string or tuple) – The uid of the bus, that should be plotted
Returns:dictionary
Return type:Dicionary of DataFrames
full(prange, **kwargs)[source]

Create a full plot of a valid plot_dc dictionary

Parameters:
  • prange (range of the pandas index) – The range of the pandas.DataFrame to be plotted. The range should be of the same time a the DataFrame index. The DataFrames are part of the plot_dc dictionary with the keys ‘in’ and ‘out’.
  • **kwargs (keyword arguments) – Additional arguments to be passed to the plotting command.
part(prange, ax, **kwargs)[source]

Create a part of plot within an existing artist object using a valid plot_dc dictionary.

Parameters:
  • prange (range of the pandas index) – The range of the pandas.DataFrame to be plotted. The range should be of the same time a the DataFrame index. The DataFrames are part of the plot_dc dictionary with the keys ‘in’ and ‘out’.
  • ax (matplotlib artist object) – The new plot will be added to this artist object.
  • **kwargs (keyword arguments) – Additional arguments to be passed to the plotting command.

Module contents