From 17a5dcb1aae2c38a77a37a60a4781793363d6455 Mon Sep 17 00:00:00 2001
From: Martin Schroschk <martin.schroschk@tu-dresden.de>
Date: Wed, 29 Jun 2022 11:38:19 +0200
Subject: [PATCH] Restructure content and find better headings
---
.../docs/software/compilers.md | 2 +-
.../software/custom_easy_build_environment.md | 32 +++++++------
.../docs/software/modules.md | 2 +-
doc.zih.tu-dresden.de/docs/software/zsh.md | 2 +-
doc.zih.tu-dresden.de/mkdocs.yml | 48 ++++++++++---------
5 files changed, 45 insertions(+), 41 deletions(-)
diff --git a/doc.zih.tu-dresden.de/docs/software/compilers.md b/doc.zih.tu-dresden.de/docs/software/compilers.md
index 7bb9c3c4b..d536abba9 100644
--- a/doc.zih.tu-dresden.de/docs/software/compilers.md
+++ b/doc.zih.tu-dresden.de/docs/software/compilers.md
@@ -1,4 +1,4 @@
-# Compilers
+# Compilers and Flags
The following compilers are available on the ZIH system:
diff --git a/doc.zih.tu-dresden.de/docs/software/custom_easy_build_environment.md b/doc.zih.tu-dresden.de/docs/software/custom_easy_build_environment.md
index 231ce447b..e9283d6d8 100644
--- a/doc.zih.tu-dresden.de/docs/software/custom_easy_build_environment.md
+++ b/doc.zih.tu-dresden.de/docs/software/custom_easy_build_environment.md
@@ -1,4 +1,4 @@
-# EasyBuild
+# Software Install with EasyBuild
Sometimes the [modules](modules.md) installed in the cluster are not enough for your purposes and
you need some other software or a different version of a software.
@@ -6,8 +6,10 @@ you need some other software or a different version of a software.
For most commonly used software, chances are high that there is already a *recipe* that EasyBuild
provides, which you can use. But what is EasyBuild?
-[EasyBuild](https://easybuild.io/) is the software used to build and install
-software on ZIH systems.
+!!! note "EasyBuild"
+
+ [EasyBuild](https://easybuild.io/) is the software used to build and install software on ZIH
+ systems.
The aim of this page is to introduce users to working with EasyBuild and to utilizing it to create
modules.
@@ -15,26 +17,26 @@ modules.
## Prerequisites
1. [Shell access](../access/ssh_login.md) to ZIH systems
-1. basic knowledge about:
- - [the ZIH system](../jobs_and_resources/hardware_overview.md)
- - [the module system](modules.md) on ZIH systems
+1. Basic knowledge about:
+ - [the ZIH system](../jobs_and_resources/hardware_overview.md)
+ - [the module system](modules.md) on ZIH systems
EasyBuild uses a configuration file called recipe or "EasyConfig", which contains all the
information about how to obtain and build the software:
-- Name
-- Version
-- Toolchain (think: Compiler + some more)
-- Download URL
-- Build system (e.g. `configure && make` or `cmake && make`)
-- Config parameters
-- Tests to ensure a successful build
+- Name
+- Version
+- Toolchain (think: Compiler + some more)
+- Download URL
+- Build system (e.g. `configure && make` or `cmake && make`)
+- Config parameters
+- Tests to ensure a successful build
The build system part is implemented in so-called "EasyBlocks" and contains the common workflow.
Sometimes, those are specialized to encapsulate behavior specific to multiple/all versions of the
software. Everything is written in Python, which gives authors a great deal of flexibility.
-## Set up a custom module environment and build your own modules
+## Set Up a Custom Module Environment and Build Your Own Modules
Installation of the new software (or version) does not require any specific credentials.
@@ -43,7 +45,7 @@ Installation of the new software (or version) does not require any specific cred
1. An existing EasyConfig
1. a place to put your modules.
-### Step by step guide
+### Step by Step Guide
**Step 1:** Create a [workspace](../data_lifecycle/workspaces.md#allocate-a-workspace) where you
install your modules. You need a place where your modules are placed. This needs to be done only
diff --git a/doc.zih.tu-dresden.de/docs/software/modules.md b/doc.zih.tu-dresden.de/docs/software/modules.md
index b4aa437d2..9cf35854e 100644
--- a/doc.zih.tu-dresden.de/docs/software/modules.md
+++ b/doc.zih.tu-dresden.de/docs/software/modules.md
@@ -1,4 +1,4 @@
-# Modules
+# Environment Modules
Usage of software on HPC systems is managed by a **modules system**.
diff --git a/doc.zih.tu-dresden.de/docs/software/zsh.md b/doc.zih.tu-dresden.de/docs/software/zsh.md
index 147758a6a..6f9dd15aa 100644
--- a/doc.zih.tu-dresden.de/docs/software/zsh.md
+++ b/doc.zih.tu-dresden.de/docs/software/zsh.md
@@ -1,4 +1,4 @@
-# ZSH
+# ZSH as Alternative Shell
!!! warning
Though all efforts have been made to ensure the accuracy and
diff --git a/doc.zih.tu-dresden.de/mkdocs.yml b/doc.zih.tu-dresden.de/mkdocs.yml
index 0879b8e67..6b1191b64 100644
--- a/doc.zih.tu-dresden.de/mkdocs.yml
+++ b/doc.zih.tu-dresden.de/mkdocs.yml
@@ -26,21 +26,32 @@ nav:
- Overview: data_transfer/overview.md
- Datamover: data_transfer/datamover.md
- Export Nodes: data_transfer/export_nodes.md
- - Environment and Software:
+ - Data Life Cycle Management:
+ - Overview: data_lifecycle/overview.md
+ - Filesystems:
+ - Overview: data_lifecycle/file_systems.md
+ - Permanent Filesystems: data_lifecycle/permanent.md
+ - Lustre: data_lifecycle/lustre.md
+ - BeeGFS: data_lifecycle/beegfs.md
+ - Warm Archive: data_lifecycle/warm_archive.md
+ - Intermediate Archive: data_lifecycle/intermediate_archive.md
+ - Workspaces: data_lifecycle/workspaces.md
+ - Long-Term Preservation: data_lifecycle/longterm_preservation.md
+ - User Environment:
- Overview: software/overview.md
- - Environment:
- - Modules: software/modules.md
- - Private Modules: software/private_modules.md
- - EasyBuild: software/custom_easy_build_environment.md
- - Python Virtual Environments: software/python_virtual_environments.md
- - ZSH: software/zsh.md
+ - Environment Modules: software/modules.md
+ - Private Modules: software/private_modules.md
+ - Software Installation with EasyBuild: software/custom_easy_build_environment.md
+ - Python Virtual Environments: software/python_virtual_environments.md
+ - ZSH as Alternative Shell: software/zsh.md
+ - Applications and Software:
- Containers:
- Singularity: software/containers.md
- Singularity Recipes and Hints: software/singularity_recipe_hints.md
- Singularity for Power9: software/singularity_power9.md
- Virtual Machines: software/virtual_machines.md
- GPU-accelerated Containers for Deep Learning (NGC Containers): software/ngc_containers.md
- - Applications:
+ - Software Applications:
- External Licenses: software/licenses.md
- Computational Fluid Dynamics (CFD): software/cfd.md
- Mathematics Applications: software/mathematics.md
@@ -62,13 +73,15 @@ nav:
- Hyperparameter Optimization (OmniOpt): software/hyperparameter_optimization.md
- Machine Learning with PowerAI: software/power_ai.md
- Virtual Desktops: software/virtual_desktops.md
- - Software Development and Tools:
- - Overview: software/software_development_overview.md
- - Building Software: software/building_software.md
- - Compilers: software/compilers.md
+ - Software Development and Tools:
+ - Overview: software/software_development_overview.md
+ - Building Software:
+ - Overview: software/building_software.md
+ - Compilers and Flags: software/compilers.md
- GPU Programming: software/gpu_programming.md
- Mathematics Libraries: software/math_libraries.md
- Debugging: software/debuggers.md
+ - Software Tools:
- MPI Error Detection: software/mpi_usage_error_detection.md
- Score-P: software/scorep.md
- lo2s: software/lo2s.md
@@ -78,17 +91,6 @@ nav:
- Vampir: software/vampir.md
- Energy Measurement: software/energy_measurement.md
- Utilities: software/utilities.md
- - Data Life Cycle Management:
- - Overview: data_lifecycle/overview.md
- - Filesystems:
- - Overview: data_lifecycle/file_systems.md
- - Permanent Filesystems: data_lifecycle/permanent.md
- - Lustre: data_lifecycle/lustre.md
- - BeeGFS: data_lifecycle/beegfs.md
- - Warm Archive: data_lifecycle/warm_archive.md
- - Intermediate Archive: data_lifecycle/intermediate_archive.md
- - Workspaces: data_lifecycle/workspaces.md
- - Long-Term Preservation: data_lifecycle/longterm_preservation.md
- HPC Resources and Jobs:
- Overview: jobs_and_resources/overview.md
- HPC Resources:
--
GitLab