Initialize for NlmeParallelHost

Usage

hostParams(
  sharedDirectory = getwd(),
  installationDirectory = Sys.getenv("INSTALLDIR"),
  hostName = Sys.info()[["nodename"]],
  machineName = "127.0.0.1",
  hostType = Sys.info()[["sysname"]],
  numCores = 4,
  parallelMethod = "LOCAL_MPI",
  userName = "",
  privateKeyFile = NULL,
  userPassword = "",
  scriptPath = "",
  rLocation = "",
  isLocal = TRUE
)

Arguments

sharedDirectory: Directory in which the run happens. Current directory by default
installationDirectory: Directory containing NLME libraries/scripts
hostName: Visual name of the host (default A name by which the machine is known on the network)
machineName: IP address or name of the host(default 127.0.0.1)
hostType: windows or linux. Current OS by default. 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: Integer; Number of compute cores. 4 by default
parallelMethod: String; Options are: None|Multicore|LOCAL_MPI|SGE|SGE_MPI| TORQUE|TORQUE_MPI|LSF|LSF_MPI|SLURM_SLURM_MPI.
userName: String; How the user is identified to the remote system
privateKeyFile: Path to private key file, see ssh::ssh_connect() for details
userPassword: Either a string or a callback function for password prompt, see ssh::ssh_connect() for details
scriptPath: a path to the script to be executed before starting Rscript within Certara.NLME8 package on the remote host. Ignored when running locally.
rLocation: Path to Rscript executable on remote host; ignored on local host
isLocal: Is this a local TRUE or remote FALSE host?

Value

NlmeParallelHost class instance

Examples

host <- hostParams(sharedDirectory = getwd(),
                   parallelMethod = "LOCAL_MPI",
                   hostName = "Local",
                   numCores = 4)