.. _auto_simulation_dequeue:

*DEQUEUE THE SIMULATION*
========================

Removes a queued simulation from the HPC/platform job queue, effectively cancelling its pending execution. Use this worker when a simulation needs to be withdrawn before it starts running.

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

Tagged: ``cancel``, ``dequeue``, ``hpc``, ``job_control``, ``queue``, ``simulation``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simulation
     - simulation_id
     - remote_lookup
     - —
     - ✓
     - The unique identifier of the queued simulation to be dequeued; selected via remote lookup against the simulations data source — required.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Status
     - status
     - text
     - Text status code or message returned by the platform after the dequeue operation (e.g. 'success', 'already running', 'not found').
   * - Command
     - command
     - text
     - The underlying dequeue command string that was executed against the job scheduler or platform queue.
   * - Output
     - output
     - text
     - Raw text output or log returned by the dequeue operation, useful for debugging or audit trails.

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

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