Welcome to slurmer’s documentation!

slurmer is lightweight library for auto-generation of SLURM job script based on jinja template engine. It provides API for managing job script templates, rendering job script and submitting batch job.

Getting Started

• Installation
• Quickstart

User Guide

• Introduction to Template
  • Brief introduction to jinja template
  • Slurm job script template format
  • Explaining the structure of default.sh
• Template Management
  • Show the list of available templates
  • Add directory to look up templates
• Creating and Submitting a Job
  • Creating SlurmJob object
  • Submitting the job

API Documentation

• slurmer

Indices and tables

• Index

• Module Index

• Search Page