aiida.tools.visualization package

Submodules

Draw the provenance graphs

aiida.tools.visualization.graphviz.draw_graph(origin_node, ancestor_depth=None, descendant_depth=None, image_format='dot', include_calculation_inputs=False, include_calculation_outputs=False)[source]

The algorithm starts from the original node and goes both input-ward and output-ward via a breadth-first algorithm.

Parameters:
  • origin_node – An Aiida node, the starting point for drawing the graph
  • ancestor_depth (int) – The maximum depth of the ancestors drawn. If left to None, we recurse until the graph is fully explored
  • descendant_depth (int) – The maximum depth of the descendants drawn. If left to None, we recurse until the graph is fully explored
  • image_format (str) – The output plot format, by default dot
Returns:

The exit_code of the subprocess.call() method that produced the valid file
Returns:

The file name of the final output
..note::
If an invalid format is provided graphviz prints a helpful message, so this doesn’t need to be implemented here.