RemoteAPI

In order to manage the remote to which the user is connected to, you can use, within the Block execution, the RemoteAPI. The API is automatically instantiated and assigned to the current running block. Therefore, within the Block action function, you can access it under ‘block.remote’.

def mySlurmBlockInitialAction(block: SlurmBlock):

    # Access the remote using block.remote
    remoteName = block.remote.name
    remoteHost = block.remote.host
    remoteWorkDir = block.remote.workDir

    # Execute commands in the remote or locally using the command method
    block.remote.command('ls -l')

    # Send files to the remote using the sendData method
    remoteUploadedPath = block.remote.sendData('myFile.txt', 'my/Destination/path/in/remote.txt')

    # Transfer back the files using the getData method
    finalDownloadedPath = block.remote.getData('my/Destination/path/in/remote.txt', 'myFile.txt')

    # Change the remote working directory using the cd context manager
    with block.remote.cd('my/remote/path'):
        output = block.remote.command('ls -l')
        print ("Output of ls -l in my/remote/path: ", output)

    # Submit Slurm jobs using the submitJob method
    jobID = block.remote.submitJob('path/to/slurm/script.sh')

    # Here you can pass a list of path to submit multiple jobs at once
    jobIDs = block.remote.submitJob(['path/to/slurm/script.sh', 'path/to/another/slurm/script.sh'])

Warning

When using the submitJob method, if you pass a list of paths to submit multiple jobs at once, Horus will automatically submit all jobs at once. If a single one of them fails during the submission phase (for example, the queue specified for one of them does not exist), all jobs will be submitted but not registered in Horus. In order to avoid this, you need to make sure that all jobs have the same specifications for each submitJob call.

Executing commands

As seen in the above section. one can use the RemoteAPI to execute commands in the remote or in the local machine. Horus will automatically send the commands based on the selected remote from the block. In order to override this behaviour and send commands locally even though a remote is selected, set the forceLocal argument to true.

# Creates the folder in the remote
block.remote.command("mkdir myFolder")

# Creates the folder on the local machine
block.remote.command("mkdir myFolder", forceLocal=True)

Methods

The RemoteAPI methods can be found in the Source code section.