Skip to main content
Ctrl+K
idmtools  documentation - Home idmtools  documentation - Home
  • Install
  • Configure
  • Platforms
  • Simulations
  • CLI
  • Singularity
    • Parameter sweeps and model iteration
    • Output data
    • Introduction to analyzers
    • Plot data
    • Architecture and packages reference
    • User recipes
    • Convert scripts from DTK-Tools
    • FAQ
    • Glossary
    • Changelog
  • IDM docs
  • GitHub
  • Install
  • Configure
  • Platforms
  • Simulations
  • CLI
  • Singularity
  • Parameter sweeps and model iteration
  • Output data
  • Introduction to analyzers
  • Plot data
  • Architecture and packages reference
  • User recipes
  • Convert scripts from DTK-Tools
  • FAQ
  • Glossary
  • Changelog
  • IDM docs
  • GitHub

Section Navigation

  • COMPS Platform
    • Configuration and options
    • Add to asset collection
    • Assetize outputs workitem
    • DownloadWorkItem
    • COMPS errors
    • COMPS scheduling
    • Singularity build
  • Slurm Platform
    • Configuration and options
    • Cancel jobs
    • Run script as Slurm job
  • Container Platform
    • ContainerPlatform Docker utilities
    • Container CLI commands
    • Examples for ContainerPlatform attributes
    • ContainerPlatform Docker image
  • Create platform plugin
  • Platforms
  • Slurm Platform
  • Configuration and options

Configuration and options#

idmtools supports the SLURM options for configuring, submitting and running jobs. The following lists some of the sbatch options (https://slurm.schedmd.com/sbatch.html) that are used when making calls to idmtools_platform_slurm.platform_operations.SlurmPlatform:

  • account (https://slurm.schedmd.com/sbatch.html#OPT_account)

  • cpus_per_task (https://slurm.schedmd.com/sbatch.html#OPT_cpus-per-task)

  • exclusive (https://slurm.schedmd.com/sbatch.html#OPT_exclusive)

  • mem_per_cpu (https://slurm.schedmd.com/sbatch.html#OPT_mem-per-cpu)

  • modules (https://slurm.schedmd.com/sbatch.html#OPT_modules)

  • nodes (https://slurm.schedmd.com/sbatch.html#OPT_nodes)

  • ntasks (https://slurm.schedmd.com/sbatch.html#OPT_ntasks)

  • partition (https://slurm.schedmd.com/sbatch.html#OPT_partition)

  • requeue (https://slurm.schedmd.com/sbatch.html#OPT_requeue)

  • time (https://slurm.schedmd.com/sbatch.html#OPT_time)

  • mpi_type: MPI types (‘pmi2’, ‘pmix’ for slurm MPI, ‘mpirun’ for independently MPI)

previous

Slurm Platform

next

Cancel jobs

  • Install
  • Configure
  • Platforms
  • Simulations
  • CLI
  • Singularity
  • Parameter sweeps and model iteration
  • Output data
  • Introduction to analyzers
  • Plot data
  • Architecture and packages reference
  • User recipes
  • Convert scripts from DTK-Tools
  • FAQ
  • Glossary
  • Changelog

© Copyright 1999 - 2025, Gates Foundation. All rights reserved.

idmtools is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.

Send documentation feedback to [email protected].

Built with the PyData Sphinx Theme 0.16.1.

Privacy and Cookies Notice   |    Terms of Use