Skip to content

Commit bc934e7

Browse files
committed
finalizing and approving PR to close #100!
1 parent c2ef3be commit bc934e7

File tree

9 files changed

+38
-13
lines changed

9 files changed

+38
-13
lines changed

_posts/recipes/2017-05-09-hostlibs-gpus-and-mpi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ permalink: tutorial-gpu-drivers-open-mpi-mtls
66

77
**Note: _Much of the GPU portion of this tutorial is deprecated by the `--nv`
88
option that automatically binds host system driver libraries into your
9-
container at runtime. See [the `exec` command](/docs-exec#a-gpu-example) for
9+
container at runtime. See the [`exec`](/docs-exec#a-gpu-example) command for
1010
an example_**
1111

1212
Singularity does a fantastic job of isolating you from the host so you don't

pages/docs/contributing/contributing-docs.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,15 @@ asciinema rec -w 1 demo-asciicast.js
116116
asciinema play demo-asciicast.js
117117
```
118118
Make sure to resize your terminal to 25 rows x 115 columns or less before you
119-
begin your recording. Otherwise it will not display properly on the webpage.
119+
begin your recording. Otherwise it will not display properly on the webpage. To get the size of your current terminal (in lines and columns) you can use `tput`:
120120

121-
Once you've generated an asciicast, you should drop the file (e.g., `demo-asciicast.js`) into the `assets/asciicast` folder, and then include the following in the page or post:
121+
```
122+
echo -e "lines\ncols"|tput -S
123+
34
124+
80
125+
```
126+
127+
Once you've generated an asciicast, you should drop the file (e.g., `demo-asciicast.js`) into the `assets/asciicast` folder. Since we will have many asciicasts here, please name it meaningfully. Then include the following in the page or post:
122128

123129
```bash
124130
{{ "{% include asciicast.html source='demo-asciicast.js' title='How to make demos' author='[email protected]'" }}%}

pages/docs/overview/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ See the Singularity on HPC page for more details.
215215

216216
Yes. Many users run GPU dependant code within Singularity containers. The
217217
experimental `--nv` option allows you to leverage host GPUs without installing
218-
system level drivers into your container. See [the `exec` command](/docs-exec#a-gpu-example) for
218+
system level drivers into your container. See the [`exec`](/docs-exec#a-gpu-example) command for
219219
an example.
220220

221221
## Container portability

pages/docs/user-docs/docs-bootstrap-image.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,9 +146,10 @@ You can add environment variables to be sourced when the container is used in th
146146

147147
```
148148
%environment
149-
export VADER=badguy
150-
export LUKE=goodguy
151-
export SOLO=someguy
149+
VADER=badguy
150+
LUKE=goodguy
151+
SOLO=someguy
152+
export VADER LUKE SOLO
152153
```
153154

154155
See <a href="/docs-environment-metadata">Environment and Metadata</a> for more information about the `%labels` and `%environment` sections.

pages/docs/user-docs/docs-exec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Hello World: The Python version is 3.5.2
9393
```
9494

9595
### A GPU example
96-
If you're host system has an NVIDIA GPU card and a driver installed you can
96+
If your host system has an NVIDIA GPU card and a driver installed you can
9797
leverage the card with the `--nv` option. (This example requires a fairly
9898
recent version of the NVIDIA driver on the host system to run the latest
9999
version of TensorFlow.

pages/docs/user-docs/docs-export.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,16 @@ toc: false
66
folder: docs
77
---
88

9-
Export is a way to dump the contents of your container into a .tar.gz, or a stream to put into some other place. For example, you could stream this into an in memory tar in python.
9+
Export is a way to dump the contents of your container into a .tar.gz, or a stream to put into some other place. For example, you could stream this into an in memory tar in python.
10+
11+
Here we export an image into a `.tar` file:
12+
13+
```
14+
singularity export container.img > container.tar
15+
```
16+
17+
And here is the recommended way to compress your image:
18+
19+
```
20+
singularity export container.img | gzip -9 > container.img.gz
21+
```

pages/docs/user-docs/docs-import.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,10 @@ toc: false
66
folder: docs
77
---
88

9-
Singularity import is essentially taking a dump of files and folders and adding them to your image. This works for local compressed things (e.g., tar.gz) but also for docker image layers that you don't have on your system. As of version 2.3, import of docker layers includes the environment and metadata without needing sudo.
9+
Singularity import is essentially taking a dump of files and folders and adding them to your image. This works for local compressed things (e.g., tar.gz) but also for docker image layers that you don't have on your system. As of version 2.3, import of docker layers includes the environment and metadata without needing sudo. It's generally very intuitive.
10+
11+
As an example, here is a common use case: wanting to import a Docker image:
12+
13+
```
14+
singularity import container.img docker://ubuntu:latest
15+
```

pages/docs/user-docs/docs-inspect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ How can you sniff an image? We have provided the inspect command for you to easi
1010

1111
{% include toc.html %}
1212

13-
This inspect is essential for making containers understandable by other tools and applications.
13+
This command is essential for making containers understandable by other tools and applications.
1414

1515

1616
## JSON Api Standard

pages/docs/user-docs/docs-run.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ $ singularity run centos7.img
1818
$ ./centos7.img
1919
```
2020

21-
In both cases, we are executing the container's "runscript," which is the executable `/singularity` at the root of the image, which is either an actual file (version 2.2 and earlier) or a link to one (2.3 and later). For example, looking at a 2.3 image, I can see the runscript via the path to the link:
21+
In both cases, we are executing the container's "runscript" (the executable `/singularity` at the root of the image) that is either an actual file (version 2.2 and earlier) or a link to one (2.3 and later). For example, looking at a 2.3 image, I can see the runscript via the path to the link:
2222

2323
```
2424
$ singularity exec centos7.img cat /singularity
@@ -51,7 +51,7 @@ motorbot
5151
```
5252

5353
### Defining the Runscript
54-
When you first create a contianer, the runscript is defined using the followinge order of operations:
54+
When you first create a container, the runscript is defined using the following order of operations:
5555

5656
1. A user defined runscript in the `%runscript` section of a bootstrap takes preference over all
5757
2. If the user has not defined a runscript and is importing a Docker container, the Docker `ENTRYPOINT` is used.

0 commit comments

Comments
 (0)