.. _auto_study_clean:

*REMOVES SIMULATIONS AND TESTS IN THIS STUDY*
=============================================

Removes all simulations (solver result sets) and physical tests associated with a given study, effectively cleaning it back to an empty state. Use this worker when you need to reset a study's results before re-running or archiving it.

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

Tagged: ``cleanup``, ``delete``, ``physical_tests``, ``responses``, ``simulations``, ``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
     - —
     - ✓
     - The unique identifier of the study to clean; resolved via the remote study lookup (remote_lookup_studies) — required, no default.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Study
     - study
     - integer
     - The integer ID of the study that was cleaned, echoed back for downstream reference.
   * - Clean Up Results
     - results
     - keyvalue
     - Key-value summary of the cleanup operation, containing num_simulations_before_cleanup, num_simulations_after_cleanup, num_tests_before_cleanup, and num_tests_after_cleanup counts.

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

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