Batch Execution

Introduction to Batch Mode Options

The simstudio_batch program accepts fifteen command line arguments, which are summarized in Table 14.1. The following terms are used in this table:

The term local pertains to the machine that hosts Simulation Studio.
- local host refers to the local machine.
- local path refers to a file path accessible through the local host.
The term remote pertains to a machine other than the local host that hosts a SAS Workspace Server that the local host can connect to.
- remote host refers to a remote machine.
- remote path refers to a file path accessible through the remote host.

Usage of a local or a remote SAS Workspace Server depends on options that are specified in one or more data output

Table 14.1: Functional Summary of Batch Mode Options

Option	Description	Valid Arguments	Notes
`-m` (required)	Specifies a file path to a Simulation Studio model file, whose file extension is `(*.simmdl)`	A relative or absolute local path to the model file	If the model file path is relative, then it is relative to the local default file path, which must be provided using the `-locdfp` option
`-e` (required)	Specifies a file path to a Simulation Studio experiment file, whose file extension is `(*.simexp)`	A relative or absolute local path to the experiment file	If the experiment file path is relative, then it is relative to the local default file path, which must be provided using the `-locdfp` option
`-i`	Specifies the directory for input data	A relative or absolute path to an existing folder	When this option specifies an absolute path, the file path is on either of the following: the local host if a local SAS Workspace Server is used the remote host if a remote SAS Workspace Server is used When this option specifies a relative path, the path is relative to the value of either of the following: the `-locdfp` option if a local SAS Workspace Server is used the `-remdfp` option if a remote SAS Workspace Server is used
	Usage of a local or remote SAS Workspace Server depends on options that are specified in one or more data input blocks inside the model.
`-locdfp` (conditionally required)	Specifies the local default file path	A local absolute file path to an existing folder	This option is required if any of the following conditions hold: the `-m` or`-e` option is specified as a relative path any of the `-i,-r,or -d` options are specified as relative paths and a local SAS Workspace Server is used
`-r`	Specifies the directory for output data	A relative or absolute path	When this option specifies an absolute path, the file path is on either of the following: the local host if a local SAS Workspace Server is used the remote host if a remote SAS Workspace Server is used When this option specifies a relative path,the path is relative to the value of either of the following: the `-locdfp` option if a local SAS Workspace Server is used the `-remdfp` option if a remote SAS Workspace Server is used
	Usage of a local or remote SAS Workspace Server depends on options that are specified in one or more data output blocks inside the model.
`-d`	Specifies the file path for saving the experiment design matrix	A relative or absolute path with file name	When this option specifies an absolute path, the file path is on either of the following: the local host if a local SAS Workspace Server is used the remote host if a remote SAS Workspace Server is used and the `-remd` option is specified When this option specifies a relative path, the path is relative to the value of one of the following: the `-r` option if it is provided the `-locdfp` option if the `-r` option is not provided the `-remdfp` or `(-remdfp + -r)` option if the `-remd` option is also provided
`-remdfp` (conditionally required)	Specifies the remote default file path	An absolute file path to an existing folder on the remote host	This option is required if any of the `-i,-r, or -d` options is specified as a relative path and a remote SAS Workspace Server is used
`-locport`	Specifies the port number for the local SAS Workspace Server	An integer value that has four or more digits
`-authpath`	Specifies the `authinfo` file path	A local absolute file path
`-remhost`	Specifies the name of the remote host	Fully qualified domain name of the remote host
`-remport`	Specifies the port number for the remote SAS Workspace Server	An integer value that has four or more digits
`-remos`	Specifies the operating system type of the remote host	`windows` or `linux` or `unix`
`-remd`	Saves the experiment design matrix to file by using the remote SAS Workspace Server	None	This option is specified along with the `-d` option
`-nonparallel`	Specifies nonparallel execution mode	None	The default execution mode is parallel
`-numthreads`	Specifies the number of threads to use in parallel execution	Integer less than or equal to the number of logical processors available on the local host	This option should be omitted if the `-nonparallel` option is specified

Last updated: November 05, 2018