pyslurmutils 0.0.3a0

SLURM utilities for Python

pyslurmutils

SLURM utilities for Python.

Demo

Get an access token on rnice

export SLURM_TOKEN=$(scontrol token lifespan=3600)
export SLURM_URL=...
export SLURM_USER=...

Run some example jobs

python3 scripts/example.py

Run the tests (CI or locally)

python3 -m pytest .

When SLURM_TOKEN, SLURM_URL or SLURM_USER is missing it will mock the SLURM clients.

Execute a python function on SLURM

High-level API

API mimics python's concurrent.futures API

from pyslurmutils.futures import SlurmExecutor

with SlurmExecutor(
    url,
    user_name,
    token,
    log_directory=log_directory,  # for log files
    data_directory=data_directory,  # TCP when not provided
) as pool:

    future = pool.submit(sum, args=([1, 1],), pre_script="conda activate myenv")
    assert future.result() == 2

Low-level API

from pyslurmutils.client.pyscript import SlurmPythonJobApi

with SlurmPythonJobApi(
        url,
        user_name,
        token,
        log_directory=log_directory,  # for log files
        data_directory=data_directory,  # TCP when not provided
    ) as pyapi:

    future = pyapi.spawn(sum, args=([1, 1],), pre_script="conda activate myenv")
    job_id = future.job_id
    try:
        pyapi.wait_done(job_id)
        pyapi.print_stdout_stderr(job_id)
        assert pyapi.get_future(job_id).result() == 2
    finally:
        pyapi.clean_job_artifacts(job_id)