From 388b77947471b55afdfaed84dd96de41ff60893a Mon Sep 17 00:00:00 2001
From: Lars Bilke <lars.bilke@ufz.de>
Date: Thu, 8 Apr 2021 09:18:58 +0200
Subject: [PATCH] [web] Added Ubuntu install instructions for Singularity.
---
web/assets/css/main.css | 4 ++++
.../docs/devguide/advanced/singularity.md | 17 ++++++++++++++---
web/content/docs/userguide/basics/container.md | 11 +++++------
3 files changed, 23 insertions(+), 9 deletions(-)
diff --git a/web/assets/css/main.css b/web/assets/css/main.css
index 6f2b5aa83d5..89ad6347877 100644
--- a/web/assets/css/main.css
+++ b/web/assets/css/main.css
@@ -26,6 +26,10 @@ cite::before {
content: "— ";
}
+.prose-sm li pre {
+ @apply mt-2;
+}
+
/* The sticky class is added to the header with JS when it reaches its scroll position */
#theHeader.sticky {
position: fixed;
diff --git a/web/content/docs/devguide/advanced/singularity.md b/web/content/docs/devguide/advanced/singularity.md
index 8b339677000..961d039804e 100644
--- a/web/content/docs/devguide/advanced/singularity.md
+++ b/web/content/docs/devguide/advanced/singularity.md
@@ -30,10 +30,21 @@ Singularity per default mounts your home directory and also passes your current
### Prerequisites
-- Linux and [Mac](https://sylabs.io/singularity-desktop-macos/) only!
- - Note: You can run Singularity **on Windows** inside a lightweight virtual machine using [WSL 2](https://docs.microsoft.com/en-us/windows/wsl/install-win10). Under Ubuntu use Homebrew package `singularity`, under CentOS install via [EPEL](https://sylabs.io/guides/3.0/user-guide/installation.html#install-the-centos-rhel-package-using-yum).
- [Install Git]({{< ref "prerequisites" >}}/#step-install-git)
-- [Install Singularity](https://sylabs.io/guides/3.5/user-guide/quick_start.html#quick-installation-steps)
+- Linux and [Mac](https://sylabs.io/singularity-desktop-macos/) only!
+ - Note: You can run Singularity **on Windows** inside a lightweight virtual machine using [WSL 2](https://docs.microsoft.com/en-us/windows/wsl/install-win10) or with [Vagrant](https://app.vagrantup.com/sylabs).
+
+#### Install Singularity
+
+- *CentOS 6/7 / RedHat*: Install via [EPEL](https://sylabs.io/guides/3.0/user-guide/installation.html#install-the-centos-rhel-package-using-yum).
+- *Ubuntu 20.04 / Debian Sid*:
+ ```
+ wget http://ftp.us.debian.org/debian/pool/main/s/singularity-container/singularity-container_3.5.2+ds1-1_amd64.deb
+ sudo apt install containernetworking-plugins squashfs-tools
+ sudo dpkg -i singularity-container_3.5.2+ds1-1_amd64.deb
+ ```
+ - **OR** install [Homebrew](https://docs.brew.sh/Homebrew-on-Linux) package `singularity`.
+- If you do not have one of the above OS versions [install Singularity from source](https://sylabs.io/guides/3.5/user-guide/quick_start.html#quick-installation-steps).
### Build OGS inside a container
diff --git a/web/content/docs/userguide/basics/container.md b/web/content/docs/userguide/basics/container.md
index b8f7b617c09..a4834562f78 100644
--- a/web/content/docs/userguide/basics/container.md
+++ b/web/content/docs/userguide/basics/container.md
@@ -21,10 +21,9 @@ This page describes how to **run** OGS with the help of a Linux container (for *
### Prerequisites
-* Linux or [macOS](https://sylabs.io/singularity-desktop-macos/)
- * Note: You can run Singularity on Windows inside a virtual machine using [WSL 2](https://docs.microsoft.com/en-us/windows/wsl/install-win10) or with [Vagrant](https://app.vagrantup.com/sylabs)
-* A running [installation](https://sylabs.io/guides/3.5/user-guide/quick_start.html#quick-installation-steps) of Singularity 3.0 or higher
- * Available on Eve (UFZ), `envinf1` (UFZ), Juwels (SC Jülich), Taurus (TU Dresden)
+* A running installation of Singularity 3.0 or higher:
+ * Available on Eve (UFZ), `envinf1` / `envinf2` (UFZ), Juwels (SC Jülich), Taurus (TU Dresden).
+ * See the developer guide for [install instructions]({{< ref "singularity.md#prerequisites" >}}).
### Get a container image
@@ -43,9 +42,9 @@ Simply download an image from the [latest master-branch build](https://gitlab.op
singularity exec --app ogs ogs-6.2.2-serial.sif ogs some/path/project.prj
```
-This starts the container, mounts your home directory inside the container, passes the current working directory and runs the ogs executable (in your home directory which is mounted inside the container) with the passed project file. Everything works as expected and is transparent to the user. When ogs finishes the container stops and you returns to the host system.
+This starts the container, mounts your home directory inside the container, passes the current working directory and runs the ogs executable (in your home directory which is mounted inside the container) with the passed project file. Everything works as expected and is transparent to the user. When ogs finishes the container stops and returns to the host system.
-The `--app ogs` selects a pre-defined execution environment in the container (i.e. setting the `PATH` to `/scif/apps/ogs/bin` in which all the executables are located). You could also (and **on macOS you have to**) run without the `--app`-parameter but then you had to specify the full executable path in the container:
+The `--app ogs` selects a predefined execution environment in the container (i.e. setting the `PATH` to `/scif/apps/ogs/bin` in which all the executables are located). You could also (and **on macOS you have to**) run without the `--app`-parameter but then you had to specify the full executable path in the container:
```bash
# Works on macOS too:
--
GitLab