.. _auto_job_submission_by_simulations:

*SUBMIT SIMULATIONS*
====================

Submits all simulation jobs belonging to a given simulations dataset to an HPC cluster using the specified HPC configuration. Use this worker to batch-launch a set of pre-defined simulations in a workflow, optionally associating a response template for result extraction upon completion.

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

Tagged: ``batch``, ``hpc``, ``job_submission``, ``simulations``, ``study``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simulations
     - simulations
     - dataset
     - —
     - ✓
     - Dataset containing the set of simulations to be submitted; each row should represent one simulation record with at minimum a simulation ID column.
   * - Simulation id Column
     - sim_id_col
     - text
     - —
     - ✓
     - Name of the column in the simulations dataset that uniquely identifies each simulation (e.g., 'sim_id' or 'simulation_id'); must be selected from the columns available in the linked simulations dataset.
   * - HPC Setting Name
     - hpcconfig
     - remote_lookup
     - —
     - ✓
     - Named HPC settings profile (saved cluster configuration) that defines the target compute environment, queue, and resource allocation for job submission; select from the user's saved HPC settings.
   * - Response Template
     - template_id
     - remote_lookup
     - —
     - 
     - Optional response template to associate with submitted jobs for automated KPI/result extraction after completion; leave blank if no post-processing template is required.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Simulations
     - simulations
     - dataset
     - Updated simulations dataset reflecting the submission status and any job identifiers assigned by the HPC scheduler for each submitted simulation.

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_submission_by_simulations</code>. Schema hash: <code>6018a869dac3</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>