diff --git a/README.md b/README.md index eabf24f..e6614ba 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,29 @@ If you have any problems running the scripts, you might have to run this instead python3 scripts/ ``` +### Batch system + +For the **frequency_narrow_sweeps_long** program, the is a script called +**job.script** that comes along with it. This is to be able to run it on a +batch system using Slurm if you have access to one. +This is the recommended way to use this program as it takes approximately 90 +minutes to complete when using 16 cores. + +If you happen to have such a system available to you, then you should clone +this repo on that system, then compile it by running: + +```shell + make frequency_narrow_sweeps_long +``` + +You might have to load the Armadillo library before compiling. + +After compiling, you can schedule it by running: + +```shell + sbatch job.script +``` + ## Performance This section aims to give an idea to the time it takes for the program to