Description | Example | Return Message | Group

Parallel

Configure parallel processing.

Syntax

Parallel <AppOrScenPath> {ParallelOption}

Related Commands

Description

The <AppOrScenPath> can be either the Application path or the Scenario path. The following table describes the available options.

{ParallelOption} Description
Configuration ParallelType {Local | Cluster} [{Parameters}]

If Local is entered then the optional {Parameters} can be:

NumberOfLocalCores <number> Configure the number of cores used in the local parallel type.
LocalSharedDirectory <SharedDir> The shared directory used to exchange scenarios during local computations.
LocalScenarioCopyStrategy {SaveAsVDF | SaveAsScenario} Sets the local scenario copy strategy. The default is SaveAsScenario.

If Cluster is entered then the optional {Parameters} can be:

CoordinatorHost <name> Specify the name of the coordinator machine.
CoordinatorPort <port> Specify the port used by the coordinator.
ClusterSharedDirectory <SharedDir> The shared directory used to exchange scenarios during cluster computations.
ClusterScenarioCopyStrategy {SaveAsVDF | SaveAsScenario} Sets the cluster scenario copy strategy. The default is SaveAsVDF.
AutomaticallyComputeInParallel {On | Off} When On, always use parallel mode when computing coverage or deck access, either explicitly or as a result of changes made to other objects in the scenario.
ComputeAllFiguresOfMeritInParallelWithCoverage {On | Off} By default only certain types of figures of merit (those usually expensive to compute) are computed in parallel. This forces all the figures of merit to compute in parallel, independently of their type. In those cases this might be less efficient than not computing in parallel, due to the overhead involved in starting up a parallel computation.
HostLoggingLevel {All | Info | Warning | Error} Sets the logging level used by the hosts.
ShutdownLocalWorkers Forces all local workers to shutdown. Only available when using the Local parallel type.
ShutdownLocalWorkersOnJobCompletion {On | Off} When On, local workers shut down after completing their work (instead of staying in memory to allow better startup time for the next computation).
ValidateScenario {On | Off} When On, scenarios are automatically validated prior to starting a parallel computation.

Example

To indicate that computing should use parallel computation:

Parallel / AutomaticallyComputeInParallel On

To set the parallel type to Cluster:

Parallel / Configuration ParallelType Cluster

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Application Options

Scenarios

Version

10.0.2

STK Programming Interface 11.0.1