- Singularity: Getting started
-Last updated on 2024-09-02 | - +
Last updated on 2024-09-09 | + Edit this page
- - - + + +Objectives
Work in progress… -
+Work in progress…
This lesson is new material that is under ongoing development. We will introduce Singularity and demonstrate how to work with it. As the @@ -391,10 +439,8 @@
Work in progress…Singularity - Part I
-
-
What is Singularity?
-
+Singularity - Part I
+
What is Singularity?
Singularity is a
container platform that allows software engineers and researchers to
easily share their work with others by packaging and deploying their
@@ -437,8 +483,28 @@
Work in progress…Getting started with Singularity
-
+
What is the relationship between Singularity, SingularityCE and
+Apptainer?
+
Singularity is open source and was initially developed within the
+research community. The company Sylabs
+was founded in 2018 to provide commercial support for Singularity. In May
+2021, Sylabs “forked” the codebase to create a new project called SingularityCE (where CE means
+“Community Edition”). This in effect marks a common point from which two
+projects—SingularityCE and Singularity—developed. Sylabs continue to
+develop both the free, open source SingularityCE and a Pro/Enterprise
+edition of the software. In November 2021, the original open source
+Singularity project renamed
+itself to Apptainer and joined
+the Linux Foundation.
+At the time of writing, in the context of the material covered in
+this lesson, Apptainer and Singularity are effectively interchangeable.
+If you are working on a platform that now has Apptainer installed, you
+might find that the only change you need to make when working through
+this material is to use the the command apptainer instead
+of singularity. This course will continue to refer to
+Singularity until differences between the projects warrant choosing one
+project or the other for the course material.
+Getting started with Singularity
Initially developed within the research community, Singularity is
open source and the repository is currently
available in the “The Next Generation
@@ -454,9 +520,7 @@ Work in progress…
What is Singularity? -
+Singularity - Part I
+What is Singularity?
Singularity is a container platform that allows software engineers and researchers to easily share their work with others by packaging and deploying their @@ -437,8 +483,28 @@
Work in progress…Getting started with Singularity
-
+
What is the relationship between Singularity, SingularityCE and +Apptainer?
+Singularity is open source and was initially developed within the +research community. The company Sylabs +was founded in 2018 to provide commercial support for Singularity. In May +2021, Sylabs “forked” the codebase to create a new project called SingularityCE (where CE means +“Community Edition”). This in effect marks a common point from which two +projects—SingularityCE and Singularity—developed. Sylabs continue to +develop both the free, open source SingularityCE and a Pro/Enterprise +edition of the software. In November 2021, the original open source +Singularity project renamed +itself to Apptainer and joined +the Linux Foundation.
+At the time of writing, in the context of the material covered in
+this lesson, Apptainer and Singularity are effectively interchangeable.
+If you are working on a platform that now has Apptainer installed, you
+might find that the only change you need to make when working through
+this material is to use the the command apptainer instead
+of singularity. This course will continue to refer to
+Singularity until differences between the projects warrant choosing one
+project or the other for the course material.
Getting started with Singularity
Initially developed within the research community, Singularity is
open source and the repository is currently
available in the “The Next Generation
@@ -454,9 +520,7 @@ Work in progress…
Installing Singularity on your own -laptop/desktop -
+Installing Singularity on your own laptop/desktop
If you have a Linux system on which you have administrator access and you would like to install Singularity on this system, some information @@ -473,8 +537,7 @@
Installing Singularity on your own
Loading a module -
+Loading a module
HPC systems often use modules to provide access to software on the system so you may need to use the command:
@@ -501,8 +564,7 @@OUTPUT<
Depending on the version of Singularity installed on your system, you
may see a different version. At the time of writing, v3.5.3
is the latest release of Singularity.
Images and containers -
+Images and containers
We’ll start with a brief note on the terminology used in this section of the course. We refer to both images and containers. What is the distinction between @@ -521,8 +583,7 @@
OUTPUT< container instances from an image. You could, perhaps, consider an image to be a form of template from which running container instances can be started. -
Getting an image and running a Singularity container -
+Getting an image and running a Singularity container
If you recall from learning about Docker, Docker images are formed of a set of layers that make up the complete image. When you pull a Docker image from Docker Hub, you see the different layers being @@ -542,8 +603,7 @@
OUTPUT<
Singularity Hub -
+Singularity Hub
Note that in addition to providing a repository that you can pull images from, Singularity Hub @@ -606,7 +666,7 @@
BASH
OUTPUT
-#!/bin/sh
+#!/bin/sh
exec /bin/bash /rawr.sh
#!/bin/sh
+#!/bin/sh
exec /bin/bash /rawr.sh
OUTPUT<
Key Points -
+Key Points
- Singularity is another container platform and it is often used in cluster/HPC/research environments. @@ -646,7 +705,7 @@
Key Points - Next: The Singularity... + Next: The Singularity...
Key Points
This lesson is subject to the Code of Conduct
-
+
Edit on GitHub
-
+
| Contributing
| Source
-
+
Materials licensed under CC-BY 4.0 by the authors
-
+
Template licensed under CC-BY 4.0 by The Carpentries
- Built with sandpaper (0.16.4), pegboard (0.7.4), and varnish (1.0.1)
+ Built with sandpaper (0.16.7), pegboard (0.7.6), and varnish (1.0.4)
This lesson is subject to the Code of Conduct
- + Edit on GitHub - + | Contributing | Source
Materials licensed under CC-BY 4.0 by the authors
- +Template licensed under CC-BY 4.0 by The Carpentries
-Built with sandpaper (0.16.4), pegboard (0.7.4), and varnish (1.0.1)
+Built with sandpaper (0.16.7), pegboard (0.7.6), and varnish (1.0.4)