Coupling Participant Parallel Options

Option Description

Option	Description
--cnf	Description Available only for Linux systems. Note: Distributed parallel processing for participants is not supported for Windows systems. For more information, see Parallel Processing for Coupling Participants in the System Coupling User's Guide. Optional. When running coupling participants in parallel, specifies the machine list and core count for the run. You can supply the machine list without specifying the core count, in which case one core per machine is assumed. When present, this option is used to determine which machines to use for parallel job execution and the number of cores available on each. If the machines and core count have been set by the --cnf option and then are reset explicitly by another method, then the values set by the --cnf option are ignored. Arguments Accepts a comma-separated list of machines and cores or the name of the hosts file. Accepts a comma-separated list containing either machines and (where applicable) cores, or the name of the hosts file. Usage --cnf="<`Machine1`,`Machine2`,`Machine3`>" --cnf="<`Machine1:CoreCount`,`Machine2:CoreCount`,`Machine3:CoreCount`>" --cnf=<`HostsFile`> Examples In each of the examples below, one core is available on *`machine-1`, three cores are available on `machine-2`, and two cores are available on `machine-3`. Using a list:* --cnf="machine-1,machine-2,machine-2,machine-2,machine-3,machine-3" --cnf="machine-1:1,machine-2:3,machine-3:2" Using a hosts file: --cnf=hosts.txt Sample hosts file contents: machine-1:1 machine-2:3 machine-3:2 Which is the equivalent of: machine-1 machine-2 machine-2 machine-2 machine-3 machine-3
-t --nprocs	Description Specifies the number of processes to be used by coupling participants when running locally. Defaults to a value of *`1`* (serial). If no machine list is provided, no job scheduler is being used, and two or more cores have been specified using this option, then the participants are run in local parallel with the local machine as host. If a machine list is also specified (for example, with the --cnf command-line option), and the number of cores specified by the two methods are not equal, then the lesser number of cores is used. Argument Accepts an integer. Usage -t<`NumberOfProcesses`> --nprocs=<`NumberOfProcesses`> Examples -t4 --nprocs=6

--cnf

Description

Available only for Linux systems.

Note: Distributed parallel processing for participants is not supported for Windows systems. For more information, see Parallel Processing for Coupling Participants in the System Coupling User's Guide.

Optional. When running coupling participants in parallel, specifies the machine list and core count for the run. You can supply the machine list without specifying the core count, in which case one core per machine is assumed.

When present, this option is used to determine which machines to use for parallel job execution and the number of cores available on each.

If the machines and core count have been set by the --cnf option and then are reset explicitly by another method, then the values set by the --cnf option are ignored.

Arguments

Accepts a comma-separated list of machines and cores or the name of the hosts file.

Accepts a comma-separated list containing either machines and (where applicable) cores, or the name of the hosts file.

Usage

 

--cnf="<Machine1,Machine2,Machine3>" 

--cnf="<Machine1:CoreCount,Machine2:CoreCount,Machine3:CoreCount>" 

--cnf=<HostsFile>

Examples

In each of the examples below, one core is available on machine-1, three cores are available on machine-2, and two cores are available on machine-3.

Using a list:


--cnf="machine-1,machine-2,machine-2,machine-2,machine-3,machine-3"

--cnf="machine-1:1,machine-2:3,machine-3:2"

Using a hosts file:


--cnf=hosts.txt

Sample hosts file contents:

 

machine-1:1
machine-2:3
machine-3:2

Which is the equivalent of:

 

machine-1
machine-2
machine-2
machine-2
machine-3
machine-3

-t

--nprocs

Description

Specifies the number of processes to be used by coupling participants when running locally.

Defaults to a value of 1 (serial).

If no machine list is provided, no job scheduler is being used, and two or more cores have been specified using this option, then the participants are run in local parallel with the local machine as host.

If a machine list is also specified (for example, with the --cnf command-line option), and the number of cores specified by the two methods are not equal, then the lesser number of cores is used.

Argument

Accepts an integer.

Usage


-t<NumberOfProcesses>

--nprocs=<NumberOfProcesses>

Examples


-t4

--nprocs=6