https://github.com/PySlurm/pyslurm

Python Interface to Slurm
https://github.com/PySlurm/pyslurm

cluster cython hpc python slurm

Last synced: 3 months ago
JSON representation

Python Interface to Slurm

• Host: GitHub
• URL: https://github.com/PySlurm/pyslurm
• Owner: PySlurm
• License: gpl-2.0
• Created: 2011-11-20T13:23:04.000Z (almost 13 years ago)
• Default Branch: main
• Last Pushed: 2024-07-06T21:11:43.000Z (4 months ago)
• Last Synced: 2024-07-07T21:25:31.951Z (4 months ago)
• Topics: cluster, cython, hpc, python, slurm
• Language: Cython
• Homepage: https://pyslurm.github.io
• Size: 5.29 MB
• Stars: 466
• Watchers: 22
• Forks: 116
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: COPYING.txt

Awesome Lists containing this project

• awesome-institutional-hpc - pyslurm - Python library for interfacing with SLURM (SLURM wrappers and libraries)

README

        
# 

pyslurm is the Python client library for the [Slurm Workload Manager](https://slurm.schedmd.com)

## Requirements

* [Slurm](https://slurm.schedmd.com) - Slurm shared library and header files

* [Python](https://www.python.org) - >= 3.6

* [Cython](https://cython.org) - >= 0.29.36

This Version is for Slurm 23.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 `23.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 23.11.X version should work with any Slurm 23.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:

```shell

export SLURM_INCLUDE_DIR=/opt/slurm/23.11/include

export SLURM_LIB_DIR=/opt/slurm/23.11/lib

```

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

```shell

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

scripts/build.sh

# Or simply with pip

pip install .

```

Also see `python setup.py --help`

## Contributors

pyslurm is made by [contributors like

you](https://github.com/PySlurm/pyslurm/graphs/contributors).

## Support

Feel free to ask questions in the [GitHub

Discussions](https://github.com/orgs/PySlurm/discussions)

Found a bug or you are missing a feature? Feel free to [open an Issue!](https://github.com/PySlurm/pyslurm/issues/new)