Commit 9bebd0f3 authored by Lukáš Krupčík's avatar Lukáš Krupčík
Browse files

fix capitalize

parent dee744ea
......@@ -35,23 +35,23 @@ For better user experience with singularity containers we prepared several wrapp
* image-update
Listed wrappers helps you to use prepared singularity images loaded as modules. You can easily load singularity image like any other module on the cluster
by `ml OS/version` command. After first module load, the prepared image is copied into your home folder and is prepared for use. When you load the module
by `ml OS/version` command. After first module load, the prepared image is copied into your home folder and is prepared for use. When you load the module
next time, the version of image is checked and image update (if exists) is offered. Then you can update your copy of image by the `image-update` command.
!!! warning
With image update, all user changes to the image will be overridden.
The runscript inside the singularity image can be run by the `image-run` command. This command automatically mounts the `/scratch` and `/apps` storage and
invoke the image as writable, so user changes can be made.
Very similar to `image-run` is the `image-exec` command. The only difference is that `image-exec` runs user-defined command instead of the runscript. In this case,
the command to be run is specified as a parameter.
For development is very useful to use interactive shell inside the singularity container. In this interactive shell you can make any changes to the image you want,
For development is very useful to use interactive shell inside the singularity container. In this interactive shell you can make any changes to the image you want,
but be aware that you can not use the `sudo` privileged commands directly on the cluster. To invoke interactive shell easily just use the `image-shell` command.
Another useful feature of the singularity is direct support of OpenMPI. For proper MPI function, you have to install the same version of OpenMPI as you use on cluster inside the
image. OpenMPI/2.1.1 is installed in prepared images. The MPI must be started outside of the container. The easiest way to start the MPI is to use the `image-mpi` command.
image. OpenMPI/2.1.1 is installed in prepared images. The MPI must be started outside of the container. The easiest way to start the MPI is to use the `image-mpi` command.
This command has the same parameters as the `mpirun`. Thanks to that, there is no difference between running normal MPI application and MPI application in singularity container.
## Examples
......@@ -68,7 +68,9 @@ Your image of CentOS/6.9 is at location: /home/login/.singularity/images/CentOS-
!!! tip
First usage module with singularity image, copy singularity image from /apps/all/OS/... to your /home (.singularity/images)
### image-exec
### Wrappers
**image-exec**
Open the image and run the command inside the image.
......@@ -79,15 +81,15 @@ $ image-exec cat /etc/centos-release
CentOS Linux release 7.3.1708 (Core)
```
### image-mpi
**image-mpi**
MPI wrapper. More in the chapter [Examples MPI](#mpi).
### image-run
**image-run**
Run the subscript inside image.
### image-shell
**image-shell**
Start the shell inside image.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment