RING-5 Documentation

Reproducible Instrumentation for Numerical Graphics for gem5

RING-5 turns raw gem5 simulator output into publication-ready figures through an interactive web interface. Parse stats files, transform data, build plots, and export – all without writing a single script.

---

Quick Links

Quick Start	Get up and running in 5 minutes
Installation	Detailed setup instructions
First Analysis	Step-by-step walkthrough
Web Interface	Dashboard reference
Creating Plots	Visualization options
Architecture	System design for contributors

---

For Users

Learn how to parse gem5 stats, transform your data, and create figures for your papers.

• Parsing gem5 Stats – scan variables, configure parsing, generate CSVs
• Data Transformations – normalize, aggregate, filter, sort
• Creating Plots – all plot types and customization options
• LaTeX Export – export figures for LaTeX documents
• Portfolios – save and restore complete analysis snapshots

Plot Types

• Bar Charts
• Grouped Stacked Bars
• Line Plots
• Scatter Plots
• Histograms

For Contributors

Understand the architecture and extend RING-5 with new plot types, shapers, or parser features.

• Development Setup – dev environment and workflow
• Testing Guide – writing and running tests
• Adding Plot Types – extend the visualization system
• Adding Shapers – create custom data transformations
• Architecture Overview – layered design, patterns, and conventions

API Reference

• Backend Facade
• Parsing API
• Plotting API
• Shaper API

Architecture Diagrams

• Full Architecture Diagram – complete module dependency graph
• Parsing Architecture – parser internals
• Services Architecture – services module design

---

Citation

@software{ring5,
  title  = {RING-5: Reproducible Instrumentation for Numerical Graphics for gem5},
  author = {Nicolas, V.},
  year   = {2026},
  url    = {https://github.com/nikiitin/RING-5}
}