Data

Tools

Indexes

Applications

Experiments

Open Source Science

slurmfun

MATLAB tools to submit jobs into SLURM

https://github.com/esi-neuroscience/slurmfun

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (11.5%) to scientific vocabulary

Keywords

cluster-computing hpc matlab slurm
Last synced: 6 months ago · JSON representation ·

Repository

MATLAB tools to submit jobs into SLURM

Basic Info
  • Host: GitHub
  • Owner: esi-neuroscience
  • License: bsd-3-clause
  • Language: MATLAB
  • Default Branch: master
  • Size: 125 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 2
  • Open Issues: 1
  • Releases: 5
Topics
cluster-computing hpc matlab slurm
Created almost 6 years ago · Last pushed 9 months ago
Metadata Files
Readme Changelog License Citation

README.md

slurmfun

REUSE status

MATLAB tools for submitting jobs to the SLURM workload manager.

Summary

This repository provides tools for submitting MATLAB jobs to the SLURM scheduling system. The MATLAB function slurmfun can be used similar to the MATLAB function cellfun, i.e. it will apply a user-defined function to all elements of a cell array and return a cell array of output arguments. Each function call will be submitted as a separate job to the scheduler. See also help slurmfun for details.

Cluster Environment

Up to now slurmfun has been used and tested in the cluster environments of the Ernst Strüngmann Institute (ESI) gGmbH for Neuroscience in Cooperation with Max Planck Society and the Cooperative Brain Imaging Center comprising

  • SLURM 17, 20.02, 20.11.9
  • MATLAB 2014a up to 2023b
  • Debian 8, RHEL 8.1-8.6

The default paths for log files and the SLURM working directory ('slurmWorkingDirectory', availableToolboxes in slurmfun.m), need to be adjusted for the specific cluster environment slurmfun is used in.

Installation

Clone this repository

shell git clone https://github.com/esi-neuroscience/slurmfun.git

and add it to your MATLAB path

matlab addpath /path/to/slurmfun

Usage

Consider the function myfunction that generates a in1-by-in2 matrix of uniformly distributed random numbers in the interval (0,1):

matlab function out = myfunction(in1, in2) out = rand(in1,in2);

To generate 5 matrices in parallel with slurmfun use, e.g.,

matlab nJobs = 5; inc1 = num2cell(randi(20, nJobs, 1) + 60); inc2 = num2cell(randi(20, nJobs, 1) + 60); [out, jobs] = slurmfun(@myfunction, inc1, inc2, 'partition', 'partitionName', 'mem', '7500M', 'cpu', 1);

A more elaborate example can be found in Examples, for a full list of options, use help slurmfun.

Contact and Support

To report bugs or ask questions please use our GitHub issue tracker.

Project Status

This project is actively maintained and (sometimes) updated.

Owner

  • Name: Ernst Strüngmann Institute (ESI) for Neuroscience in Cooperation with Max Planck Society
  • Login: esi-neuroscience
  • Kind: organization
  • Location: Frankfurt, Germany

Citation (CITATION.cff) 

authors:
- affiliation: "Ernst Strüngmann Institute for Neuroscience in Cooperation with Max Planck Society"
  family-names: Schmiedt
  given-names: Joscha Tapani
  orcid: https://orcid.org/0000-0001-6233-1866
- affiliation: "Ernst Strüngmann Institute for Neuroscience in Cooperation with Max Planck Society"
  family-names: Stephan
  given-names: Michael
- affiliation: "Ernst Strüngmann Institute for Neuroscience in Cooperation with Max Planck Society"
  family-names: Fuertinger
  given-names: Stefan
  orcid: https://orcid.org/0000-0002-8118-036X
cff-version: 1.1.0
date-released: '2025-03-31'
keywords:
- high-performance computing
- parallel computing
- matlab
- slurm
license: BSD-3-Clause
message: If you use this software, please cite it based on metadata found in this
  file. slurmfun is a set of MATLAB tools for submitting jobs to the SLURM workload manager.
repository-code: https://github.com/esi-neuroscience/slurmfun
title: 'slurmfun'
version: '2025.6'

GitHub Events

Total
  • Create event: 2
  • Issues event: 1
  • Release event: 1
  • Push event: 21
  • Pull request event: 2
  • Fork event: 1
Last Year
  • Create event: 2
  • Issues event: 1
  • Release event: 1
  • Push event: 21
  • Pull request event: 2
  • Fork event: 1