Class default

constructor

• new default(hpcName, jobId?, maintainer?, env?, is_cvmfs?): default

• Parameters

  • hpcName: string
  • jobId: null | string = null
  • maintainer: null | default = null
  • env: Record<string, unknown> = {}
  • is_cvmfs: boolean = false

  Returns default

connectorConfig

hpcName

is_cvmfs

jobId

maintainer

modules

remote_data_folder_path

remote_executable_folder_path

remote_result_folder_path

slurm_id

template

cancel

• cancel(): Promise<void>

• Returns Promise<void>

  Async

  cancels the job

cat

• cat(path, options?): Promise<null | string>

• Parameters

  • path: string

    specified path with filename
  • Optional options: options = {}

    dictionary with string options

  Returns Promise<null | string>

  command execution output

  Async

  creates an empty file at specified path

createFile

• createFile(content, remotePath, options?, muteEvent?): Promise<void>

• Parameters

  • content: string | Record<string, unknown>

    file content (either string or dictionary)
  • remotePath: string

    specified path with filename
  • options: options = {}

    dictionary with string options (not used)
  • Optional muteEvent: boolean = false

    set to True if you want to mute maintauner emitted Event

  Returns Promise<void>

  Async

  creates file with specified content

download

• download(from, to, muteEvent?): Promise<void>

• Parameters

  • from: string

    input file string (input folder to download)
  • to: string

    output folder
  • muteEvent: boolean = false

    set to True if you want to mute maintainer emitted Event

  Returns Promise<void>

  Async

  Uncompresses the specified zip file to the Local folder (downloads a folder from the HPC to the local machine)

  Throws

  • Thrown if maintainer emits 'SSH_SCP_DOWNLOAD_ERROR' or if input file not given

exec

• exec(commands, options?, muteEvent?, muteLog?, continueOnError?): Promise<out>

• Parameters

  • commands: string | string[]

    command/commands that need to be executed
  • options: options = {}

    execution options
  • muteEvent: boolean = true

    set to True if you want to mute maintauner emitted Event
  • muteLog: boolean = true

    set to True if you want to mute maintainer emitted Log
  • continueOnError: boolean = false

    set to True if you want the command/commands to continue despite errors

  Returns Promise<out>

  out - maintainer output

  Async

  Executes the command on the maintainer and returns the outpt

getContainerCVMFSFolderPath

• getContainerCVMFSFolderPath(providedPath?): string

• Get Container CVMFS folder path

  Parameters

  • Optional providedPath: null | string = null

    specified path

  Returns string

  executable path

getContainerDataFolderPath

• getContainerDataFolderPath(providedPath?): string

• Get Container data folder path

  Parameters

  • Optional providedPath: null | string = null

    specified path

  Returns string

  executable path

getContainerExecutableFolderPath

• getContainerExecutableFolderPath(providedPath?): string

• Get Container executable folder path

  Parameters

  • Optional providedPath: null | string = null

    specified path

  Returns string

  executable path

getContainerResultFolderPath

• getContainerResultFolderPath(providedPath?): string

• Get Container result folder path

  Parameters

  • Optional providedPath: null | string = null

    specified path

  Returns string

  executable path

getRemoteDataFolderPath

• getRemoteDataFolderPath(providedPath?): null | string

• gets remote data folder path

  Parameters

  • Optional providedPath: null | string = null

    specified path

  Returns null | string

  command execution output

getRemoteExecutableFolderPath

• getRemoteExecutableFolderPath(providedPath?): string

• gets remote executable folder path

  Parameters

  • Optional providedPath: null | string = null

    specified path

  Returns string

  command execution output

getRemoteResultFolderContent

• getRemoteResultFolderContent(): Promise<string[]>

• Returns Promise<string[]>

  file content

  Async

  Get remote results folder content

getRemoteResultFolderPath

• getRemoteResultFolderPath(providedPath?): string

• gets remote result folder path

  Parameters

  • Optional providedPath: null | string = null

    specified path

  Returns string

  command execution output

getSlurmStderr

• getSlurmStderr(): Promise<void>

• Returns Promise<void>

  Async

  gets SlurmStderr and emit it as a log in the maintainer

getSlurmStdout

• getSlurmStdout(): Promise<void>

• Returns Promise<void>

  Async

  gets SlurmStdOut and emit it as a log in the maintainer

getStatus

• getStatus(): Promise<string>

• Returns Promise<string>

  job status (RETRY, UNKNOWN, or a slurm job status)

  Async

  checks job status

getUsage

• getUsage(): Promise<Record<string, null | number>>

• Get job usage

  Returns Promise<Record<string, null | number>>

  • usage dictionary

homeDirectory

• homeDirectory(options?): Promise<null | string>

• Returns the homeDirectory path of the HPC

  Parameters

  • Optional options: options = {}

    dictionary with string options

  Returns Promise<null | string>

  returns command execution output

ls

• ls(path?, options?): Promise<null | string>

• Parameters

  • Optional path: string
  • Optional options: options = {}

    dictionary with string options

  Returns Promise<null | string>

  returns command execution output

  Async

  Returns all of the files/directories in specified path

mkdir

• mkdir(path, options?, muteEvent?): Promise<null | string>

• Parameters

  • path: string

    specified path with filename
  • Optional options: options = {}

    dictionary with string options
  • Optional muteEvent: boolean = false

    set to True if you want to mute maintauner emitted Event

  Returns Promise<null | string>

  command execution output

  Async

  creates directory at specified path

pause

• pause(): Promise<void>

• Returns Promise<void>

  Async

  pauses the job

prepare

• prepare(cmd, config): void

• Creates slurm string with specified configuation. Saves it to this.template.

  Parameters

  • cmd: string

    command that needs to be executed
  • config: slurm

    slurm configuration

  Returns void

pwd

• pwd(path?, options?): Promise<null | string>

• Parameters

  • Optional path: string
  • Optional options: options = {}

    dictionary with string options

  Returns Promise<null | string>

  returns command execution output

  Async

  Returns the specified path

registerModules

• registerModules(modules): void

• Registers all of the specified modules

  Parameters

  • modules: string[]

    Array of strings

  Returns void

remoteFsExists

• remoteFsExists(path, options?): Promise<boolean>

• Parameters

  • path: string

    path to test for
  • Optional options: options

    options for doing an exec

  Returns Promise<boolean>

  true if path exists; false if not

  Async

  Determines whether a passed in (absolute) path exists on the HPC.

resume

• resume(): Promise<void>

• Returns Promise<void>

  Async

  resumes the job

rm

• rm(path, options?, muteEvent?): Promise<null | string>

• Parameters

  • path: string

    specified path with filename
  • Optional options: options = {}

    set to True if you want to mute maintauner emitted Event
  • Optional muteEvent: boolean = false

    command execution output

  Returns Promise<null | string>

  Async

  removes the file/folder at specified path

setRemoteDataFolderPath

• setRemoteDataFolderPath(providedPath): void

• Sets remote data folder path instance variable.

  Parameters

  • providedPath: string

  Returns void

setRemoteExecutableFolderPath

• setRemoteExecutableFolderPath(providedPath): void

• Sets remote executable folder path instance variable.

  Parameters

  • providedPath: string

  Returns void

setRemoteResultFolderPath

• setRemoteResultFolderPath(providedPath): void

• Setes remote reuslt folder path instance variable.

  Parameters

  • providedPath: string

  Returns void

ssh

• ssh(): SSH

• Returns ssh connection from maintainer configuration (for community accounts).

  Returns SSH

submit

• submit(): Promise<void>

• Returns Promise<void>

  Async

  Submit the slurm job.

tar

• tar(from, to, options?, muteEvent?): Promise<null | string>

• Parameters

  • from: string

    input file/directory path
  • to: string

    compress file path with file name
  • Optional options: options = {}

    dictionary with string options
  • Optional muteEvent: boolean = false

    set to True if you want to mute maintauner emitted Event

  Returns Promise<null | string>

  command execution output

  Async

  tars the file/directory at specified path

transferFile

• transferFile(from, to, muteEvent?): Promise<void>

• Parameters

  • from: string

    input file string
  • to: string

    output folder
  • muteEvent: boolean = false

    set to True if you want to mute maintauner emitted Event

  Returns Promise<void>

  Async

  Transfers a file from the local machine to remote machine

  Throws

  • Thrown if maintainer emits 'SSH_SCP_DOWNLOAD_ERROR'

untar

• untar(from, to, options?, muteEvent?): Promise<null | string>

• Parameters

  • from: string

    input file/directory path
  • to: string

    compress file path with file name
  • Optional options: options = {}

    dictionary with string options
  • Optional muteEvent: boolean = false

    set to True if you want to mute maintauner emitted Event

  Returns Promise<null | string>

  command execution output

  Async

  untars the file/directory at specified path

unzip

• unzip(from, to, options?, muteEvent?): Promise<null | string>

• Parameters

  • from: string

    input file/directory path
  • to: string

    compress file path with file name
  • Optional options: options = {}

    dictionary with string options
  • Optional muteEvent: boolean = false

    set to True if you want to mute maintauner emitted Event

  Returns Promise<null | string>

  command execution output

  Async

  unzips the file/folder at specified path

upload

• upload(from, to, muteEvent?, unzip?): Promise<void>

• Parameters

  • from: string

    input file string
  • to: string

    output folder
  • muteEvent: boolean = false

    set to True if you want to mute maintauner emitted Event (unused)
  • unzip: boolean = true

    set to True if you want it to unzip and remove on the remote machine; false just uploads

  Returns Promise<void>

  Async

  Uploads a (zipped) folder from the local machine to the target machine. After upload, decompresses the uploaded zip file and then deletes the zip file.

  Throws

  • Thrown if maintainer emits 'SSH_SCP_DOWNLOAD_ERROR'

whoami

• whoami(options?): Promise<null | string>

• Parameters

  • Optional options: options = {}

    dictionary with string options

  Returns Promise<null | string>

  returns command execution output

  Async

  Returns the username

zip

• zip(from, to, options?, muteEvent?): Promise<null | string>

• Parameters

  • from: string

    input file/directory path
  • to: string

    compress file path with file name
  • Optional options: options = {}

    dictionary with string options
  • Optional muteEvent: boolean = false

    set to True if you want to mute maintauner emitted Event

  Returns Promise<null | string>

  command execution output

  Async

  zips the file/directory at specified path