.. _auto_study_compare_with_physicaltest:

*COMPARE SIMULATIONS FROM STUDY WITH GIVEN TEST*
================================================

Compares all simulations within a study against a reference physical test by aligning responses through a shared response template. Use this worker to perform sim-vs-test correlation and KPI rollup across an entire study in one step.

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

Tagged: ``KPI``, ``compare``, ``correlation``, ``physical_test``, ``response_template``, ``sim_vs_test``, ``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
     - —
     - ✓
     - Unique identifier of the study whose simulations will be compared; resolved via the /api/user/studies remote lookup (required).
   * - Physicaltest
     - physicaltest_id
     - remote_lookup
     - —
     - ✓
     - Unique identifier of the reference physical test to compare against; resolved via the /api/user/physicaltests remote lookup (required).
   * - Responsetemplate
     - responsetemplate_id
     - remote_lookup
     - —
     - ✓
     - Unique identifier of the response template that defines which channels/KPIs to extract and align for the comparison; resolved via /api/user/responsetemplates (required).
   * - Responses
     - responses
     - remote_lookup
     - —
     - 
     - Optional subset of individual response IDs from the selected template to include in the comparison; if left empty all responses defined by the template are used (multi-select).

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Study Id
     - study_id
     - scalar
     - Passes through the input study ID as a scalar so downstream workers can reference the same study without re-specifying it.
   * - Simulations
     - simulations
     - dataset
     - Tabular dataset listing each simulation in the study together with its extracted response values and sim-vs-test correlation metrics.
   * - Responses
     - responses
     - dataset
     - Tabular dataset of the individual response-level results (channel name, sim value, test value, delta, correlation score) for every simulation–response pair evaluated.

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

- cae.postprocessing.response
- data.correlation
- data.dataset.ingest

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