romtools.hpc.connection

Functions

run_local_bash(cmd)

Run a shell command on this machine.

Classes

Connection(host[, user, port, persist_seconds])	A simple SSH connection class that uses subprocess to execute SSH and SCP commands.
Result(stdout, stderr, exit_code)	Simple class to encapsulate the result of a command execution.

class romtools.hpc.connection.Connection(host, user=None, port=None, persist_seconds=600)

Bases: object

A simple SSH connection class that uses subprocess to execute SSH and SCP commands.

This uses connection multiplexing (ControlMaster) to reuse an existing connection per SSH session (thus only requiring authentication & handshakes once).

close()

Close the SSH connection

get(remote, local=None)

Download a file from the remote host

local(cmd)

Execute a command locally

put(local, remote=None)

Upload a file to the remote host

run(command)

Execute a command on the remote host

class romtools.hpc.connection.Result(stdout, stderr, exit_code)

Bases: object

Simple class to encapsulate the result of a command execution.

romtools.hpc.connection.run_local_bash(cmd)

Run a shell command on this machine.

Components that only need to issue shell commands take a run_cmd callable rather than a Connection, so the same logic serves either machine. This is the local half; Connection.run is the remote one.

Parameters:

cmd (str)

Return type:

Result