Skip to content

Commit 11a27de

Browse files
authored
Update singularity.rst
1 parent 6da8715 commit 11a27de

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/singularity.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ Singularity architecture
2424
===================================================== =====================================================
2525
Strengths Weaknesses
2626
===================================================== =====================================================
27-
No dependency of a daemon At the time of writing only good support in Linux
28-
Can be run as a simple user Mac experimental. Desktop edition. Only running
29-
Avoids permission headaches and hacks For some features you need root account (or sudo)
27+
No dependency on a daemon At the time of writing, only good support in Linux
28+
It can be run as a simple user Mac experimental. Desktop edition. Only running
29+
It avoids permission headaches and hacks For some features, you need a root account (or sudo)
3030
Image/container is a file (or directory)
3131
More easily portable
3232

@@ -42,21 +42,21 @@ Nowadays, there may be some confusion since there are two projects:
4242
* `Apptainer Singularity <https://github.com/apptainer/singularity>`__
4343
* `Sylabs Singularity <https://sylabs.io/singularity/>`__
4444

45-
They "forked" in 2021. So far they share most of the codebase, but eventually this could be different, and software might have different functionality.
45+
They "forked" in 2021. So far, they share most of the codebase, but eventually, this could be different, and the software might have different functionality.
4646

47-
The former is already "End Of Life" and its development continues named as `Apptainer <http://apptainer.org/>`_, under the support of the Linux Foundation.
47+
The former is already "End Of Life," but its development continues under the name `Apptainer` http://apptainer.org/>`_, with the support of the Linux Foundation.
4848

4949
Container registries
5050
====================
5151

52-
Container images, normally different versions of them, are stored in container repositories.
52+
Container images, typically different versions, are stored in container repositories.
5353

54-
These repositories can be browser or discovered within, normally public, container registries.
54+
These repositories can be browsed or discovered within normally public container registries.
5555

5656
Docker Hub
5757
----------
5858

59-
It is the first and most popular public container registry (which provides also private repositories).
59+
It is the first and most popular public container registry (which also provides private repositories).
6060

6161
* `Docker Hub <https://hub.docker.com>`__
6262

@@ -74,9 +74,9 @@ Biocontainers
7474

7575
* `Biocontainers <https://biocontainers.pro>`__
7676

77-
Website gathering Bioinformatics focused container images from different registries.
77+
Website gathering bioinformatics-focused container images from different registries.
7878

79-
Originally Docker Hub was used, but now other registries are preferred.
79+
Originally, Docker Hub was used, but now other registries are preferred.
8080

8181
Example: `https://biocontainers.pro/tools/fastqc <https://biocontainers.pro/tools/fastqc>`__
8282

@@ -98,31 +98,31 @@ Via Galaxy project prebuilt images
9898
singularity pull --name fastqc-0.11.9.sif https://depot.galaxyproject.org/singularity/fastqc:0.11.9--0
9999
100100
101-
Galaxy project provides all Bioinformatics software from the BioContainers initiative as Singularity prebuilt images. If download and conversion time of images is an issue, this might be the best option for those working in the biomedical field.
101+
The Galaxy project provides all Bioinformatics software from the BioContainers initiative as Singularity prebuilt images. If image download and conversion time is an issue, this might be the best option for those working in the biomedical field.
102102

103103
Link: https://depot.galaxyproject.org/singularity/
104104

105105
Running and executing containers
106106
--------------------------------
107107

108-
Once we have some image files (or directories) ready, we can run processes.
108+
We can run processes once we have some image files (or directories) ready.
109109

110110
Singularity shell
111111
*****************
112112

113-
The straight-forward exploratory approach is equivalent to ``docker run -ti biocontainers/fastqc:v0.11.9_cv7 /bin/shell`` but with a more handy syntax.
113+
The straightforward exploratory approach is equivalent to ``docker run -ti biocontainers/fastqc:v0.11.9_cv7 /bin/shell`` but with a more handy syntax.
114114

115115
.. code-block:: console
116116
117117
singularity shell fastqc-0.11.9.sif
118118
119119
120-
Move around the directories and notice how the isolation approach is different in comparison to Docker. You can access most of the host filesystem.
120+
Move around the directories and notice how the isolation approach differs from Docker. You can access most of the host filesystem.
121121

122122
Singularity exec
123123
****************
124124

125-
That is the most common way to execute Singularity (equivalent to ``docker exec``). That would be the normal approach in a HPC environment.
125+
This is the most common way to execute Singularity (equivalent to ``docker exec``), and it would be the normal approach in an HPC environment.
126126

127127
.. code-block:: console
128128
@@ -139,7 +139,7 @@ Test a processing of a file from Git *data* directory:
139139
Environment control
140140
*******************
141141

142-
By default Singularity inherits a profile environment (e.g., PATH environment variable). This may be convenient in some circumstances, but it can also lead to unexpected problems when your own environment clashes with the default one from the image.
142+
By default, Singularity inherits a profile environment (e.g., PATH environment variable). This may be convenient in some circumstances, but it can also lead to unexpected problems when your environment clashes with the default one from the image.
143143

144144
.. code-block:: console
145145
@@ -162,7 +162,7 @@ Singularity advanced aspects
162162
Bind paths (aka volumes)
163163
------------------------
164164

165-
Paths of host system mounted in the container
165+
Paths of the host system mounted in the container.
166166

167167
* Default ones, no need to mount them explicitly (for 3.6.x): ```$HOME``` , ```/sys:/sys``` , ```/proc:/proc```, ```/tmp:/tmp```, ```/var/tmp:/var/tmp```, ```/etc/resolv.conf:/etc/resolv.conf```, ```/etc/passwd:/etc/passwd```, and ```$PWD``` `Ref <https://apptainer.org/docs/user/main/bind_paths_and_mounts.html>`__
168168

@@ -194,7 +194,7 @@ Using the 2 fastq available files, process them outside and inside a mounted dir
194194
# Let's create a dummy directory
195195
mkdir test
196196
197-
# Let's copy contents of data directory in that directory
197+
# Let's copy the contents of the data directory in that directory
198198
199199
singularity exec fastqc.sif fastqc test/*fastq.gz
200200

0 commit comments

Comments
 (0)