Certara.RsNLME (version 3.1.0.1)

NlmeParallelHost-class: NlmeParallelHost Class

Description

This class defines an NLME parallel host, which can be either local or remote, for running jobs.

Slots

sharedDirectory

character. The directory where the run will take place. On Windows, UNC paths are mapped to a drive letter for local execution.

installationDirectory

character. The directory containing NLME libraries and scripts.

hostName

character. A user-friendly name for the host (e.g., "local_mpi").

machineName

character. The IP address or hostname of the machine. Defaults to the local system's node name.

hostType

character. The operating system of the host, either "windows" or "linux". For remote Linux systems, you can specify a supported distribution (e.g., "RHEL", "UBUNTU") to configure the PML_BIN_DIR environment variable. linux will be treated as "RHEL".

numCores

numeric. The number of compute cores to be used.

isLocal

logical. TRUE if the host is local, FALSE if remote.

rLocation

character. The path to the Rscript executable on a remote host. This is ignored for local runs.

scriptPath

character. The path to a script to execute on the remote host before Rscript is started. This is ignored for local runs.

userAuthentication

NlmeUserAuthentication. An object containing user credentials for remote host authentication. See NlmeUserAuthentication().

parallelMethod

NlmeParallelMethod. The parallel computing method to use (e.g., "LOCAL_MPI", "SGE", "TORQUE"). See NlmeParallelMethod().

Examples

host <- hostParams(
  parallelMethod = "LOCAL_MPI",
  hostName = "local_mpi",
  numCores = 4
)