StartParticipants()


Important:  This command is deprecated. Consider adopting workflows where participants are started by another method, such as the Initialize(), Step(), or Solve() commands.


Interactive command that reads the participants' System Coupling Participant setup files (.scp) and starts participants on separate sub-processes. Automatically starts all participants and blocks solution progress until all participants are connected.

If omitted and the Solve(), Initialize(), or Step() command is issued, then participants are started automatically during the execution of the command.

If the ExecutionControl|Option for a participant is set to ExternallyManaged, then System Coupling will not start the participant using either this command or any of the other commands that automatically start participants. You are expected to manually start the participant. This function will not return until all participants have been connected.

Note that this command will raise an exception if another instance of System Coupling is solving in the current working directory.

If a participant's .scp file does not include the <ExecutionControl> element, the participant cannot be started automatically. It must be started manually, as described in the participant's command-line documentation.

Optional Keyword Arguments

ParticipantName : string list

Important:  This argument has been deprecated and will be removed in future releases.


Return Type

None

Examples

Example 61: Automatically start all participants


StartParticipants()