Skip to content

Commit

Permalink
HELP: Clarify further how availableWorkers(methods='PJM') works [#82]
Browse files Browse the repository at this point in the history
  • Loading branch information
HenrikBengtsson committed May 31, 2022
1 parent 4ffe5bd commit 0e3349a
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
8 changes: 7 additions & 1 deletion R/availableWorkers.R
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,13 @@
#' Query Fujitsu Technical Computing Suite (that we choose to shorten
#' as "PJM") the hostname file given by environment variable
#' \env{PJM_O_NODEINF}.
#' This set when submitted with `pjsub -L vnode=2 -L vnode-core=8 hello.sh`.
#' The \env{PJM_O_NODEINF} file lists the hostnames of the nodes alloted.
#' This function returns those hostnames each repeated `availableCores()`
#' times, where `availableCores()` reflects \env{PJM_VNODE_CORE}.
#' For example, for `pjsub -L vnode=2 -L vnode-core=8 hello.sh`, the
#' \env{PJM_O_NODEINF} file gives two hostnames, and \env{PJM_VNODE_CORE}
#' gives eight cores per host, resulting in a character vector of 16
#' hostnames (for two unique hostnames).
#'
#' \item `"PBS"` -
#' Query TORQUE/PBS environment variable \env{PBS_NODEFILE}.
Expand Down
8 changes: 7 additions & 1 deletion man/availableWorkers.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 0e3349a

Please sign in to comment.