RemoteSlurmJob.run_script (function)
def run_script(self, script, files=[], trial_run=False)
Run a script on the server in the RemoteSlurmJob.conda_env, and wait for it to complete.
This is useful for short installation/setup scripts that do not belong in the scheduled job.
The resulting script
and files
are copied to RemoteSlurmJob.remote_directory
on the remote server and then script
is executed via ssh.
See RemoteSlurmJob.submit_script to submit a script via the slurm scheduler and leave running in the background on the server.
script
(string or list): shell script to run on the remote server, including any necessary installation steps. Note that the script can call any other scripts infiles
. If a string, must be the path of a valid file which will be copied to the server. If a list, must be a list of commands (i.e. a newline will be placed between each item in the list and sent as a single script to the server).files
(list, optional, default=[]): list of paths to additional files to copy to the server required in order to successfully executescript
.trial_run
(bool, optional, default=False): if True, the commands that would be sent to the server are returned but not executed.
- None
- TypeError: if
script
orfiles
are not valid types. - ValueError: if the files referened by
script
orfiles
are not valid.