Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new default(hpcName: string, jobId?: string, maintainer?: default, env?: {}, is_cvmfs?: boolean): default

Properties

config

config: hpcConfig

config

db

db: default = ...

Protected envCmd

envCmd: string = "#!/bin/bash\n"

hpcName

hpcName: string

isContainer

isContainer: boolean = false

is_cvmfs

is_cvmfs: boolean

jobId

jobId: string

properties

maintainer

maintainer: default

parent pointer

modules

modules: string[] = []

remote_data_folder_path

remote_data_folder_path: string

remote_executable_folder_path

remote_executable_folder_path: string

remote_result_folder_path

remote_result_folder_path: string

slurm_id

slurm_id: string

template

template: string

x

x: any

Methods

cancel

  • cancel(): Promise<void>

cat

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

    creates an empty file at specified path

    param(string)

    path - specified path with filename

    param(object)

    options - dictionary with string options

    return(object)

    returns - command execution output

    Parameters

    Returns Promise<string>

createFile

  • createFile(content: string | Object, remotePath: string, options?: options, muteEvent?: boolean): Promise<void>
  • aysnc

    creates file with specified content

    param(string)

    content - file content

    param(string)

    path - specified path with filename

    param(object)

    options - dictionary with string options

    Parameters

    • content: string | Object
    • remotePath: string
    • options: options = {}
    • muteEvent: boolean = false

      set to True if you want to mute maintauner emitted Event

    Returns Promise<void>

download

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

    Uncompresses the specified zip file to the Local folder

    throws

    {ConnectorError} - Thrown if maintainer emits 'SSH_SCP_DOWNLOAD_ERROR'

    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>

exec

  • exec(commands: string | string[], options?: options, muteEvent?: boolean, muteLog?: boolean, continueOnError?: boolean): Promise<out>
  • async

    Executes the command on the maintainer and returns the outpt

    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

getContainerCVMFSFolderPath

  • getContainerCVMFSFolderPath(providedPath?: string): string

  • Get Container CVMFS folder path

    param{string}

    providedPath - specified path

    return{string}
    • executable path

    Parameters

    • providedPath: string = null

    Returns string

getContainerDataFolderPath

  • getContainerDataFolderPath(providedPath?: string): string

  • Get Container data folder path

    param{string}

    providedPath - specified path

    return{string}
    • executable path

    Parameters

    • providedPath: string = null

    Returns string

getContainerExecutableFolderPath

  • getContainerExecutableFolderPath(providedPath?: string): string

  • Get Container executable folder path

    param{string}

    providedPath - specified path

    return{string}
    • executable path

    Parameters

    • providedPath: string = null

    Returns string

getContainerResultFolderPath

  • getContainerResultFolderPath(providedPath?: string): string

  • Get Container result folder path

    param{string}

    providedPath - specified path

    return{string}
    • executable path

    Parameters

    • providedPath: string = null

    Returns string

getRemoteDataFolderPath

  • getRemoteDataFolderPath(providedPath?: string): string

getRemoteExecutableFolderPath

  • getRemoteExecutableFolderPath(providedPath?: string): string

getRemoteResultFolderContent

  • getRemoteResultFolderContent(): Promise<string[]>
  • async

    Get remote results folder content

    param{string}

    providedPath - specified path

    return{string[]}
    • file content

    Returns Promise<string[]>

getRemoteResultFolderPath

  • getRemoteResultFolderPath(providedPath?: string): string

Private getSBatchTagsFromArray

  • getSBatchTagsFromArray(tag: string, vals: string[]): string

  • Get sbatch tags

    param{string}

    tag - sbatch tags

    param{string[]}

    vals - values of sbatch tags

    return{string}
    • sbatch string

    Parameters

    • tag: string
    • vals: string[]

    Returns string

getSlurmStderr

  • getSlurmStderr(): Promise<void>

getSlurmStdout

  • getSlurmStdout(): Promise<void>

getStatus

  • getStatus(): Promise<string>

getUsage

  • getUsage(): Promise<{ cpuTime: any; cpus: any; memory: any; memoryUsage: any; nodes: any; walltime: any }>

  • Get job usage

    return{object}
    • usage dictionary

    Returns Promise<{ cpuTime: any; cpus: any; memory: any; memoryUsage: any; nodes: any; walltime: any }>

homeDirectory

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

ls

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

    Returns all of the files/directories in specified path

    param{string}

    path - specified path

    param{object}

    options - dictionary with string options

    return{object}
    • returns command execution output

    Parameters

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

    Returns Promise<string>

mkdir

  • mkdir(path: string, options?: options, muteEvent?: boolean): Promise<string>
  • aysnc

    creates directory at specified path

    param(string)

    path - specified path with filename

    param(object)

    options - dictionary with string options

    return(object)

    returns - command execution output

    Parameters

    • path: string
    • options: options = {}
    • muteEvent: boolean = false

      set to True if you want to mute maintauner emitted Event

    Returns Promise<string>

pause

  • pause(): Promise<void>

prepare

  • prepare(cmd: string, config: slurm): Promise<void>

  • Creates slurm string with specified configuation

    param{string}

    cmd - command that needs to be executed

    param{slurm}

    config - slurm configuration

    Parameters

    Returns Promise<void>

pwd

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

    Returns the specified path

    param{string}

    path - execution path

    param{object}

    options - dictionary with string options

    return{object}
    • returns command execution output

    Parameters

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

    Returns Promise<string>

registerModules

  • registerModules(modules: string[]): void

resume

  • resume(): Promise<void>

rm

  • rm(path: string, options?: options, muteEvent?: boolean): Promise<string>
  • aysnc

    removes the file/folder at specified path

    param(string)

    path - specified path with filename

    param(object)

    options - dictionary with string options

    return(object)

    returns - command execution output

    Parameters

    • path: string
    • options: options = {}
    • muteEvent: boolean = false

      set to True if you want to mute maintauner emitted Event

    Returns Promise<string>

setRemoteDataFolderPath

  • setRemoteDataFolderPath(providedPath: string): void

setRemoteExecutableFolderPath

  • setRemoteExecutableFolderPath(providedPath: string): void

setRemoteResultFolderPath

  • setRemoteResultFolderPath(providedPath: string): void

ssh

submit

  • submit(): Promise<void>

tar

  • tar(from: string, to: string, options?: options, muteEvent?: boolean): Promise<string>
  • aysnc

    tars the file/directory at specified path

    param(string)

    from - input file/directory path

    param(string)

    to - compress file path with file name

    param(object)

    options - dictionary with string options

    return(object)

    returns - command execution output

    Parameters

    • from: string
    • to: string
    • options: options = {}
    • muteEvent: boolean = false

      set to True if you want to mute maintauner emitted Event

    Returns Promise<string>

transferFile

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

    Transfers a file from the local machine to remote machine

    throws

    {ConnectorError} - Thrown if maintainer emits 'SSH_SCP_DOWNLOAD_ERROR'

    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>

untar

  • untar(from: string, to: string, options?: options, muteEvent?: boolean): Promise<string>
  • aysnc

    untars the file/directory at specified path

    param(string)

    from - input file/directory path

    param(string)

    to - compress file path with file name

    param(object)

    options - dictionary with string options

    return(object)

    returns - command execution output

    Parameters

    • from: string
    • to: string
    • options: options = {}
    • muteEvent: boolean = false

      set to True if you want to mute maintauner emitted Event

    Returns Promise<string>

unzip

  • unzip(from: string, to: string, options?: options, muteEvent?: boolean): Promise<string>
  • aysnc

    unzips the file/folder at specified path

    param(string)

    from - input file/directory path

    param(string)

    to - compress file path with file name

    param(object)

    options - dictionary with string options

    return(object)

    returns - command execution output

    Parameters

    • from: string
    • to: string
    • options: options = {}
    • muteEvent: boolean = false

      set to True if you want to mute maintauner emitted Event

    Returns Promise<string>

upload

  • upload(from: string, to: string, muteEvent?: boolean): Promise<void>
  • aysnc

    Compresses the contents of the LocalFolder to the specified zip file

    throws

    {ConnectorError} - Thrown if maintainer emits 'SSH_SCP_DOWNLOAD_ERROR'

    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>

whoami

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

zip

  • zip(from: string, to: string, options?: options, muteEvent?: boolean): Promise<string>
  • aysnc

    zips the file/directory at specified path

    param(string)

    from - input file/directory path

    param(string)

    to - compress file path with file name

    param(object)

    options - dictionary with string options

    return(object)

    returns - command execution output

    Parameters

    • from: string
    • to: string
    • options: options = {}
    • muteEvent: boolean = false

      set to True if you want to mute maintauner emitted Event

    Returns Promise<string>

Generated using TypeDoc