.. _auto_job_submission_by_study:

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

Submits all simulation jobs belonging to a specified study to an HPC cluster, optionally applying a response template to post-process results. The worker can either block until all jobs complete or return immediately after submission, making study-level batch execution flexible for both synchronous and asynchronous workflow patterns.

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

Tagged: ``batch_submit``, ``hpc``, ``job_submission``, ``simulation``, ``study``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Study Id
     - study_id
     - remote_lookup
     - —
     - ✓
     - Integer ID of the study whose simulations will be submitted; select from the remote study lookup — all jobs associated with this study will be queued.
   * - HPC Setting Name
     - hpcconfig
     - remote_lookup
     - —
     - ✓
     - Name/ID of the saved HPC configuration (cluster, queue, resource limits) to use for job submission; must be pre-registered under the user's HPC settings.
   * - Response Template
     - template_id
     - remote_lookup
     - —
     - 
     - Optional response template ID applied after job completion to extract and roll up KPIs; leave blank to skip automated post-processing.
   * - Simulations
     - simulations
     - dataset
     - —
     - 
     - Optional dataset of specific simulation records to submit; when provided, only the listed simulations are submitted instead of the full study.
   * - Return After Submit
     - return_after_submit
     - boolean
     - False
     - 
     - Boolean flag (default false); when true, the worker returns immediately after submitting jobs without waiting for HPC completion — useful for fire-and-forget or polling-based workflows.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Study Id
     - study_id
     - integer
     - Integer ID of the study that was submitted, passed through for downstream workers that need to reference the same study.
   * - Simulations
     - simulations
     - dataset
     - Dataset of simulation records belonging to the study, including submission status and identifiers, available immediately when return_after_submit is enabled or after HPC completion otherwise.

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