PyUCIS Documentation

PyUCIS is a Python implementation of the Unified Coverage Interoperability Standard (UCIS) for storing, manipulating, and reporting functional verification coverage data.

Key Features:

• Multiple Backend Support - In-memory, SQLite, XML, and YAML backends

• SQLite Backend - Persistent, queryable storage with SQL access

• Native C Library - High-performance UCIS 1.0 C API with SQLite backend

• Full UCIS API - Complete implementation of the UCIS object-oriented API

• Coverage Reporting - Interactive HTML, JSON, XML, Cobertura, and text report formats

• Interactive HTML Reports - Single-file reports with visualizations, bin details, and filtering

• Interactive Terminal UI - Real-time coverage exploration with keyboard-driven navigation

• Coverage Merging - Combine coverage from multiple test runs

• Cross-Platform - Works on Linux, macOS, and Windows

Contents:

• Introduction
  • What is PyUCIS?
  • SQLite Backend
  • Object-Oriented API Example
  • Command-Line Tools
  • MCP Server for AI Integration
  • Contributors
• Commands
  • Sub-commands
• Interactive Terminal UI
  • Overview
  • Launch the TUI
  • TUI Views
  • Keyboard Shortcuts
  • Tips & Tricks
  • Color Scheme
  • Comparison: TUI vs. HTML Reports
  • CI/CD Integration
  • Troubleshooting
  • Examples
  • See Also
• Show Commands Reference
  • Overview
  • Available Commands
  • CI/CD Integration Examples
  • Output Formats
  • Common Options
  • Best Practices
• Verilator Coverage Import
  • Overview
  • Coverage Types Supported
  • Quick Start
  • Verilator Coverage Format
  • Generating Verilator Coverage
  • Workflow Examples
  • Advanced Usage
  • Implementation Details
  • Limitations
  • Troubleshooting
  • See Also
  • References
• MCP Server
  • Overview
  • Features
  • Installation
  • Usage
  • Available Tools
  • Export Formats
  • CI/CD Integration Examples
  • Development
  • Troubleshooting
  • Resources
  • License
• PyUCIS Reference
  • Coverage Report Object
  • JSON Coverage Report
  • HTML Coverage Report Format
  • XML Interchange Format
  • YAML Coverage Data Format
  • Best Practices for Recording Coverage
  • UCIS Object-Oriented API
  • UCIS C-Style API
  • SQLite Backend API
  • SQLite Schema Reference
  • Native C Library API
  • Back-End APIs

Indices and tables