SubmitRemoteJob dialog.
Table of Contents
| Name | Direction | Type | Default | Description |
|---|---|---|---|---|
| ComputeResource | Input | string | Mandatory | The name of the remote computer to submit the job to. Allowed values: ['SCARF@STFC‘] |
| NumNodes | Input | number | 1 | The number of compute nodes the job requires |
| CoresPerNode | Input | number | 1 | The number of processes to start on each compute node |
| TaskName | Input | string | A short name for the job (optional). | |
| TransactionID | Input | string | Mandatory | The transaction ID to associate with this job |
| ScriptName | Input | string | Mandatory | A name for the runnable/executable (for example a python script) that will be executed |
| ScriptParams | Input | string | Mandatory | Parameters to pass to the runnable/script/executable - when running python scripts through the the Mantid remote job submission API this will be the actual python code to execute |
| JobID | Output | string | An ID string for this job |
Submit a job to be executed on the specified (remote) compute resource. After this, you can query the status of this job or all the jobs using the algorithms QueryRemoteJob v2 and QueryAllRemoteJobs v2, respectively. Jobs submitted with this algorithm can be cancelled/killed/aborted with the algorithm AbortRemoteJob v2.
Note that the script and script parameters properties are used in an implementation dependent way. For example, if using the Mantid web service job submission API, the script parameters properties is used to provide the actual content of a python script to run. For other variants (underlying job schedulers), such as Platform LSF, the parameters property is used for different application specific command line options. For more details on remote algorithms when using the Mantid web service remote job submission API, see the remote job submission API docs.
Version 1 uses different input properties (PythonScript) and submits jobs using the Mantid remote job submission API. This is still supported as one of the variants of Versions 2 and above, when the compute resource uses the Mantid remote job submission API as job manager (underlying remote job scheduling mechanism).
Categories: Algorithms | Remote