Skip to contents

Class initializer for NlmeParallelHost

NlmeParallelHost-class.Rd

NLME Parallel Host object class. Class represents an NLME parallel host which can either be local or remote.

Slots

sharedDirectory

Directory in which the run happens. If it is given as UNC path on Windows, a PS Drive will be mapped within powershell command to any free Disk letter on local machine where execution performed (not applicable to remote executions). After execution PS Drive will be removed. A warning will be given if removal is unsuccessful.

installationDirectory

Directory containing NLME libraries/scripts

hostName

Visual name of the host(default local)

machineName

IP address or name of the host(default local)

hostType

windows or linux. For remote runs it is possible to point the distro suppported, i.e. RHEL8 or UBUNTU2204. In such case the corresponding PML_BIN_DIR variable will be created and NLME Engine libraries will be looked in installationDirectory/{$PML_BIN_DIR}.

numCores

Number of compute cores

isLocal

Is this a local TRUE or remote FALSE host?

rLocation

Path to Rscript executable on remote host; ignored on local host

scriptPath

a path to the script to be executed before starting Rscript within Certara.NLME8 package on the remote host. Ignored when running locally.

userAuthentication

User credential for remote system. See NlmeUserAuthentication()

parallelMethod

Options are: None|Multicore|LOCAL_MPI|SGE|SGE_MPI|TORQUE| TORQUE_MPI|LSF|LSF_MPI|SLURM|SLURM_MPI. Supply argument using NlmeParallelMethod("LOCAL_MPI") for example.

Examples

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