Skip to content

docs: document LEC and SEC verification options #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nanocoh merged 1 commit into from
Jul 26, 2026
Merged

docs: document LEC and SEC verification options #168

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ build/src/bin/kepler-formal -sv -v sec \
| --- | --- |
| `--help`, `-h` | Print usage. |
| `--config <file>`, `-c <file>` | Load a YAML config. If present, the YAML file takes precedence over the rest of the CLI. |
| `--verification <lec\|sec>`, `-v <lec\|sec>` | Select combinational LEC or sequential SEC. Defaults to `lec`. |
| `-verilog` | Parse both designs as Verilog. |
| `-naja_if` | Parse both designs as Naja IF. |
| `-systemverilog`, `-sv` | Parse both designs as SystemVerilog. Requires SEC. |
Expand All @@ -176,6 +177,7 @@ build/src/bin/kepler-formal --config <file.yaml>
| Key | Type | Meaning |
| --- | --- | --- |
| `format` | string | `verilog`, `v`, `naja_if`, `systemverilog`, `sv`, or `sv2v`. Defaults to `verilog` if omitted. |
| `verification` | string | `lec` or `sec`. Defaults to `lec`. |
| `input_paths` | list | Required. Either `[design0, design1]` or `[[design0_file...], [design1_file...]]`. The nested form is for multi-file Verilog. |
| `liberty_files` | list[string] | Liberty libraries loaded through `SNLLibertyConstructor`. |
| `py_tech_files` | list[string] | Python primitive loaders loaded through `SNLPyLoader`. |
Expand Down
Loading