.. _auto_workflow_submit_hpc:

*SUBMIT WORKFLOW USING SAVED CONFIGURATION*
===========================================

Submits a d3VIEW workflow to an HPC cluster using a previously saved HPC configuration. It creates a simulation record, stages the workflow input files, and dispatches the job via the named HPC settings profile. Use this worker whenever a workflow needs to be launched on HPC from within an automated pipeline.

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

Tagged: ``hpc``, ``hpc_config``, ``hpcjob``, ``job_launch``, ``simulation``, ``workflow_submission``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Workflow
     - wf_id
     - remote_lookup
     - —
     - ✓
     - Platform workflow ID (integer remote-lookup); selects the workflow definition to be submitted — required.
   * - Workflow File
     - wf_file
     - remote_lookup
     - —
     - ✓
     - Primary workflow definition file attachment (remote-lookup scoped to the selected workflow); this file is staged as the main solver input — required.
   * - Workflow Files
     - wf_files
     - remote_lookup
     - —
     - 
     - Optional additional workflow attachment files (multi-select remote-lookup scoped to the selected workflow); all selected files are copied into the simulation working directory alongside the primary file.
   * - Setting Name
     - hpcsetting_id
     - remote_lookup
     - —
     - ✓
     - Name or ID of the saved HPC configuration profile (remote-lookup of hpc_settings) that defines the target cluster, queue, and resource settings — required.
   * - Input File
     - input_file
     - file
     - —
     - 
     - Optional I/O file produced by an upstream workflow step; when provided, its contents are passed as inputs to the submitted workflow, enabling chained pipeline execution.
   * - Description
     - description
     - textarea
     - —
     - 
     - Optional free-text description that, when supplied, overwrites the workflow record's description field before submission.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Workflow
     - wf_id
     - integer
     - Integer platform ID of the workflow that was submitted; can be used by downstream workers to query workflow status or retrieve results.
   * - Simulation
     - sim_id
     - integer
     - Integer platform ID of the simulation (Solverresultset) record created for this HPC run; use this to poll status, extract results, or link reports.
   * - HPCjob
     - hpcjob_id
     - integer
     - Integer platform ID of the HPC job dispatched to the cluster; use this to monitor queue status, retrieve logs, or trigger downstream steps on job completion.

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

- platform.hpc_config
- platform.job_submission
- platform.workflow

.. raw:: html

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