ghcr.io/autamus/arborx

Versions: 1.0

This module is a singularity container wrapper for ghcr.io/autamus/arborx. ArborX is a performance-portable library for geometric search After installing shpc you will want to install this container module:

$ shpc install ghcr.io/autamus/arborx

Or a specific version:

$ shpc install ghcr.io/autamus/arborx:1.0

And then you can tell lmod about your modules folder:

$ module use ./modules

And load the module, and ask for help, or similar.

$ module load ghcr.io/autamus/arborx/1.0
$ module help ghcr.io/autamus/arborx/1.0

You can use tab for auto-completion of module names or commands that are provided.


Commands

When you install this module, you’ll be able to load it to make the following commands accessible. Examples for both Singularity, Podman, and Docker (container technologies supported) are included.

-run:

$ singularity run <container>
$ podman run --rm  -v ${PWD} -w ${PWD} <container>
$ docker run --rm  -v ${PWD} -w ${PWD} <container>

-shell:

$ singularity shell -s /bin/sh <container>
$ podman run --it --rm --entrypoint /bin/sh  -v ${PWD} -w ${PWD} <container>
$ docker run --it --rm --entrypoint /bin/sh  -v ${PWD} -w ${PWD} <container>

-exec:

$ singularity exec -s /bin/sh <container> "$@"
$ podman run --it --rm --entrypoint ""  -v ${PWD} -w ${PWD} <container> "$@"
$ docker run --it --rm --entrypoint ""  -v ${PWD} -w ${PWD} <container> "$@"

-inspect:

Podman and Docker only have one inspect type.

$ podman inspect <container>
$ docker inspect <container>

-inspect-runscript:

$ singularity inspect -r <container>

-inspect-deffile:

$ singularity inspect -d <container>

####

$ singularity run <container>
$ podman run --rm  -v ${PWD} -w ${PWD} <container>
$ docker run --rm  -v ${PWD} -w ${PWD} <container>

In the above, the <container> directive will reference an actual container provided by the module, for the version you have chosen to load. An environment file in the module folder will also be bound. Note that although a container might provide custom commands, every container exposes unique exec, shell, run, and inspect aliases. For anycommands above, you can export:

  • SINGULARITY_OPTS: to define custom options for singularity (e.g., –debug)
  • SINGULARITY_COMMAND_OPTS: to define custom options for the command (e.g., -b)
  • PODMAN_OPTS: to define custom options for podman or docker
  • PODMAN_COMMAND_OPTS: to define custom options for the command


Install

You can install shpc locally (for yourself or your user base) as follows:

$ git clone https://github.com/singularityhub/singularity-hpc
$ cd singularity-hpc
$ pip install -e .

Have any questions, or want to request a new module or version? ask for help!