Getting Started

cotainr makes it easy to build Singularity/Apptainer containers for certain use cases. If this is your first time learning about cotainr, we encourage you to read the motivation for using cotainr.

In order to get started, you can install cotainr directly using pip.

$ pip install cotainr

Additionally, you need to have Singularity or Apptainer installed. More details about dependencies may be found in the User Guide.

Alternatively, if you are using an HPC system, you may be in luck that cotainr is already installed on the system. Refer to the instructions below for getting started in that case.

Using cotainr on HPC systems where it is already installed

On some HPC systems, cotainr is already installed. If your HPC system of choice is mentioned in the instructions list below, you may follow those instructions to get started using cotainr on that system.

HPC systems instructions

LUMI

cotainr may be loaded as a module from the CrayEnv software stack. It includes system information.

For instance, building a container for LUMI-G:

$ module load CrayEnv
$ module load cotainr
$ cotainr build my_container.sif --system=lumi-g <...>

More details may be found in the User Guide. For details about LUMI, see the LUMI documentation.