Docs / Examples

Use these short recipes as copy-paste starting points.

1. Fast COP run from Verilog (Genus mode)

python3 opentest --genus cop -i designs/priority_enc.v -j

Use this when you need quick controllability/observability metrics for ranking weak signals.

2. End-to-end TPI flow (Genus mode)

python3 opentest --genus cop -i designs/priority_enc.v -j
python3 opentest --genus tpi -i <netlist.json> -m <metrics.json> -t 50 -n 10 -v

Result: enhanced Verilog in the TPI output area plus verbose logs/reports.

3. Streamlined Yosys flow

python3 opentest --yosys scoap -i <design.json>
python3 opentest --yosys analyze_and_add_tp -i <design.json> --scoap -t 50 -m 10 -v

Use this when your source of truth is Yosys JSON.

4. Verbose diagnostics session

python3 opentest --genus --verbose scoap -i designs/s27.v
python3 opentest --genus --verbose cop -i designs/s27.v -j

Verbose mode writes detailed logs to results/log/ and reports to results/reports/.

5. Compare reconvergence algorithms

python3 opentest --genus cop -i designs/pipelined_multiplier.v -r -a basic -j
python3 opentest --genus cop -i designs/pipelined_multiplier.v -r -a simple -j
python3 opentest --genus cop -i designs/pipelined_multiplier.v -r -a advanced -j

Start with simple in production and move to advanced only for difficult correlation cases.