General multisim Stage Keywords

The keywords that can be used in any stage of the multisim job are listed in Table 1.

Table 1. General keywords that can be used in any stage
Keyword	Description
`compress`	File name pattern of the stage data file. If it is set to an empty string, then the data of this stage is not packaged and compressed. Default: `$JOBNAME_$STAGENO-out.tgz`.
`dir`	Pattern for the names of the directories used by subjobs of this stage. Default: `[$JOBPREFIX/][$PREFIX/]$MASTERJOBNAME_$STAGENO[_lambda$LAMBDA]`
`effect_if`	`effect_if` can take either a list value or a string value: `none`. If it is a list value, it must contains exactly two members. The first member specifies a condition (logical expression) in the form of a list value. The second member should be a block value. Multisim evaluates the first member. If the result is true, the settings included in the block will take effect. Here is a simple example: some_stage { effect_if = [[true] {a = 1}] a = 2 } In this example, the condition is constant true, and the setting a = 1 will always take effect, and overwriting the a = 2 in the outer block.
`jlaunch_opt`	Options to add to the command to run Desmond.
`jobname`	Jobname pattern for subjobs of this stage. Default: `$MASTERJOBNAME_$STAGENO[_lambda$LAMBDA]`
`prefix`	Value of the `PREFIX` macro, which by default is used to specify the sub-directory name of subjobs (see the `dir` keyword). Default is an empty string.
`should_skip`	Skip this stage. Allowed values: `true`, `false`. Default: `false`.
`should_sync`	Do not start this stage until all subjobs of the previous stage finish successfully. Allowed values: `true`, `false`. If it is set to `false`, this stage is started as soon as any subjob of the previous stage finishes successfully. For FEP jobs, setting this keyword to `false` can result in earlier completion of the job. Default: `true`.
`struct_output`	File name of the final output structure file. This keyword is only effective when set in the last stage, and the setting can be overwritten by the `-o` option of `multisim`.
`title`	The title for the stage. Default: no title specified.
`transfer_asap`	Transfer a subjob's output files as soon as it is finished. This can be useful for stages with multiple subjobs. Allowed values: `true`, `false`. Default: `false`.