.. _auto_study_get_simulations:

*GETS SIMULATIONS BELONGING TO THE STUDY*
=========================================

Retrieves all simulations and associated responses belonging to a specified study. Use this worker to enumerate the simulation runs within a study for downstream processing or reporting.

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

Tagged: ``lookup``, ``platform``, ``responses``, ``simulations``, ``study``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Study
     - study_id
     - remote_lookup
     - —
     - ✓
     - Integer ID of the study whose simulations should be retrieved; selected via remote lookup against /api/user/studies — required, no default.

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 queried, passed through for chaining with downstream workers.
   * - Simulations
     - simulations
     - dataset
     - Dataset containing the simulation records (rows) belonging to the study, including metadata such as simulation name, status, and run parameters.
   * - Responses
     - responses
     - dataset
     - Dataset containing the response records associated with the study's simulations, suitable for KPI extraction or correlation analysis.

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

- cae.postprocessing.response
- 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>study_get_simulations</code>. Schema hash: <code>fe0fe0d21536</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>