Skip to content

Installation

Requirements

  • Python 3.12 or higher
  • uv (recommended) or pip
  • Access to a SLURM cluster (local or via SSH)
uv add srunx

The Web UI is included in the base install — no extras required.

Installing with pip

pip install srunx

Installing from Source

git clone https://github.com/ksterx/srunx.git
cd srunx
uv sync

Development Installation

For development, install with the dev dependency group:

git clone https://github.com/ksterx/srunx.git
cd srunx
uv sync --group dev --all-extras

Verification

To verify the installation:

srunx --help

This should display the help message for the srunx command-line interface.