Source code for openmdao.util.dotgraph

import os
import sys
import webbrowser

import networkx as nx
from openmdao.main.interfaces import IDriver
from openmdao.main.depgraph import DependencyGraph, is_var_node
from openmdao.main.problem_formulation import ArchitectureAssembly

_cluster_count = 0

def write_driver_cluster(f, G, driver, indent, counts, alledges, excludes=()):
[docs] global _cluster_count, IDriver show = not in excludes comps = list(driver.workflow) subG = G.subgraph([ for c in comps]) tab = ' '*indent if show: f.write('%ssubgraph cluster%s {\n' % (tab, _cluster_count)) _cluster_count += 1 indent += 3 tab = ' '*indent f.write('%s%s [shape=invhouse];\n' % (tab, if len(comps) > 0: dcount = 1 for comp in comps: if IDriver.providedBy(comp): write_driver_cluster(f, G, comp, indent, counts, alledges) f.write("%s%s -> %s [style=dashed, label=%d];\n" % (tab,,, dcount)) alledges.add((, dcount += 1 subG = G.subgraph([ for c in comps]) edges = subG.edges() # now remove subdrivers subG.remove_nodes_from([ for c in comps if IDriver.providedBy(c)]) write_nodes(f, subG, indent, counts, for u,v in edges: alledges.add((u,v)) if counts[u] > 0: u = '"%s@%s"' % (u, if counts[v] > 0: v = '"%s@%s"' % (v, f.write('%s%s -> %s;\n' % (tab, u, v)) for pname in driver.list_pseudocomps(): f.write('%s%s -> %s [style=dotted];\n' % (tab, pname, alledges.add((pname, f.write('%s}\n' % tab) def write_nodes(f, G, indent, counts, parent):
[docs] for node, data in G.nodes_iter(data=True): counts[node] -= 1 if counts[node] > 0: data['label'] = node node = '%s@%s' % (node, parent) data['style'] = 'filled' data['fillcolor'] = 'gray' write_node(f, G, node, indent) def write_node(f, G, node, indent):
[docs] data = G.node[node] assigns = ['%s=%s' % (k,v) for k,v in data.items()] f.write('%s"%s" [%s];\n' % (' '*indent, node, ','.join(assigns))) def _get_comp_counts(drv, counts):
for comp in drv.workflow: counts[] += 1 if IDriver.providedBy(comp): _get_comp_counts(comp, counts) def write_workflow_dot(G, dotfile, scope=None, excludes=()):
[docs] if scope is None: raise RuntimeError("if workflow is True, scope must be specified") with open(dotfile, 'w') as f: indent = 3 f.write("strict digraph {\n") driver = getattr(scope, 'driver') f.write(" driver [shape=invhouse, margin=0.0];\n") # find any components that appear in multiple workflows counts = dict([(n,0) for n in G.nodes()]) _get_comp_counts(driver, counts) if scope and isinstance(scope, ArchitectureAssembly): for pcomp in scope.list_pseudocomps(): write_node(f, G, pcomp, indent) alledges = set() write_driver_cluster(f, G, driver, indent, counts, alledges, excludes=excludes) #write_nodes(f, G, 3, counts, 'driver') # now include any cross workflow connections for u,v in G.edges_iter(): if (u,v) not in alledges: f.write(" %s -> %s;\n" % (u, v)) f.write("}\n") def _update_graph_metadata(G, scope):
nmeta = G.node conns = [] for node, data in G.nodes_iter(data=True): data = data.copy() # don't corrupt metadata of other subgraphs/parent graphs nmeta[node] = data if 'pseudo' in data: data['label'] = node.replace('_pseudo_', '_p_') # shorten all pseudocomp names data['shape'] = 'diamond' elif 'driver' in data: data['shape'] = 'invhouse' if scope: driver = getattr(scope, node) for pcomp in driver.list_pseudocomps(): conns.append((pcomp, node)) if hasattr(driver, 'list_param_targets'): conns.extend([(node, p) for p in driver.list_param_targets()]) elif 'comp' in data: data['shape'] = 'box' else: # var node parts = node.split('.', 1) if len(parts) > 1 and not is_var_node(G, parts[0]): data['label'] = parts[1] base = G.base_var(node) if G.node[base].get('iotype') == 'state': data['shape'] = 'doubleoctagon' else: data['shape'] = 'ellipse' data['margin'] = '0.0' G.add_edges_from(conns, style='dotted') def plot_graph(G, fmt='pdf', outfile=None, pseudos=True, workflow=False, scope=None,
[docs] excludes=()): """Create a plot of the given graph""" G = G.subgraph(G.nodes_iter()) if isinstance(G, DependencyGraph): if workflow: G = G.component_graph() else: if scope: for cname in scope.list_containers(): comp = getattr(scope, cname) if hasattr(comp, 'list_param_targets'): for target in comp.list_param_targets(): G.node[target]['param'] = True G.prune_unconnected_vars() if not pseudos: nodes = [n for n in G.nodes() if '_pseudo_' in n] G.remove_nodes_from(nodes) _update_graph_metadata(G, scope) if outfile is None: outfile = 'graph.'+fmt dotfile = os.path.splitext(outfile)[0]+'.dot' if workflow: write_workflow_dot(G, dotfile, scope, excludes) else: # just show data connections nx.write_dot(G, dotfile) os.system("dot -T%s -o %s %s" % (fmt, outfile, dotfile)) if sys.platform == 'darwin': os.system('open %s' % outfile) else: webbrowser.get().open(outfile) #os.remove(dotfile) def plot_graphs(obj, recurse=True, fmt='pdf', pseudos=False, workflow=False):
[docs] from openmdao.main.assembly import Assembly from openmdao.main.driver import Driver print "plot_graphs for %s" % if isinstance(obj, Assembly): if == '': = 'top' try: plot_graph(obj._depgraph, fmt=fmt,'_depgraph'+'.'+fmt, pseudos=pseudos) except Exception as err: print "Can't plot depgraph of '%s': %s" % (, str(err)) try: plot_graph(obj._depgraph.component_graph(), fmt=fmt,'_compgraph'+'.'+fmt, pseudos=pseudos, workflow=workflow, scope=obj) except Exception as err: print "Can't plot component_graph of '%s': %s" % (, str(err)) if recurse: plot_graphs(obj.driver, recurse, fmt=fmt, pseudos=pseudos, workflow=workflow) elif isinstance(obj, Driver): try: plot_graph(obj.workflow.derivative_graph(), fmt=fmt,"_derivgraph"+'.'+fmt, pseudos=pseudos, workflow=workflow, scope=obj.parent) except Exception as err: print "Can't plot deriv graph of '%s': %s" % (, str(err)) if recurse: for comp in obj.iteration_set(): if isinstance(comp, Assembly) or isinstance(comp, Driver): plot_graphs(comp, recurse, fmt=fmt, pseudos=pseudos, workflow=workflow) def main():
[docs] from argparse import ArgumentParser import inspect from openmdao.main.assembly import Assembly, set_as_top parser = ArgumentParser() parser.add_argument('-m', '--module', action='store', dest='module', metavar='MODULE', help='name of module that contains the class to be instantiated and graphed') parser.add_argument('-c', '--class', action='store', dest='klass', help='specify class in module to plot graphs for') parser.add_argument('-f', '--fmt', action='store', dest='fmt', default='pdf', help='specify output format') parser.add_argument('-r', '--recurse', action='store_true', dest='recurse', help='if set, recurse down and plot all dependency, component, and derivative graphs') parser.add_argument('-p', '--pseudos', action='store_false', dest='pseudos', help='if set, include pseudo components in graphs') parser.add_argument('-w', '--workflow', action='store_true', dest='workflow', help='if set, group graph components into workflows') options = parser.parse_args() if options.module is None: parser.print_help() sys.exit(-1) __import__(options.module) mod = sys.modules[options.module] if options.klass: obj = getattr(mod, options.klass)() else: def isasm(obj): try: return issubclass(obj, Assembly) and obj is not Assembly except: return False klasses = inspect.getmembers(mod, isasm) if len(klasses) > 1: print "found %d Assembly classes. you must specify 1" % len(klasses) for i, (cname, klass) in enumerate(klasses): print "%d) %s" % (i, cname) var = raw_input("\nEnter a number: ") obj = klasses[int(var)][1]() sys.exit(-1) elif klasses: obj = klasses[0][1]() else: print "No classes found" set_as_top(obj) if not obj.get_pathname(): = 'top' plot_graphs(obj, recurse=options.recurse, fmt=options.fmt, pseudos=options.pseudos, workflow=options.workflow) if __name__ == '__main__':
OpenMDAO Home