As part of the setup, you must add an entry for your custom cluster keyword in the jobConfiguration.xml file, and reference the files that are needed for this cluster job type.

The hpc_commands file provides the information on how commands or queries related to job execution are executed. The file can also refer to a number of environment variables.

"""
Copyright (C) 2015 ANSYS, Inc. and its subsidiaries.  All Rights Reserved.

$LastChangedDate$
$LastChangedRevision$
$LastChangedBy$
"""

import sys
import ansLocale
import os
import tempfile
import os.path
import shutil
import glob
import shlex
import subprocess
import time
import platform
print('RSM_HPC_DEBUG=Submitting job...')

# See Below #1
print('Custom Coding goes here')

# SSH needs to use a username to login, either this is defined in 'RSM_HPC_PROTOCOL_OPTION1' 
# which is the account name from the Cluster Tab or we will use the currently logged in username.
_sshUser = os.getenv("RSM_HPC_PROTOCOL_OPTION1")
if _sshUser == None:
    _sshUser = "%USERNAME%"
print('RSM_HPC_DEBUG=SSH account: ' + _sshUser);

# RSM_HPC_PROTOCOL_OPTION2 is the name of the cluster node that was entered in the Cluster Tab.
# We will reference 'RSM_HPC_PROTOCOL_OPTION2' below, and the command will not succeed 
# if its not defined  so check it and give a specific error if it is not set.
if os.getenv("RSM_HPC_PROTOCOL_OPTION2") == None:
    print("RSM_HPC_ERROR=RSM_HPC_PROTOCOL_OPTION2 (Remote Cluster Node Name) not defined")
    sys.exit(1)

# Check to see if the computer is using windows if so PuTTY will need to be
# installed and we reference the putty command 'plink' here to connect to the remote machine.
# See Below #2
if platform.system() == 'Windows':
    _plinkArgs = "plink.exe -i \"%KEYPATH%\" " + _sshUser + "@%RSM_HPC_PROTOCOL_OPTION2% 
    \" ''cd \"%RSM_HPC_STAGING%\"; bsub"
else:
    # NOTE: entire command sent to SSH is wrapped in quotes \"  \"
    _plinkArgs = "ssh " + _sshUser + "$RSM_HPC_PROTOCOL_OPTION2 \" ''cd \"$RSM_HPC_STAGING\"; bsub"

# Check that various environment variables are automatically set by RSM 
# and use their values to determine what command line options need to be added to submission command.  
# See Below #3
_numcores = os.getenv("RSM_HPC_CORES")
if not _numcores == None:
  _plinkArgs += " -n " + _numcores

_jobname = os.getenv("RSM_HPC_JOBNAME")
if not _jobname == None:
   _plinkArgs += " -J \\\"" + _jobname + "\\\"" 
   
_queue = os.getenv("RSM_HPC_QUEUE")
if not _queue == None and not _queue == "":
    _plinkArgs += " -q " + _queue

_staging = os.getenv("RSM_HPC_STAGING")
_plinkArgs += " -cwd \"" + _staging + "\""

_distributed = os.getenv("RSM_HPC_DISTRIBUTED")
if _distributed == None or _distributed == "FALSE":
    _plinkArgs += " -R 'span[hosts=1]'"
    
_nativeOptions = os.getenv("RSM_HPC_NATIVEOPTIONS")
if not _nativeOptions == None:
    _plinkArgs += " " + _nativeOptions

_stdoutfile = os.getenv("RSM_HPC_STDOUTFILE")
if not _stdoutfile == None:
   _plinkArgs += " -o " + _stdoutfile
   
_stderrfile = os.getenv("RSM_HPC_STDERRFILE")
if not _stderrfile == None:
   _plinkArgs += " -e " + _stderrfile


# Some environment variables were written directly into the string '_plinkArgs'     
# and we want to replace those references with their actual values before submission.
print('RSM_HPC_DEBUG=plink arguments: ' + _plinkArgs);
_plinkArgs = os.path.expandvars(_plinkArgs);

# Other variables, like RSM_HPC_COMMAND, have environment variables 
# referenced internally.  For instance, this command has $AWP_ROOT242 embedded, and we want to keep 
# that environment variable to expand on the cluster since $AWP_ROOTxxx is used on cluster not locally.    
# See Below #4
_bsubCommand = os.getenv("RSM_HPC_COMMAND")
if not _bsubCommand == None:
    # NOTE: entire command sent to SSH is wrapped in quotes \"  \".  See same note above
    # NOTE: Staging Directory and Command are also wrapped in quotes \" \"...
    _plinkArgs += " /bin/sh \"" + _staging + "/" + _bsubCommand + "\" \""

print('RSM_HPC_DEBUG=plink arguments: ' + _plinkArgs);
# See Below #5
_process = subprocess.Popen(shlex.split(_plinkArgs), stdout=subprocess.PIPE, 
stderr=subprocess.STDOUT, cwd=os.getcwd())   
try:
    while _process.poll() == None:
        time.sleep(1)
except:
    pass
print("RSM_HPC_DEBUG=bsub completed")

# It is optional to print the 'START' output, usually this is only done if 
# previous command output could be confused by the parser with the intended output.
print('START')

for line in _process.stdout:
    print line
sys.exit(0)

Since this script is a Submit script, there are many options for bsub command, and because this is a custom client integration, the commands are being wrapped in an SSH command to submit from the local machine to the remote machine. However, it is much simpler to create a custom script for the Cancel command, although it contains the same basic parts. This process is addressed in the next section.

"""
Copyright (C) 2015 ANSYS, Inc. and its subsidiaries.  All Rights Reserved.

$LastChangedDate$
$LastChangedRevision$
$LastChangedBy$
"""

import sys
import ansLocale
import os
import tempfile
import os.path
import shutil
import glob
import shlex
import subprocess
import time
import platform
print('RSM_HPC_DEBUG=Cancelling job...')
# See Below #1
print('Custom Coding goes here')

# SSH needs to use a username to login, either this is defined in 'RSM_HPC_PROTOCOL_OPTION1' 
# which is the account name from the Cluster Tab or we will use the currently logged in username.
_sshUser = os.getenv("RSM_HPC_PROTOCOL_OPTION1")
if _sshUser == None:
    _sshUser = "%USERNAME%"
print('RSM_HPC_DEBUG=SSH account: ' + _sshUser);

# RSM_HPC_PROTOCOL_OPTION2 is the name of the cluster node that was entered in the Cluster Tab.
# We will reference 'RSM_HPC_PROTOCOL_OPTION2' below, and the command will not succeed 
# if its not defined  so check it and give a specific error if it is not set.
if os.getenv("RSM_HPC_PROTOCOL_OPTION2") == None:
    print("RSM_HPC_ERROR=RSM_HPC_PROTOCOL_OPTION2 (Remote Cluster Node Name) not defined")
    sys.exit(1)

# Code below is for cancelling a job on a standard LSF cluster.      
# On Windows we must use the third party PuTTY interface "plink" to 
# access the remote machine, in linux we can just use SSH.
# See Below #2
if platform.system() == 'Windows':
    _plinkArgs = "plink.exe -i \"%KEYPATH%\" " + _sshUser + "@%RSM_HPC_PROTOCOL_OPTION2% 
    \" ''cd \"%RSM_HPC_STAGING%\"; bkill "
else:
    # NOTE: entire command sent to SSH is wrapped in quotes \"  \"
    _plinkArgs = "ssh " + _sshUser + "$RSM_HPC_PROTOCOL_OPTION2 \" ''cd \"$RSM_HPC_STAGING\"; bkill "

# Check that various environment variables are automatically set by RSM 
# and use their values to determine what command line options need to be added to submission command.    
# See Below #3
_jobid = os.getenv("RSM_HPC_JOBID")
if _jobid == None:
    print('RSM_HPC_JOBID not set')
    sys.exit(1)
else:
    _plinkArgs += _jobid
# NOTE: entire command sent to SSH is wrapped in quotes \"  \".  
# See same note above.
if platform.system() != 'Windows':
   _plinkArgs += " \""
_plinkArgs = os.path.expandvars(_plinkArgs);
print('RSM_HPC_DEBUG=' + _plinkArgs);
# See Below #4
_process = subprocess.Popen(shlex.split(_plinkArgs), bufsize=-1, stdout=subprocess.PIPE, 
stderr=subprocess.PIPE, cwd=os.getcwd())
try:
    while _process.poll() == None:
        time.sleep(1)
except:
    pass
print("RSM_HPC_DEBUG=bkill completed")
# See Below #5
for line in _process.stdout:
    print('RSM_HPC_DEBUG='+line)
    
_error = False
# See Below #5
for line in _process.stderr:
    print('RSM_HPC_ERROR='+line)
    _error = True
    
if _error:
    sys.exit(1)
sys.exit(0)