finesse.utilities.blockdiag module

finesse.utilities.blockdiag.display_blockdiag_output(cell, output_format='svg', return_svg=False)

When called in a Jupyter/Ipython environment the block diagram is displayed.

Parameters

output_formatstr

svg or png

return_svgbool

Returns SVG data if requested

finesse.utilities.blockdiag.display_loops_blockdiag(model, *nodes, remove_mechanical_to_mechanical=True, **kwargs)

Displays a block diagram of a model using the blockdiag package. Only signal path (electronic and mechanical) connections are shown.

Parameters

modelfinesse.model.Model

Model to display

*nodesiterable[str]

Nodes to include in the diagram. This will include any path that have the nodes in

remove_mechanical_to_mechanicalbool, optional

If true, mechanical to mechanical node edges

**kwargs

options to pass to get_loops_blockdiag_code().

Returns

Nothing if return_svg=False

finesse.utilities.blockdiag.get_loops_blockdiag_code(model, *nodes, file=<colorama.ansitowin32.StreamWrapper object>, remove_mechanical_to_mechanical=True)