README.md

# Lundgren examples
This repository contains a set of examples on how to queuing jobs on Lundgren with Slurm.

Each example is located in a separate folder with different topics and detailed description of relevant parts.


## Getting started

The best way to use the examples is to try them. Download the repository by cloning it to your harddrive. If you are on Lundgren you can clone it to a suitable folder under your home folder. If you are on your personal computer you can clone it into a suitable folder under the personal LiU-clound folder, _P:_ (_\\ad.liu.se\home\<LiU-ID>_)

All the examples will use the method of creating a job and submit it to the Slurm scheduler as a background process. Each example will use a bash file, _.sh_ as a base for instructing Slurm on the job steps to perform. Each job step uses the command ___srun___ or ___sbatch___ to perform one or several tasks.

## Examples
This section describes the different examples briefly so you can find an example that fits your needs.

__Note:__ _Since our Slurm cluster only has one node there can be a queue for running the examples depending on the workload of Lundgren._

#### Example 1  - Single core job
A single core job is a job with only a single thread. This type of job is used when it is hard or impossible to make use of multiple cores/threads.

A simple example could be a data parser that reads a file and transforms it into a more suitable format.

Learn more about the [example](https://gitlab.liu.se/rasri17/lundgren-examples/-/tree/main/1_single_core_job).

#### Example 2 - Mutli core job
A multi core job is a job that splits the computation to multiple cores. This type of job is the most suitable and most common ones to run on Lundgren. This includes optimization problems and heavy computations.

Learn more about the [example](https://gitlab.liu.se/rasri17/lundgren-examples/-/tree/main/2_multi_core_job).