show_graph

This is part of the cltools module

show_graph is a tool that takes a plumed input and generates a graph showing how data flows through the action set involved.

If this tool is invoked without the –force keyword then the way data is passed through the code during the forward pass through the action is shown.

When the –force keyword is used then the way forces are passed from biases through actions is shown.

Examples

The following generates the mermaid file for the input in plumed.dat

plumed show_graph --plumed plumed.dat

Glossary of keywords and components

Compulsory keywords

--plumed	( default=plumed.dat ) the plumed input that we are generating the graph for
--out	( default=graph.md ) the dot file containing the graph that has been generated

Options

--help/-h	( default=off ) print this help
--force	( default=off ) print a graph that shows how forces are passed through the actions