This module is a singularity container wrapper for ghcr.io/autamus/meme. The MEME suite provides online tools for discovering and using protein and DNA sequence motifs. After installing shpc you will want to install this container module:
$ shpc install ghcr.io/autamus/meme
Or a specific version:
$ shpc install ghcr.io/autamus/meme:5.3.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/meme/5.3.0
$ module help ghcr.io/autamus/meme/5.3.0
You can use tab for auto-completion of module names or commands that are provided.
Commands
When you install this module, you will be able to load it to make the following commands accessible. Examples for both Singularity, Podman, and Docker (container technologies supported) are included.
meme-run:
$ singularity run <container>
$ podman run --rm -v ${PWD} -w ${PWD} <container>
$ docker run --rm -v ${PWD} -w ${PWD} <container>
meme-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>
meme-exec:
$ singularity exec <container> "$@"
$ podman run --it --rm --entrypoint "" -v ${PWD} -w ${PWD} <container> "$@"
$ docker run --it --rm --entrypoint "" -v ${PWD} -w ${PWD} <container> "$@"
meme-inspect:
Podman and Docker only have one inspect type.
$ podman inspect <container>
$ docker inspect <container>
meme-inspect-runscript:
$ singularity inspect -r <container>
meme-inspect-deffile:
$ singularity inspect -d <container>
meme
$ singularity exec <container> /opt/view/bin/meme
$ podman run --it --rm --entrypoint /opt/view/bin/meme -v ${PWD} -w ${PWD} <container> -c " $@"
$ docker run --it --rm --entrypoint /opt/view/bin/meme -v ${PWD} -w ${PWD} <container> -c " $@"
meme-chip
$ singularity exec <container> /opt/view/bin/meme-chip
$ podman run --it --rm --entrypoint /opt/view/bin/meme-chip -v ${PWD} -w ${PWD} <container> -c " $@"
$ docker run --it --rm --entrypoint /opt/view/bin/meme-chip -v ${PWD} -w ${PWD} <container> -c " $@"
memhog
$ singularity exec <container> /opt/view/bin/memhog
$ podman run --it --rm --entrypoint /opt/view/bin/memhog -v ${PWD} -w ${PWD} <container> -c " $@"
$ docker run --it --rm --entrypoint /opt/view/bin/memhog -v ${PWD} -w ${PWD} <container> -c " $@"
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!