.. _auto_job_submit_by_config:

*JOB SUBMISSION BY SAVED CONFIGURATION*
=======================================

Submits an HPC simulation job using a previously saved HPC configuration, uploading the required input and optional include files. Supports optional project, study, and template association, and can either block until HPC completion or return immediately after submission.

When to use
-----------

Tagged: ``hpc``, ``job_submission``, ``saved_config``, ``simulation``, ``submit``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simulation Name
     - job_submit_by_config_input_4
     - text
     - —
     - 
     - Optional human-readable label assigned to the simulation upon submission; leave blank to use the platform default naming.
   * - HPC Setting Name
     - job_submit_by_config_input_1
     - remote_lookup
     - —
     - ✓
     - Required name of the saved HPC settings profile (cluster, queue, solver version, resource limits) to use for this job; select from previously registered HPC configurations.
   * - Project ID
     - job_submit_by_config_input_5
     - remote_lookup
     - —
     - 
     - Optional project to associate with this simulation for organisational and access-control purposes; leave blank if no project grouping is needed.
   * - Main Input File
     - job_submit_by_config_input_2
     - file
     - —
     - ✓
     - Required primary solver input file(s) (e.g. LS-DYNA .k / .key deck); multiple files may be supplied when the solver expects several top-level inputs.
   * - Include Files
     - job_submit_by_config_input_3
     - file
     - —
     - 
     - Optional additional include or dependency files (mesh, material, part files) referenced by the main input deck; repeat the slot for each file.
   * - Parameters
     - job_submit_by_config_input_5
     - dataset
     - —
     - 
     - Optional project to associate with this simulation for organisational and access-control purposes; leave blank if no project grouping is needed.
   * - Template ID
     - job_submit_by_config_input_6
     - remote_lookup
     - —
     - 
     - Optional template ID used to post-process or classify the simulation results after completion; leave blank if no result template is required.
   * - Study ID
     - study_id
     - remote_lookup
     - —
     - 
     - Optional study to associate with this simulation, grouping it with related design-exploration or DOE runs; leave blank if no study context applies.
   * - Return After Submit
     - return_after_submit
     - boolean
     - False
     - 
     - When set to true the worker returns immediately after queuing the job and does not wait for HPC completion, making Simulation and HpcJob IDs available at once; default false blocks until the job finishes.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Simulation
     - job_submit_by_config_output_1
     - integer
     - Integer ID of the d3VIEW simulation record created for this job; use as a handle for downstream post-processing or result-retrieval workers.
   * - HpcJob
     - job_submit_by_config_output_2
     - integer
     - Integer ID of the HPC job record tracking queue status, resource usage, and completion state on the target cluster.

Disciplines
-----------

- platform.hpc_config
- platform.job_submission

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>job_submit_by_config</code>. Schema hash: <code>aeaa0556c6e5</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>