Using sby¶
Once SBY is installed and available on the command line as sby, either built from source or using one of the available CAD suites, it can be called as follows. Note that this information is also available via sby –help. For more information on installation, see Installation guide.
usage: sby [options] [<jobname>.sby [tasknames] | <dirname>]
Positional Arguments¶
- <jobname>.sby | <dirname>
.sby file OR directory containing config.sby file
- tasknames
tasks to run (only valid when <jobname>.sby is used)
Named Arguments¶
- -d
set workdir name. default: <jobname> or <jobname>_<taskname>. When there is more than one task, use –prefix instead
- --prefix
set the workdir name prefix. _<taskname> will be appended to the path for each task
- -f
remove workdir if it already exists
Default: False
- -b
backup workdir if it already exists
Default: False
- -t
run in a temporary workdir (remove when finished)
Default: False
- -T
add taskname (useful when sby file is read from stdin)
Default: []
- -E
throw an exception (incl stack trace) for most errors
Default: False
- -j
maximum number of processes to run in parallel
- --sequential
run tasks in sequence, not in parallel
Default: False
- --autotune
automatically find a well performing engine and engine configuration for each task
Default: False
- --autotune-config
read an autotune configuration file (overrides the sby file’s autotune options)
- --yosys
Default: {}
- --abc
Default: {}
- --smtbmc
Default: {}
- --witness
Default: {}
- --suprove
Default: {}
- --aigbmc
Default: {}
- --avy
Default: {}
- --btormc
Default: {}
- --pono
configure which executable to use for the respective tool
Default: {}
- --dumpcfg
print the pre-processed configuration file
Default: False
- --dumptags
print the list of task tags
Default: False
- --dumptasks
print the list of tasks
Default: False
- --dumpdefaults
print the list of default tasks
Default: False
- --dumptaskinfo
output a summary of tasks as JSON
Default: False
- --dumpfiles
print the list of source files
Default: False
- --setup
set up the working directory and exit
Default: False
- --status
summarize the contents of the status database
Default: False
- --statusreset
reset the contents of the status database
Default: False
- --init-config-file
create a default .sby config file