Run and CLI
Commands, options, output formats, and return codes
The simulator can be invoked through cimflow sim for standard workflows or the cim-simulator native binary for advanced use.
Which Command to Use
The simulator can be invoked through the CIMFlow CLI or directly as a native binary.
CIMFlow Sim Command
cimflow sim -i <inst-file> -o <output-dir> [options]Config Resolution
cimflow sim resolves the hardware config file in this order:
- Explicit
--config --config-dir+-t/-btool_paths.jsonconfig directory +-t/-b
Output Behavior
The report file is generated as simulation_<inst_stem>.txt under --output-dir. Native options like --format, -j, --list-cores, and --verbose are not exposed by cimflow sim — use the native binary for those.
Native Binary
cim-simulator <config> <inst> [options]<config>: Hardware/simulation config JSON<inst>: Instruction JSON keyed by numeric core IDs ("0","1", ...)
Short Option `-l` Means Different Things
In cimflow sim, -l is log level.
In cim-simulator, -l means --list-cores (per-core energy report).
Output Behavior
Text Mode (Default)
cim-simulator config.json inst.json -o report.txt -j report.jsonreport.txt: Human-readable summaryreport.jsonvia-j: Machine-readable reporter object
JSON Mode
cim-simulator config.json inst.json --format json -o report.jsonIn JSON mode, -o is treated as the report JSON path. Text report body is not emitted.
Path Resolution Rules
Config-Embedded Paths
Paths inside <config> are resolved relative to the config file directory:
network_config.network_config_file_path- Local/global memory image file paths
Last updated on