--split
Splits a Scenario into separate jobs.
Syntax
--split [argument, argument, ...]
Arguments
--lib=name
The Library file name.
--sid=id
The ID of the Scenario to split.
--jobs=num
The number of jobs to create. If omitted, the Library configuration will be used to determine the number of jobs.
--out
The name of the output folder for the jobs. If omitted, the jobs will be placed in a default folder called "SSimJobs".
--noextfiles
Don't copy external files to child job folders. The default is to copy the files.
Tip
The default folder will be a child of the Scenario folder found within the Library's temporary folder. Use --list --library see the location of the Library's temporary folder. [reference]
--trx
The name of the Transformer for the split. If omitted, the primary Transformer will be used.
Note
The --trx argument exists to allow splitting by individual Transformers that support multi-processing. In most cases, however, there is no need to use the --trx argument.
Remarks
It is the job of a Transformer to perform a split. Because of this, the core system has no control over how the split is actually performed or how many jobs are possible.
However, Transformers that support multi-processing (i.e. splitting and merging) are commonly Stochastic Time Transformers. These Transformers will split a Scenario into jobs based on the number of iterations configured for the Scenario. This means that it might not be possible to actually split into the requested number of jobs. For example, if a Scenario is configured to have 10 iterations it is not possible to split it into 11 jobs. In this case, the maximum possible number of jobs (10) will be used instead.
Examples
Split Scenario 123 in Library my lib.ssim into 3 jobs:
SyncroSim.Console.exe --split --lib="my lib.ssim" --sid=123 --jobs=3
Split Scenario 123 in Library my lib.ssim into the default number of jobs, and create the jobs in a folder called my jobs:
SyncroSim.Console.exe --split --lib="my lib.ssim" --sid=123 --out="my jobs""