graph

• Author: Adam McDaniel
• GitHub: adam-mcdaniel/graph
• License: MIT

Graph is a Graphviz interface library for Rust, designed to make it easy to create graphs using Rust code without directly having to write Graphviz code.

Table of Contents

• Usage
  • Installation
  • Creating a Simple Graph
  • Building Complex Diagrams
• About the Author
• Documentation
• License

Usage

Installation

Add graph to your Cargo.toml:

[dependencies]
graph = { git = "https://github.com/adam-mcdaniel/graph" }

Creating a Simple Graph

Here’s a basic example of how to create a simple graph with two nodes and an edge between them:

use std::path::Path;
use graph::{Graph, ID};

fn main() {
    let mut g = Graph::new()
        .with_property("rankdir", "LR"); // Left to Right layout

    let node_a = g.new_node("A")
        .with_property("label", "Node A")
        .finalize();

    let node_b = g.new_node("B")
        .with_property("label", "Node B")
        .finalize();

    g.new_edge(node_a, node_b)
        .with_property("label", "A to B")
        .finalize();

    g.save_svg(&Path::new("simple_graph.svg"));
}

Building More Complex Diagrams

Here's a visualization of the 6502 CPU architecture using graph:

fn cpu_6502_diagram() {
    let mut g = Graph::new()
        .with_property("rankdir", "TB")
        .with_property("nodesep", "0.5")
        .with_property("layout", "fdp");

    let cpu = g.new_record("CPU_6502", 5, 20)
        .insert(2, 0, "6502\\nCPU")
        .insert(1, 0, "1")
        .insert(1, 1, "2")
        // ...
        .insert(4, 19, "VSS")
        .finalize();
    
    let a = g.new_node("Complex Wiring Stuff")
        .with_property("label", "Complex Wiring Stuff")
        .with_property("pos", "-6,0!")
        .finalize();
    let b = g.new_node("Other Complex Wiring Stuff")
        .with_property("label", "Other Complex Wiring Stuff")
        .with_property("pos", "6,0!")
        .finalize();

    for y in 0..20 {
        g.new_edge(cpu[4][y], b)
            .finalize();

        g.new_edge(a, cpu[0][y])
            .finalize();
    }

    g.save_svg(&Path::new("cpu_6502.svg"));
}

About the Author

I'm a computer science PhD student at the University of Tennessee, Knoxville🍊. Rust is my favorite language, and I've written many other programming languages.

I'm always looking for new projects to work on, so if you have an idea for a project or a collaboration, feel free to reach out to me or join me on the Sage Discord server!

Documentation

For more information on how to use Graph, see the documentation.

License

This project is licensed under the MIT License - see the LICENSE file for details.