hm_jobs_submitHSTJob

Submits a HyperStudy job to the server.

Syntax

hm_jobs_submitHSTJob app_id version job_name solver input_file output_path additional_files zip_flag args

Type

HyperMesh Tcl Query Command

Description

Submits a HyperStudy job to the server.

Returns the job ID upon successful submission, or null on failure.

Always set the current server on which the job needs to be submitted by using hm_jobs_setCurrentServer before submitting a job. To run jobs locally using PBS-sensor, set the current server as "local". Jobs submitted using the local server will run in sequential order. For local job submission, the additional_files and zip_flag arguments can be passed as null strings, and the main file should hold all the information related to the additional files.

Inputs

app_id
The application name to which the job has to be submitted to (for example, HST_batch).
version
The HyperStudy version to use (for example, 2024).
job_name
The name of the job to submit.
solver
The solver to be used (for example, OptiStruct).
input_file
The full name and path of the input file.
output_path
The full path where the output should go.
additional_files
A string containing any required additional files that need to be uploaded.
zip_flag
Must be set as "true" if any .zip file is passed, "false" otherwise.
args
Any additional HyperStudy command line arguments.

Examples

To submit a HyperStudy job on the server:

hm_jobs_submitHSTJob HST_batch 14.0 "new_job" OptiStruct "C:/temp/input/main.hstx" "C:/temp/output" "{C:/temp/input/secondary1.dat} {C:/temp/input/secondary2.dat}" false ""

Errors

Incorrect usage results in a Tcl error. To detect errors, you can use the catch command:
if { [ catch {command_name...} ] } {
   # Handle error
}

Version History

14.0.130