bluemira.balance_of_plant.plotting

Plotting for balance of plant

Attributes

BALANCE_PLOT_DEFAULTS

Classes

`SuperSankey`	A sub-class of the Sankey diagram class from matplotlib, which is capable
`BalanceOfPlantPlotter`	The plotting object for the BalanceOfPlant system. Builds a relatively

Module Contents

class bluemira.balance_of_plant.plotting.SuperSankey(ax=None, scale=1.0, unit='', format='%G', gap=0.25, radius=0.1, shoulder=0.03, offset=0.15, head_angle=100, margin=0.4, tolerance=1e-06, **kwargs)

Bases: matplotlib.sankey.Sankey

A sub-class of the Sankey diagram class from matplotlib, which is capable of connecting two blocks, instead of just one. This is done using a cute sledgehammer approach, using optimisation. Basically, the Sankey object is quite complex, and it makes it very hard to calculate the exact lengths required to connect two sub-diagrams.

Add a simple Sankey diagram with flows at the same hierarchical level.

Parameters:

patchlabel (str) – Label to be placed at the center of the diagram. Note that label (not patchlabel) can be passed as keyword argument to create an entry in the legend.
flows (list of float) –
Array of flow values. By convention, inputs are positive and outputs are negative.

Flows are placed along the top of the diagram from the inside out in order of their index within flows. They are placed along the sides of the diagram from the top down and along the bottom from the outside in.

If the sum of the inputs and outputs is nonzero, the discrepancy will appear as a cubic Bézier curve along the top and bottom edges of the trunk.
orientations (list of {-1, 0, 1}) – List of orientations of the flows (or a single orientation to be used for all flows). Valid values are 0 (inputs from the left, outputs to the right), 1 (from and to the top) or -1 (from and to the bottom).
labels (list of (str or None)) – List of labels for the flows (or a single label to be used for all flows). Each label may be None (no label), or a labeling string. If an entry is a (possibly empty) string, then the quantity for the corresponding flow will be shown below the string. However, if the unit of the main diagram is None, then quantities are never shown, regardless of the value of this argument.
trunklength (float) – Length between the bases of the input and output groups (in data-space units).
pathlengths (list of float) – List of lengths of the vertical arrows before break-in or after break-away. If a single value is given, then it will be applied to the first (inside) paths on the top and bottom, and the length of all other arrows will be justified accordingly. The pathlengths are not applied to the horizontal inputs and outputs.
prior (int) – Index of the prior diagram to which this diagram should be connected.
connect ((int, int)) – A (prior, this) tuple indexing the flow of the prior diagram and the flow of this diagram which should be connected. If this is the first diagram or prior is None, connect will be ignored.
rotation (float) – Angle of rotation of the diagram in degrees. The interpretation of the orientations argument will be rotated accordingly (e.g., if rotation == 90, an orientations entry of 1 means to/from the left). rotation is ignored if this diagram is connected to an existing one (using prior and connect).
**kwargs – Additional keyword arguments set matplotlib.patches.PathPatch properties, listed below. For example, one may want to use fill=False or label="A legend entry".
%(Patch (kwdoc)s)
future (int | None)

Returns:

The current .Sankey instance.

Return type:

Sankey