HPC/SLURM clusters

MIRACL was built with HPC/SLURM clusters in mind. We recommend Apptainer as it is well suited to run in a cluster environment. We provide an Apptainer container of MIRACL's latest version that can be dowloaded to a node directly from our online repo. Alternatively, you can build an Apptainer off of our MIRACL Docker images hosted on DockerHub.

We provide tutorials on how to use MIRACL on Compute Canada and Sherlock (supercomputer at Stanford university) but the principles explained here will be similar to other SLURM clusters.

Note

If you would like to add a tutorial for a particular cluster that you are working with that is missing here, we invite you to add it to this section by submitting a PR (note that we write Sphinx documentation in .rst format) through our official GitHub.