Energy Pipeline Documentation

Welcome to the documentation of the Energy Pipeline, a tool for detecting energy regressions in Git repositories across commits.

User Guide

• 🛠 Installation Guide
  • 📦 Requirements
  • 🐍 Python Environment
  • 🧰 System Setup
  • 🔐 Permissions
  • 🐳 Optional: Docker Setup
  • 💡 Recommended Setup for Accurate Measurement
  • 🧪 Validate Setup
  • ✅ Installation Recap
• Usage Guide
  • 🧩 Overview
  • 📁 1. Prepare a Configuration File
  • 🛠️ 2. System Preparation
  • 🚀 3. Run the Pipeline
  • 📊 4. Sort the Results (Optional)
  • 📈 5. Generate Plots
  • 🐳 Optional: Run in Docker
  • 🧠 Tips
  • ✅ Output
  • 📌 Recap
• ⚙️ Pipeline Stages
  • 🧱 Stage Categories
  • 📦 Shared Context
  • 🧩 Stage Interface
  • 🔍 Pre-Stages (run once per batch)
  • 🏗️ Pre-Test Stages (run once per commit, in parallel)
  • 🔁 Batch Stages (run for each execution of each commit)
  • 🧠 Execution Flow Summary
  • ⚠️ Stage Aborts
  • ✅ Adding New Stages
  • 💡 Example: Writing a Custom Stage
  • 📚 Related Files
• 💻 CLI Reference
  • 🧾 Usage
  • 📌 Available Commands
  • 🔍 measure
  • 🧪 stability-test
  • 📊 plot
  • 🔃 sort
  • 🧠 Internals Summary
  • 🧪 Quick Test Run
• 🏗️ Pipeline Architecture
  • ⚙️ Modular Stage Pipeline
  • 🧱 Stage Categories
  • 🔁 Execution Flow
  • 🧠 Shared Context
  • 🔌 Plugin System for Stages
  • 📁 Directory Layout
  • 🛠 Example Execution Flow (High-Level)
  • 💡 Design Principles
  • 🔄 Parallelism Strategy
  • 🚀 Optimization Ideas (Planned)
  • 🔍 Related Files
• 📖 How to Build and Launch Sphinx Docs
  • 🛠️ Install Dependencies
  • 📁 Folder Structure (minimal example)
  • 🧱 Generate API Docs (Optional)
  • 🔨 Build the Docs
• energytrackr
  • energytrackr package