2.2. Submit¶

What is submit?¶

The Submit process is a tool to help submit a hpc job to a cluster using d3VIEW from the command line instead of the web interface.

Not only can jobs be submitted, but postprocessing can be done on completed jobs.

Requirements¶

Python 2.7 (Latest release of Python 2.7 can be found here)
Lucy
Connection to d3VIEW

How to run¶

The Submit tool is used by invoking Lucy, and specifying the arguments needed to submit/monitor a job. The most basic command is as follows:

$ lucy submit -d3view-url http://d3VIEW-internal.com -job-json job.json

lucy submit -d3view-url http://d3VIEW-internal.com -job-json job.json

If you don’t have a job.json file prepared, one will automatically be created after running the command with the keyword arguments outlined below.

Without the prepared job.json, the submit command will look like:

$ lucy submit \
-d3view-url http://d3VIEW-internal.com \
-u my_name \
-a b19ed11cee194d0b7cb1f1d5a0a80e890972c06c \
-t lsdyna \
-v r712sp \
-i my_input_file.k \
-inc "key" \
-c 8 \
-q test_queue \
-w 999:00:00 \
-solver-args "precision=sp, binout_to_ascii=no" \
-n my_test_job1 \
-d "Testing my first job" \
-download-attachments "dyna_binout, dyna_ascii"

Arguments¶

Submit comes with a number of arguments to allow flexibility when submitting different kinds of jobs.

All arguments are shown directly below, with links to their sections.

Parameter name	When required
Connection arguments
`-d3view-url`	Always required
`-d3view-port`	Always required
`-u`, `-user`	Always required
`-a`, `-api-key`	Always required

Simulation arguments
`-s`, `-hpcserver-name`
`-project-id`
`-loadcase-name`
`-loadcase-id`
`-t`, `-solver-type`	Required for new simulations
`-v`	Required for new simulations
`-i`	Required for new simulations
`-inc`, `-include-files`
`-c`, `-ncpu`	Required for new simulations
`-q`	Required for new simulations
`-w`, `-walltime`	Required for new simulations
`-solver-args`
`-r`, `-response-template`
`-n`, `-name`, `-job-name`
`-d`, `-description`, `-job-desc`
`-vd`, `-variable-definition`,

Additional arguments
`-job-json`
`-new-simulation`
`-job-id`
`-simulation-id`
`-download-attachments`

Connection arguments¶

These Arguments are required for the application to be able to log into d3VIEW.

-d3view-url¶: The url to d3VIEW. Such as http://d3VIEW-internal.com (Note: do not include port number if shown, that is the next parameter.)

-d3view-port¶: The port to d3VIEW, if it is not 80, this should be set.

-u, -user¶: The name of the user submitting the job in d3VIEW,

-a, -api-key¶: The API Key found in d3VIEW.

API Key¶

To find the API Key follow these steps:

Log in to d3VIEW.
Click on the profile icon, found directly next to the Logout button.
In the info section the 4th item down is the API Key

Simulation arguments¶

-s, -hpcserver-name¶: The name of the HPC server (in d3VIEW) that the job is going to be submitted to.

-project-id¶: The name of the d3VIEW project that the simulation should be part of.

-loadcase-name¶: The name of the d3VIEW loadcase that will be attached to the simulation.

-loadcase-id¶: The id of the loadcase in d3VIEW.

-t, -solver-type¶: The type of solver to be run, such as lsdyna

-v¶: Solver version to run. Supported versions are shown in d3VIEW on the submit screen.

-i¶: The path to the main input file for the simulation. If the main input file is not in the current working directory, the full path must be specified.

-inc, -include-files¶

File types or files to include in the simulation, usually additional input files.

If multiple files or file extensions are going to be included, the entire group should be surrounded in double quotes and each file name or extension should be separated by a comma and space.

The format to include files is as follows:

-inc "ext1, ext2, ext3, filename.extension"

-c, -ncpu¶: The number of cpus to run the simulation

-q¶: The queue for the hpc job. See Finding the scheduler queue

-w, -walltime¶

The walltime for the job in format:

"HHH:MM:SS"

‘HHH’ is hours (000-999) ‘MM’ is minutes (00-59) ‘SS’ is seconds (00-59)

-solver-args¶

key=value For each d3VIEW solver argument in the format:

"precision=sp, binout_to_ascii=no, example=\"quoted value\", example2=2"

-r, -response-template¶: The name of the response template to apply

-n, -name, -job-name¶

The name of the simulation. If set to 'auto', Submit will name the simulation as a combination of the working directory and the parent directory.

If the folder structure is:

root
 ├ stage1
 │  ├ 1.1 (working directory)
 │  │  ├ main_input_file.k
 │  │  └ additional_input_file.key

The simulation will be named stage1_1.1. This is especially useful for LS-OPT where multiple simulations will be submitted from the same LS-OPT job.

-d, -description, -job-desc¶: The description of the simulation

-vd, -variable-definition¶: Path to the variable definition file.

HPC server¶

The name of the HPC server should match the name shown in the Select HPC Server dropdown when submitting a job in d3VIEW.

To navigate to this screen:

Log in to d3VIEW.
Click on the Simulations tab (if not already there)
Click the blue + New Simulation button found in the top right of the screen
Scroll down to the Select HPC Server section
Click Nothing Selected to open the dropdown.

solver version¶

The supported solver versions can be found easily by using the following steps:

Log in to d3VIEW.
Click on the Simulations tab (if not already there)
Click the blue + New Simulation button found in the top right of the screen
Scroll down to the Select HPC Server section, and select the HPC Server
Choose the solver type using the Choose Solver dropdown.
Notice the Solver Version attribute. It will be either a dropdown or text box.
If it is a text box, there is only one solver version. Otherwise open the dropdown to view all supported solver versions.

Finding the scheduler queue¶

Log in to d3VIEW.
Click on the Simulations tab (if not already there)
Click the blue + New Simulation button found in the top right of the screen
Scroll down to the Select HPC Server section, and select the HPC Server
Choose the solver type using the Choose Solver dropdown.
The queue dropdown is in the middle of the screen immediately above the Add this Configuration button.
Click to open the dropdown and reveal available queues.

d3VIEW solver argument¶

d3VIEW solver arguments are the arguments in the grey box once the solver type has been chosen on the submit screen.

Follow these steps to find the solver arguments for the solver of your choice.

Log in to d3VIEW.
Click on the Simulations tab (if not already there)
Click the blue + New Simulation button found in the top right of the screen
Scroll down to the Select HPC Server section, and select the HPC Server
Choose the solver type using the Choose Solver dropdown.
All of the Bold names are the display names of the solver attributes, with their respective values in the field below each one.

The format of the fields is as follows:

-solver-args "precision=sp, binout_to_ascii=no"

Note

An administrator can get the ID from a solver attribute if requested.

Additional arguments¶

-job-json¶

This option allows loading all parameters from a job.json file instead of having a large command.

The contents of the job.json file should look like:

{
  "api_url": "<URL>",
  "api_port": "<PORT>",
  "username": "<USER_NAME>",
  "api_key": "<API_KEY>",
  "hpcserver_name": "<SERVER_NAME>",
  "solver_type": "<SOLVER_TYPE>",
  "solver_version": "<VERSION>",
  "solver_input": "<INPUT_FILE>",
  "include_files": "<INCLUDES>",
  "num_cores": "<NUMBER_OF_CPU>",
  "job_queue": "<QUEUE>",
  "scheduler_walltime": "<WALLTIME>",
  "solver_args": "<SOLVER_ARGS>",
  "response_template": "<RESPONSE_TEMPLATE>",
  "job_name": "<JOB_NAME>",
  "job_description": "<DESCRIPTION>",
  "download_types": "<DOWNLOAD_ATTACHMENTS>"
}

-new-simulation¶: If specified, this will create a new simulation every time the process is run. Otherwise subsequent runs using the same job.json will try connect to the existing simulation.

-job-id¶: The job id used to connect to an existing simulation (Must also specify -simulation-id)

-simulation-id¶: The simulation id used to connect to an existing simulation (Must also specify -job-id)

-download-attachments¶

List of types or files to download. Using the same format as -inc.

If multiple files or file extensions are going to be downloaded, the entire group should be surrounded in double quotes and each file name or extension should be separated by a comma and space.

The format to include files is as follows:

-download-attachments "ext1, ext2, ext3, filename.extension"