pyslurm is the Python client library for the Slurm Workload Manager

Requirements

• Slurm - Slurm shared library and header files
• Python - >= 3.6
• Cython - >= 0.29.37

This Version is for Slurm 24.11.x

Versioning

In pyslurm, the versioning scheme follows the official Slurm versioning. The first two numbers (MAJOR.MINOR) always correspond to Slurms Major-Release, for example 24.11. The last number (MICRO) is however not tied in any way to Slurms MICRO version, but is instead PySlurm's internal Patch-Level. For example, any pyslurm 24.11.X version should work with any Slurm 24.11.X release.

Installation

By default, it is searched inside /usr/include for the Header files and in /usr/lib64 for Slurms shared-library (libslurm.so) during Installation. For Slurm installations in different locations, you will need to provide the corresponding paths to the necessary files.

You can specify those with environment variables (recommended), for example:

export SLURM_INCLUDE_DIR=/opt/slurm/24.11/include
export SLURM_LIB_DIR=/opt/slurm/24.11/lib

Then you can proceed to install pyslurm, for example by cloning the Repository:

git clone https://github.com/PySlurm/pyslurm.git && cd pyslurm
scripts/build.sh

Also see scripts/build.sh -h. You can specify multiple cores for building with the -j option (also possible to set via environment variable PYSLURM_BUILD_JOBS):

scripts/build.sh -j4

Or simply with pip directly:

pip install .

Contributors

pyslurm is made by contributors like you.

Support

Feel free to ask questions in the GitHub Discussions

Found a bug or you are missing a feature? Feel free to open an Issue!