gwf-graph

Under development.

Generates a graph visualization of the dependency graph in the gwf workflow. Optionally, the status of the targets can be included, providing insight into the workflow's current state.

  CANCELLED
  FAILED
  COMPLETED
  RUNNING
  SUBMITTED
  SHOULDRUN

Installation

Ensure the necessary dependencies gwf and gwf-utilization are installed into your Conda environment before installing the gwf-graph plugin. If these are not installed yet, follow the first step; otherwise, proceed directly yo the second step.

1. Install dependencies

   # Install 'gwf' and 'gwf-utilization' using Conda
   conda install gwf micknudsen::gwf-utilization

2. Install the plugin

   # Install 'gwf-graph' directly from the GitHub repository
   pip install -U git+https://github.com/jakobjn/gwf-graph.git@master

Usage

Usage: gwf graph [OPTIONS]

  Generates a graph visualization of the dependency graph in the gwf workflow.
  Optionally, the status of the targets can be included, providing insight
  into the workflow's current state.

Options:
  -o, --output TEXT       The name (and path) of the output graph
                          visualization. Must end with a valid graphviz format
                          (e.g. png, svg, etc.). Defaults to 'workflow.png'.
  --status / --no-status  Flag to include the status (e.g., running,
                          completed, failed) of each target in the graph.
  --help                  Show this message and exit.