Skip to content
slurmtools

Slurmtools User Guide

Welcome to the slurmtools User Guide! slurmtools provides scientists with a user-friendly toolkit for seamless Slurm integration, making job submission, monitoring, and management a breeze. With its intuitive interface, you can customize job submissions through flexible template files, perfectly adapting slurmtools to your unique research workflows. As slurmtools is in active, early-stage development, be sure to visit our GitHub page frequently to stay up-to-date with the latest features and releases.

What is slurmtools?

At its core, slurmtools is a lightweight yet powerful package, designed to streamline your interactions with Slurm using simple slurm command wrappers. Here’s a quick overview of what you can do:

  1. submit_slurm_job - Easily submit jobs with this sbatch wrapper
  2. get_slurm_jobs - Get a summary of running jobs with this squeue wrapper
  3. cancel_slurm_job - Cancel a job with this scancel wrapper
  4. get_slurm_partitions - Get a list of available partitions with this sinfo wrapper

and a helper function:

  1. generate_nmm_config - which helps setup nmm - a NONMEM monitor tool

Ready to dive into slurmtools? Head over to the getting started guide to get setup using slurmtools or check out our function-specific guides for detailed insights and advanced tips!