PySlurm is the Python client library for the Slurm HPC Scheduler.

• Slurm
• Python
• Cython

This PySlurm branch has been tested with:

• Cython (latest stable)
• Python 3.6, 3.7, 3.8, and 3.9
• Slurm 21.08

You will need to instruct the setup.py script where either the Slurm install root directory or where the Slurm libraries and Slurm header files are.

python setup.py build
python setup.py install

python setup.py build --slurm=PATH_TO_SLURM_DIR
python setup.py install

python setup.py build --slurm-lib=PATH_TO_SLURM_LIB --slurm-inc=PATH_TO_SLURM_INC
python setup.py install

python setup.py build --bgq

The build will automatically call a cleanup procedure to remove temporary build files but this can be called directly if needed as well with :

python setup.py clean

The API documentation is hosted at https://pyslurm.github.io.

To build the docs locally, use Sphinx to generate the documentation from the reStructuredText based docstrings found in the pyslurm module once it is built:

cd doc
make clean
make html

PySlurm requires an installation of Slurm.

To run tests locally without an existing Slurm cluster, docker and docker-compose is required.

Clone the project:

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

Start the Slurm container in the background:

docker-compose up -d

The cluster takes a few seconds to start all the required Slurm services. Tail the logs:

docker-compose logs -f

When the cluster is ready, you will see the following log message:

Cluster is now available

Press CTRL C to stop tailing the logs. Slurm is now running in a container in detached mode. docker-compose also bind mounds the git directory inside the container at /pyslurm so that the container has access to the test cases.

Install test dependencies:

pipenv sync --dev

Execute the tests inside the container:

pipenv run pytest -sv scripts/run_tests_in_container.py

When testing is complete, stop the running Slurm container:

docker-compose down

You may also choose to clone the project and run tests on a node where Slurm is already compiled and installed:

git clone https://github.com/PySlurm/pyslurm.git
cd pyslurm
python3.9 setup.py build
python3.9 setup.py install
./scripts/configure.sh
pipenv sync --dev
pipenv run pytest -sv

PySlurm is made by contributors like you.

Ask questions on the PySlurm Google Group