Helix/Software/Singularity: Difference between revisions
H Winkhardt (talk | contribs) (Created page with "{| width=760px class="wikitable" |- ! Description !! Content |- | module load | --- |- | License | Open-source software, distributed under the 3-clause BSD License. #License...") |
H Winkhardt (talk | contribs) No edit summary |
||
| Line 21: | Line 21: | ||
'''Singularity''' is a container platform. On bwForCluster Helix, Singularity 3.8 is installed on all nodes. |
'''Singularity''' is a container platform. On bwForCluster Helix, Singularity 3.8 is installed on all nodes. |
||
Because not every different software configuration can be provided as [[Environment Modules|Modules]] on the clusters, containers offer a way to use a pre-built scientific software in a closed and reproducible space, independent from the environment. A Singularity container contains its own operating system, the intended software and all required dependencies, except for Kernel components (e.g. drivers). This also means that you can use software that isn't available for RHEL/CentOS, but is offered for other Linux systems. Singularity containers are easily movable between systems and do not require root-rights for execution (different to Docker). |
|||
= License = |
= License = |
||
| Line 43: | Line 45: | ||
For additional information about how to use Singularity, please consult the [https://sylabs.io/docs/ documentation]. |
For additional information about how to use Singularity, please consult the [https://sylabs.io/docs/ documentation]. |
||
== Running containers == |
|||
On the cluster, the easiest way to run one-line commands (including commands to run other files) is passing them to the container through ''exec'': <br> |
|||
<pre> |
|||
singularity exec <containername> script.sh |
|||
</pre> |
|||
<br> |
|||
<syntaxhighlight style="border:0px" inline=1>exec</syntaxhighlight> is generally the easiest way to execute singularity in a script. Without further specification, it runs the container in the current directory. |
|||
An alternative option, <syntaxhighlight style="border:0px" inline=1>run</syntaxhighlight>, allows to execute a '''%runscript''' that was provided in the definition file during the build-process: <br> |
|||
<pre> |
|||
$ singularity run <containername> |
|||
</pre> |
|||
This is for example useful to start an installed program. |
|||
=== Using nvidia-GPUs === |
=== Using nvidia-GPUs === |
||
Singularity can interact with by setting the (experimental) --nv-flag |
Singularity can interact with by setting the (experimental) <syntaxhighlight style="border:0px" inline=1>--nv</syntaxhighlight>-flag |
||
<pre> |
<pre> |
||
Revision as of 10:09, 18 August 2022
| Description | Content |
|---|---|
| module load | --- |
| License | Open-source software, distributed under the 3-clause BSD License. More... |
| Citing | --- |
| Links | Homepage | Documentation |
| Graphical Interface | No |
Description
Singularity is a container platform. On bwForCluster Helix, Singularity 3.8 is installed on all nodes.
Because not every different software configuration can be provided as Modules on the clusters, containers offer a way to use a pre-built scientific software in a closed and reproducible space, independent from the environment. A Singularity container contains its own operating system, the intended software and all required dependencies, except for Kernel components (e.g. drivers). This also means that you can use software that isn't available for RHEL/CentOS, but is offered for other Linux systems. Singularity containers are easily movable between systems and do not require root-rights for execution (different to Docker).
License
Singularity is free, open-source software released under the 3-clause BSD license. Please read the license for additional information about Singularity.
Usage
Program Binaries
The binary singularity is main program of the container platform.
To get help using Singularity execute the following command:
$ singularity --help
Furthermore, a man page is available and can be accessed by typing:
$ man singularity
For additional information about how to use Singularity, please consult the documentation.
Running containers
On the cluster, the easiest way to run one-line commands (including commands to run other files) is passing them to the container through exec:
singularity exec <containername> script.sh
exec is generally the easiest way to execute singularity in a script. Without further specification, it runs the container in the current directory.
An alternative option, run, allows to execute a %runscript that was provided in the definition file during the build-process:
$ singularity run <containername>
This is for example useful to start an installed program.
Using nvidia-GPUs
Singularity can interact with by setting the (experimental) --nv-flag
# Run container (two options to start a container) singularity run --nv [options] <container> singularity exec --nv [options] <container> <command>
Using the flag is advisable, but may be omitted if the correct GPU- and driver-APIs are available on the container.
Examples
TBD