apps.crc_scancel
==========================

.. autoapi-nested-parse::

   A simple wrapper around the Slurm ``scancel`` command.

   This application allows users to cancel a Slurm job by providing a job ID.
   It differs from the default ``scancel`` command by adding a confirmation
   prompt to confirm users are canceling the correct job.





Module Contents
---------------

.. py:class:: CrcScancel

   Bases: :py:obj:`apps.utils.cli.BaseParser`


   Cancel a Slurm job submitted by the current user.


   .. py:attribute:: user


   .. py:method:: cancel_job_on_cluster(cluster: str, job_id: int) -> None
      :staticmethod:


      Cancel a running slurm job

      :param cluster: The name of the cluster the job is running on
      :param job_id: The ID of the slurm job to cancel



   .. py:method:: get_cluster_for_job_id(job_id: int) -> str

      Return the name of the cluster a slurm job is running on

      Exits the application with an error

      :param job_id: The ID of th slurm job

      :returns: The name of the cluster as a string



   .. py:method:: app_logic(args: argparse.Namespace) -> None

      Logic to evaluate when executing the application

      :param args: Namespace of parsed arguments from the command line