llnl / llnl/Surfactant

Add output writer for Graphviz DOT format

Open
#71 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good first issue help wanted
Dominant language
Python
Stars
43
Forks
28
PR merge metrics
No merged PRs in 30d

Description

Add an output writer that outputs relationships in the Graphviz DOT format for generating a graph showing how different files tie together.

Resources for information on the file format include:
- https://graphviz.org/doc/info/lang.html
- https://en.wikipedia.org/wiki/DOT_(graph_description_language)

The graph "type" output should probably be digraph.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the repository's existing output writers and the dependency-relationship data they serialize. Use the linked Graphviz DOT language resources to define a valid digraph output, and consider the work done when file relationships can be represented as a Graphviz-renderable DOT graph.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-visualization, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.