Welcome to plus_slurm’s documentation!

Migrating from obob_condor or hnc_condor?

If you work at the University of Salzburg and have previously used the HTCondor cluster via obob_condor on python or the hnc_condor package of obob_ownft, take a look at how to migrate to the new system here.

What is this?

plus_slurm is a package that makes it easy to submit python jobs to a cluster running Slurm. In contrast to other available packages like Submit it!, simple-slurm or easy-slurm, it is optimized for the Slurm based clusters at the University of Salzburg, including the most commonly encountered use-cases.

As a consequence, the choices made during the development of this package are highly opinionated. Simplicity always trumps flexibility. The focus is on providing a good user experience, not providing all choices offered by Slurm.

Should I use this?

If you work at the University of Salzburg, this package is most probably a good way to start using the cluster.

If you have previously worked with obob_condor you will see that you can use all your old code as the interface is the same.

If you work at some other institution with a Slurm cluster, you can use this package as well. Everything should work as expected.

May just take a look at the tutorial so you can see what this package has to offer.

If you work at the University of Salzburg

This documentation also provides some insights about the cluster, the software you can use etc. So, even if you want to use a different package or no package at all, you are still adviced to read through the general cluster introduction.

If you are already familiar with our cluster infrastructure (because you are migrating from Matlab), you can skip the first section and go directly to How to use plus_slurm. Otherwise, get An introduction to Cluster Computing.

Contents

• An introduction to Cluster Computing
  • Introduction
  • What is a cluster?
  • How do I use the Cluster?
• Migrating from obob_condor or hnc_condor
  • General
  • If you use python
  • If you use Matlab
• How to use plus_slurm
  • Make sure you are on a Login Node
  • Define a simple job
  • Define a job that takes arguments
  • Getting and configuring the JobCluster
  • Adding jobs to the JobCluster
  • Adding multiple jobs with just one call
  • Submitting the Job
• Automatically generating filenames for your jobs
  • Introduction
  • Say hello to plus_slurm.AutomaticFilenameJob
  • Derive a Job class for the project
  • Write your Job classes for the individual jobs
  • Things to keep in mind
• Reference
  • JobCluster
  • ApptainerJobCluster
  • Job
  • AutomaticFilenameJob
  • PermuteArgument

Indices and tables

• Index

• Module Index

• Search Page