slurmformspawner

JupyterHub SlurmSpawner with a dynamic spawn form

Requirements

Python >= 3.7
JupyterHub >= 4.0.0
batchspawner>= 1.3.0
cachetools
traitlets

Configuration

SlurmFormSpawner

Variable	Type	Description	Default
`c.SlurmFormSpawner.disable_form`	`CBool`	Disable the spawner input form, use only default values instead	`False`
`c.SlurmFormSpawner.error_template_path`	`Unicode`	Path to the Jinja2 template of the error page	`os.path.join(sys.prefix, 'share', 'slurmformspawner', 'templates', 'error.html')`
`c.SlurmFormSpawner.submit_template_path`	`Unicode`	Path to the Jinja2 template of the submit file	`os.path.join(sys.prefix, 'share', 'slurmformspawner', 'templates', 'submit.sh')`
`c.SlurmFormSpawner.ui_args`	`Dict`	Dictionary of dictionaries describing the UI options	refer to `ui_args` section
`c.SlurmFormSpawner.profile_args`	`Dict`	Dictionary of dictionaries describing profiles	refer to `profile_args` section

`ui_args`

ui_args is a dictionary where the keys are labels that will be re-used in SbatchForm.ui and the values are dictionnaries describing how to launch the user interface. Each option dictionary can have the following keys:

name (required): string that will appear in the Spawner form
url (optional): url user is being redirected to after spawning the single-user server (refer to JUPYTERHUB_DEFAULT_URL documentation)
args (optional): list of flags and options that will be appended to jupyter single-user command that should redirect to the UI.
modules (optional): list of module names that needs to be loaded to make the user interface work

Here is an example of a dictionary that would configure Jupyter Notebook, a terminal and RStudio.

c.SlurmFormSpawner.ui_args = {
    'notebook' : {
        'name': 'Jupyter Notebook'
    },
    'terminal' : {
        'name': 'Terminal',
        'url': '/terminal/1'
    },
    'rstudio' : {
        'name': 'RStudio',
        'url': '/rstudio',
        'modules': ['rstudio-server']
    }
}

`profile_args`

profile_args is a dictionary where the keys are labels that are used in a JavaScript function to set values of the form according values specified in the params sub dictionary.

Each dictionary has the following keys:

name (required): string that will appear in the Spawner form
params (required): dictionary that can specify the value of each of the parameters in SbatchForm (see SbatchForm section).

Here is an example of how you could define profiles

c.SlurmFormSpawner.profile_args = {
    'shell' : {
        'name': 'Shell session',
        'params': {
            'nprocs': 1,
            'oversubscribe': True,
            'ui': 'terminal'
        }
    },
    'parallel_testing' : {
        'name': 'Parallel Testing',
        'params': {
            'nprocs': 8,
            'oversubscribe': False,
            'ui': 'lab',
            'runtime': 1,
        }
    }
}

SbatchForm

Variable	Type	Description	Default
`c.SbatchForm.runtime`	`Dict({'max', 'min', 'step', 'lock', 'def'})`	Runtime widget parameters	refer to `form.py`
`c.SbatchForm.nprocs`	`Dict({'max', 'min', 'step', 'lock', 'def'})`	Number of cores widget parameters	refer to `form.py`
`c.SbatchForm.memory`	`Dict({'max', 'min', 'step', 'lock', 'def'})`	Memory (MB) widget parameters	refer to `form.py`
`c.SbatchForm.oversubscribe`	`Dict({'def', 'lock'})`	Oversubscribe widget parameters	refer to `form.py`
`c.SbatchForm.gpus`	`Dict({'def', 'choices', 'lock'})`	GPUs widget parameters	refer to `form.py`
`c.SbatchForm.ui`	`Dict({'def', 'choices', 'lock'})`	User interface widget parameters	refer to `form.py`
`c.SbatchForm.profile`	`Dict({'def', 'choices', 'lock'})`	User interface widget parameters	refer to `form.py`
`c.SbatchForm.reservation`	`Dict({'def', 'choices', 'lock'})`	Reservation widget parameters	refer to `form.py`
`c.SbatchForm.account`	`Dict({'def', 'choices', 'lock'})`	Account widget parameters	refer to `form.py`
`c.SbatchForm.partition`	`Dict({'def', 'choices', 'lock'})`	Slurm partition parameters	refer to `form.py`
`c.SbatchForm.feature`	`Dict({'def', 'choices', 'lock'})`	Slurm feature (constraint) parameters	refer to `form.py`
`c.SbatchForm.form_template_path`	`Unicode`	Path to the Jinja2 template of the form	`os.path.join(sys.prefix, 'share', 'slurmformspawner', 'templates', 'form.html')`

SlurmAPI

Variable	Type	Description	Default
`c.SlurmAPI.info_cache_ttl`	`Integer`	Slurm sinfo output cache time-to-live (seconds)	300
`c.SlurmAPI.acct_cache_ttl`	`Integer`	Slurm sacct output cache time-to-live (seconds)	300
`c.SlurmAPI.acct_cache_size`	`Integer`	Slurm sacct output cache size (number of users)	100
`c.SlurmAPI.res_cache_ttl`	`Integer`	Slurm scontrol (reservations) output cache time-to-live (seconds)	300

screenshot

form_screenshot

Metadata

Release files for slurmformspawner 2.11.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for slurmformspawner 2.11.2
File	Size	Uploaded
slurmformspawner-2.11.2.tar.gz	23.1 kB	Apr 15, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for slurmformspawner 2.11.2
File	Interpreter	ABI	Platform	Reset
slurmformspawner-2.11.2-py3-none-any.whl 22.7 kB Apr 15, 2026	Python 3	none	any	Details

Total release size: 45.8 kB

Release files / slurmformspawner-2.11.2.tar.gz

Download URL	slurmformspawner-2.11.2.tar.gz
Size	23.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`5546f26003dac1ad47c029575f19fc9172de19f2a900751f03d196a12dceb2b6`
BLAKE2b-256 checksum How to use checksums	`88e8f8d3cc3bfdcfe2b3dc4aeda5339b57a1a56ce84a4b7f0703e96d451be9b7`
Upload date	Apr 15, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.12`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/cmd-ntrf/slurmformspawner
Publishing commit: github.com/cmd-ntrf/slurmformspawner/tree/8d04bb55011bb2b76e4b7f2e55265abd8208c7ab

Workflow

Publishing configuration: github.com/cmd-ntrf/slurmformspawner/blob/8d04bb55011bb2b76e4b7f2e55265abd8208c7ab/.github/workflows/main.yml
Publishing logs: github.com/cmd-ntrf/slurmformspawner/actions/runs/24459980786/attempts/1

Artifact

Subject: slurmformspawner-2.11.2.tar.gz
SHA-256 checksum: 5546f26003dac1ad47c029575f19fc9172de19f2a900751f03d196a12dceb2b6 Verifying attestations

Release files / slurmformspawner-2.11.2-py3-none-any.whl

Download URL	slurmformspawner-2.11.2-py3-none-any.whl
Size	22.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`ece77394bcae0c3004cc93030bbe075d100957c5a1a682da62688f63658f2b67`
BLAKE2b-256 checksum How to use checksums	`79d8e9ffd3306170acc2cbd1ff05a07efe7b4e2e71a7d39ab92c567469424b95`
Upload date	Apr 15, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.12`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/cmd-ntrf/slurmformspawner
Publishing commit: github.com/cmd-ntrf/slurmformspawner/tree/8d04bb55011bb2b76e4b7f2e55265abd8208c7ab

Workflow

Publishing configuration: github.com/cmd-ntrf/slurmformspawner/blob/8d04bb55011bb2b76e4b7f2e55265abd8208c7ab/.github/workflows/main.yml
Publishing logs: github.com/cmd-ntrf/slurmformspawner/actions/runs/24459980786/attempts/1

Artifact

Subject: slurmformspawner-2.11.2-py3-none-any.whl
SHA-256 checksum: ece77394bcae0c3004cc93030bbe075d100957c5a1a682da62688f63658f2b67 Verifying attestations