.. _auto_study_dequeue:

*DEQUEUE STUDY SIMULATIONS*
===========================

Removes all queued simulations from a specified Study, effectively cancelling their pending execution. Use this worker when you need to clear a study's simulation queue before re-submitting, modifying parameters, or aborting a batch run.

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

Tagged: ``cancel``, ``dequeue``, ``queue_management``, ``simulation``, ``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
     - —
     - ✓
     - The unique identifier of the Study whose queued simulations should be dequeued; selected via remote lookup from the available studies list — required, no default.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Report
     - report
     - dataset
     - A dataset summarising the dequeue operation result, including which simulations were removed from the queue and any errors encountered.

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

- platform.job_submission
- 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_dequeue</code>. Schema hash: <code>3204de6e8eca</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>