firesim/docs/Advanced-Usage/Manager/HELP_OUTPUT

82 lines
5.1 KiB
Plaintext

usage: firesim [-h] [-c RUNTIMECONFIGFILE] [-b BUILDCONFIGFILE]
[-r BUILDRECIPESCONFIGFILE] [-a HWDBCONFIGFILE]
[-x OVERRIDECONFIGDATA] [-f TERMINATESOMEF116]
[-g TERMINATESOMEF12] [-i TERMINATESOMEF14]
[-m TERMINATESOMEM416] [--terminatesome TERMINATESOME] [-q]
[-t LAUNCHTIME]
[--platform {f1,rhsresearch_nitefury_ii,vitis,xilinx_alveo_u200,xilinx_alveo_u250,xilinx_alveo_u280,xilinx_vcu118}]
{managerinit,infrasetup,boot,kill,runworkload,buildbitstream,builddriver,enumeratefpgas,tar2afi,runcheck,launchrunfarm,terminaterunfarm,shareagfi}
FireSim Simulation Manager.
positional arguments:
{managerinit,infrasetup,boot,kill,runworkload,buildbitstream,builddriver,enumeratefpgas,tar2afi,runcheck,launchrunfarm,terminaterunfarm,shareagfi}
Management task to run.
options:
-h, --help show this help message and exit
-c RUNTIMECONFIGFILE, --runtimeconfigfile RUNTIMECONFIGFILE
Optional custom runtime/workload config file. Defaults
to config_runtime.yaml.
-b BUILDCONFIGFILE, --buildconfigfile BUILDCONFIGFILE
Optional custom build config file. Defaults to
config_build.yaml.
-r BUILDRECIPESCONFIGFILE, --buildrecipesconfigfile BUILDRECIPESCONFIGFILE
Optional custom build recipe config file. Defaults to
config_build_recipes.yaml.
-a HWDBCONFIGFILE, --hwdbconfigfile HWDBCONFIGFILE
Optional custom HW database config file. Defaults to
config_hwdb.yaml.
-x OVERRIDECONFIGDATA, --overrideconfigdata OVERRIDECONFIGDATA
Override a single value from one of the the RUNTIME
e.g.: --overrideconfigdata "target-config link-latency
6405".
-f TERMINATESOMEF116, --terminatesomef116 TERMINATESOMEF116
DEPRECATED. Use --terminatesome=f1.16xlarge:count
instead. Will be removed in the next major version of
FireSim (1.15.X). Old help message: Only used by
terminaterunfarm. Terminates this many of the
previously launched f1.16xlarges.
-g TERMINATESOMEF12, --terminatesomef12 TERMINATESOMEF12
DEPRECATED. Use --terminatesome=f1.2xlarge:count
instead. Will be removed in the next major version of
FireSim (1.15.X). Old help message: Only used by
terminaterunfarm. Terminates this many of the
previously launched f1.2xlarges.
-i TERMINATESOMEF14, --terminatesomef14 TERMINATESOMEF14
DEPRECATED. Use --terminatesome=f1.4xlarge:count
instead. Will be removed in the next major version of
FireSim (1.15.X). Old help message: Only used by
terminaterunfarm. Terminates this many of the
previously launched f1.4xlarges.
-m TERMINATESOMEM416, --terminatesomem416 TERMINATESOMEM416
DEPRECATED. Use --terminatesome=m4.16xlarge:count
instead. Will be removed in the next major version of
FireSim (1.15.X). Old help message: Only used by
terminaterunfarm. Terminates this many of the
previously launched m4.16xlarges.
--terminatesome TERMINATESOME
Only used by terminaterunfarm. Used to specify a
restriction on how many instances to terminate. E.g.,
--terminatesome=f1.2xlarge:2 will terminate only 2 of
the f1.2xlarge instances in the runfarm, regardless of
what other instances are in the runfarm. This argument
can be specified multiple times to terminate
additional instance types/counts. Behavior when
specifying the same instance type multiple times is
undefined. This replaces the old
--terminatesome{f116,f12,f14,m416} arguments. Behavior
when specifying these old-style terminatesome flags
and this new style flag at the same time is also
undefined.
-q, --forceterminate For terminaterunfarm and buildbitstream, force
termination without prompting user for confirmation.
Defaults to False
-t LAUNCHTIME, --launchtime LAUNCHTIME
Give the "Y-m-d--H-M-S" prefix of results-build
directory. Useful for tar2afi when finishing a partial
buildbitstream
--platform {f1,rhsresearch_nitefury_ii,vitis,xilinx_alveo_u200,xilinx_alveo_u250,xilinx_alveo_u280,xilinx_vcu118}
Required argument for "managerinit" to specify which
platform you will be using