settings.yml

# The Singularity HPC settings file holds basic information about the
# module system to use, and where modules are stored. All settings are
# currently specific to singularity, but can be extended to other technologies.

# set a default module system
# Currently lmod and tcl are supported. To request an additional system,
# please open an issue https://github.com/singularityhub/singularity-hpc
module_sys: lmod

# config editor
config_editor: vim

# set a default container technology (singularity or podman)
container_tech: singularity

# Registry Recipes (order of GitHub providers or paths here is honored for search path))
# To reference a path in the $PWD of the shpc install use $root_dir (e.g., $root_dir/registry)
# Please preserve the flat list format for the yaml loader
registry: [https://github.com/singularityhub/shpc-registry]

# Registry to sync from (only to a filesystem registry supported)
sync_registry: https://github.com/singularityhub/shpc-registry

# Lmod or Environment Modules settings
# The install directory for modules. Defaults to the install directory/modules
module_base: $root_dir/modules

# Format string for module commands exec,run,shell (not aliases) (can also include:
# {{parsed_name.registry}} , {{ parsed_name.repository }},
# {{parsed_name.tool}}, {{parsed_name.version}}
# This is where you might add a prefix to your module names, if desired.
module_name: '{{ parsed_name.tool }}'

# When multiple versions are available and none requested, allow module picking one itself
# module_sys: allow the module software to decide
# null: do nothing, versions will be specified manually
# last_installed: use the last installed as the default
# first_installed: use the first installed
default_version: module_sys

# store containers separately from module files
# It's recommended to do this for faster loading
container_base: $root_dir/containers

# When parsing labels, replace newlines with this string
label_separator: ', '

wrapper_base: $root_dir/modules

# Default root directory to create views
views_base: $root_dir/views

# Always install to a default "active" view (null means we don't)
default_view:

# if defined, add to lmod script to load this Singularity module first
singularity_module:
podman_module:

# string with comma separated list of paths to binds. If set, exported to SINGULARITY_BINDPATH
bindpaths:

# for container technologies that can specify a tty input (e.g., -t)
enable_tty: true

# exported to SINGULARITY_SHELL, defaults to /bin/bash.
singularity_shell: /bin/sh
podman_shell: /bin/sh
docker_shell: /bin/sh

# shell for test.sh file
test_shell: /bin/bash

# shell for wrapper shell scripts
wrapper_shell: /bin/bash

# Wrapper scripts to use for aliases (replaces them)
# Put a fullpath here for a custom script, otherwise we look in shpc/main/wrappers
# If you want a custom wrapper script for a one-off container, define it there with the script
# stored alongside the container.yaml.
wrapper_scripts:
  enabled: true

  # use for docker aliases (set to null to disable)
  docker: docker.sh

  # use for podman aliases (set to null to disable)
  podman: docker.sh

  # use for singularity aliases (set to null to disable)
  singularity: singularity.sh

  # Add an extra custom template directory (searched first)
  templates:

# the module namespace you want to install from. E.g., if you have ghcr.io/autamus/clingo
# and you set the namespace to ghcr.io/autamus, you can just do: shpc install clingo.
namespace:

# THe name of the environment file to bind to the container.
# This determines order of load
environment_file: 99-shpc.sh

# container features like gpu will modify generated recipes
container_features:
  gpu:      # one of null, amd, or nvidia
  x11:      # one of null, true, false, or a path
            # defaults to ~/.Xauthority if set to true and the container has x11: true
  home:     # one of null, or a single path or src:dest path.
            # home: true in a container.yaml will use this path, if defines