CRC Wrappers

×

Status message

You have been redirected to 'https://crc-pages.pitt.edu/user-manual/applications/crc-wrappers/'.

Attention: You are viewing a page from the old CRC user manual.

This page may not represent the most up to date version of the content.

You can view it in our new user manual here.

The CRC Team provides some wrapper scripts that make interacting with SLURM easier by abstracting away some of the details of common commands. The scripts are written in Python and should accept -h and --help to provide help documentation.

What commands are available?

Wrapper Command SLURM Functionality  Explanation
crc-sinfo sinfo Oververview of the current hardware status
crc-squeue squeue

Provide a more convenient view of your currently running jobs

  • crc-squeue --start: Show approximate start time for your jobs, won’t show if you hit association limits
  • crc-squeue --watch: Watch your jobs as they progress in time (updates 10 seconds at a time)
  • crc-squeue --all: Show all the jobs on the cluster
crc-scancel scancel Cancel the the job with the provided JobID 
crc-interactive srun
  • Run interactive jobs on the cluster
    • To submit an interactive job, you should use the CRC wrapper:

      crc-interactive --smp --time=1:00 --num-cores=2

      would give you an interactive job for 1 hour on SMP with 2 processors. When the interactive job starts, you will notice that you are no longer on a login node, but rather one of the compute nodes.

      [shs159@smp-n2 ˜]$
      
      Try crc-interactive -h for more details.
    • Note: The Python 2.7 library will be loaded automatically when you run crc-interactive. This will prevent you from sourcing a python 3.x environment. See this page for an alternative method. 
    • X11 forwarding is known to cause issues with crc-interactive. If you need an interactive session with X11 forwarding enabled, please refer to this documentation.
crc-quota   Show your storage quota on all of our storage systems 
crc-usage  

Show your usage on each cluster

  • For now, this will only show your primary group. Try groups | cut -d' ' -f1 to find your primary group.
crc-job-stats  

This script is meant to be added at the bottom of your Slurm scripts (after srun) to give the statististic of your job.