singularity

Version:

3.63

Category:

tools

Cluster:

Loki

Author / Distributor

https://sylabs.io/

Description

Singularity is a container platform designed specifically for high-performance computing (HPC) environments. It allows users to run containers securely without requiring root privileges and ensures reproducibility of scientific software stacks across systems.

Version 3.6.3 supports:

  • Pulling from Docker/Singularity/OCI registries

  • Image creation from definitions (.def)

  • GPU passthrough (–nv), MPI support, and overlay file systems

  • Compatibility with SIF (Singularity Image Format) containers

  • Execution of user-defined environments in batch schedulers (e.g., Slurm)

Documentation

Usage:
 singularity [global options...]

Description:
 Singularity containers provide an application virtualization layer enabling
 mobility of compute via both application and environment portability. With
 Singularity one is capable of building a root file system that runs on any
 other Linux system where Singularity is installed.

Options:
 -c, --config string   specify a configuration file (for root or
                       unprivileged installation only) (default
                       "/cm/local/apps/singularity/3.6.3/etc/singularity/singularity.conf")
 -d, --debug           print debugging information (highest verbosity)
 -h, --help            help for singularity
     --nocolor         print without color output (default False)
 -q, --quiet           suppress normal output
 -s, --silent          only print errors
 -v, --verbose         print additional information
     --version         version for singularity

Available Commands:
 build       Build a Singularity image
 cache       Manage the local cache
 capability  Manage Linux capabilities for users and groups
 config      Manage various singularity configuration (root user only)
 delete      Deletes requested image from the library
 exec        Run a command within a container
 help        Help about any command
 inspect     Show metadata for an image
 instance    Manage containers running as services
 key         Manage OpenPGP keys
 oci         Manage OCI containers
 plugin      Manage Singularity plugins
 pull        Pull an image from a URI
 push        Upload image to the provided URI
 remote      Manage singularity remote endpoints
 run         Run the user-defined default command within a container
 run-help    Show the user-defined help for an image
 search      Search a Container Library for images
 shell       Run a shell within a container
 sif         siftool is a program for Singularity Image Format (SIF) file manipulation
 sign        Attach digital signature(s) to an image
 test        Run the user-defined tests within a container
 verify      Verify cryptographic signatures attached to an image
 version     Show the version for Singularity

Examples/Usage

  • List available modules:

    $ module avail singularity

  • Load the singularity module:

    $ module load singularity/3.6.3

  • Check the loaded modules:

    $ module list

  • Unload the singularity module:

    $ module unload singularity/3.6.3

  • Build a Singularity image:

    $ singularity build

  • Manage containers running as services:

    $ singularity instance

Installation

Source code is obtained from Singularity