Skip to content

Commit 52097a7

Browse files
author
Matthew Ballance
committed
TUI fixes and refinements
Signed-off-by: Matthew Ballance <matt.ballance@gmail.com>
1 parent ff26f80 commit 52097a7

23 files changed

Lines changed: 4573 additions & 201 deletions

examples/README.md

Lines changed: 45 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,66 @@
11
# PyUCIS Examples
22

3-
This directory contains example applications demonstrating PyUCIS usage.
3+
This directory contains examples demonstrating PyUCIS capabilities.
44

55
## Available Examples
66

7-
### Verilator Coverage Example
7+
### 1. Verilator Coverage Example
8+
**Directory:** [verilator/](verilator/)
89

9-
**Location:** `verilator/`
10+
Complete workflow for collecting coverage from Verilator simulations and converting to UCIS SQLite format.
1011

11-
**Description:** Complete workflow for collecting coverage from Verilator simulations and converting to UCIS SQLite format.
12+
**Features:**
13+
- SystemVerilog counter design with assertions and covergroups
14+
- Multiple test scenarios with coverage collection
15+
- Conversion from Verilator coverage format to UCIS SQLite
16+
- Database merging from multiple test runs
17+
- Interactive TUI and command-line reporting
18+
- ~6,000 coverage items (line, branch, toggle)
1219

1320
**Quick Start:**
1421
```bash
1522
cd verilator
16-
make run convert view
23+
make view # Build, run tests, merge, and launch TUI
1724
```
1825

26+
**See:** [verilator/README.md](verilator/README.md)
27+
28+
---
29+
30+
### 2. AI-Assisted Coverage Analysis
31+
**Directory:** [ai_assisted_workflow/](ai_assisted_workflow/)
32+
33+
🤖 Learn how AI agents can work with coverage data for intelligent analysis.
34+
1935
**Features:**
20-
- SystemVerilog counter design with covergroups
21-
- Automated build and test flow with Makefile
22-
- Verilator coverage collection (line, toggle, branch, expression)
23-
- Conversion from Verilator .dat to UCIS SQLite .cdb format
24-
- Interactive viewing with PyUCIS TUI
25-
- 218 coverage items across 17 design scopes
26-
27-
**Files:** ~1,100 lines of code including:
28-
- SystemVerilog design (counter.sv, counter_tb.sv)
29-
- Python conversion tool (verilator2ucis.py)
30-
- Build automation (Makefile)
31-
- Comprehensive documentation (README.md, EXAMPLE_SUMMARY.md)
32-
33-
**Requirements:**
34-
- Verilator 5.0+
35-
- Python 3.7+
36-
- PyUCIS
37-
38-
**See:** `verilator/README.md` for detailed documentation
36+
- 13 detailed scenarios with problem statements and AI prompts
37+
- Command selection and decision trees for AI agents
38+
- Test optimization and gap analysis workflows
39+
- CI/CD integration examples (LCOV, Cobertura)
40+
- Automated validation scripts
41+
42+
**Quick Start:**
43+
```bash
44+
cd ai_assisted_workflow
45+
./validate_ai_examples.sh # Validate setup
46+
cat AI_INDEX.md # Navigation hub
47+
```
48+
49+
**See:** [ai_assisted_workflow/README.md](ai_assisted_workflow/README.md)
3950

4051
---
4152

42-
## Contributing Examples
53+
## Which Example Should I Use?
4354

44-
To add a new example:
45-
1. Create a subdirectory with a descriptive name
46-
2. Include a README.md with usage instructions
47-
3. Provide working code and test data
48-
4. Update this file with a link to your example
55+
| If you want to... | Use this example |
56+
|-------------------|------------------|
57+
| Learn Verilator integration | [verilator/](verilator/) |
58+
| Collect coverage from RTL | [verilator/](verilator/) |
59+
| Build coverage flow | [verilator/](verilator/) |
60+
| Analyze existing coverage | [ai_assisted_workflow/](ai_assisted_workflow/) |
61+
| Automate coverage analysis | [ai_assisted_workflow/](ai_assisted_workflow/) |
62+
| Train AI agents | [ai_assisted_workflow/](ai_assisted_workflow/) |
4963

5064
## License
5165

52-
All examples are licensed under Apache License 2.0
66+
Apache License 2.0 - See LICENSE file in repository root

0 commit comments

Comments
 (0)