From cd99393feedfccec71d3c752e8c009a8e42ab2ae Mon Sep 17 00:00:00 2001 From: Apurv Kulkarni <apurv.kulkarni@tu-dresden.de> Date: Mon, 3 Jan 2022 18:21:49 +0100 Subject: [PATCH] Corrected/Modified the page headlines and navigation side-bar to match with eachother --- .../docs/access/key_fingerprints.md | 2 +- .../docs/contrib/contribute_browser.md | 2 +- .../docs/contrib/contribute_container.md | 2 +- .../docs/data_lifecycle/beegfs.md | 2 +- .../preservation_research_data.md | 2 +- .../docs/data_transfer/datamover.md | 2 +- .../docs/data_transfer/overview.md | 6 ++--- .../docs/jobs_and_resources/alpha_centauri.md | 4 +-- .../jobs_and_resources/hardware_overview.md | 4 +-- .../partitions_and_limits.md | 2 +- .../docs/jobs_and_resources/power9.md | 2 +- .../software/custom_easy_build_environment.md | 2 +- .../software/data_analytics_with_python.md | 2 +- .../docs/software/data_analytics_with_r.md | 2 +- .../docs/software/licenses.md | 2 +- .../software/mpi_usage_error_detection.md | 2 +- .../docs/software/nanoscale_simulations.md | 2 +- .../docs/software/ngc_containers.md | 2 +- .../docs/software/perf_tools.md | 4 ++- doc.zih.tu-dresden.de/docs/software/pika.md | 2 +- .../docs/software/power_ai.md | 2 +- .../docs/software/private_modules.md | 2 +- doc.zih.tu-dresden.de/mkdocs.yml | 26 +++++++++---------- 23 files changed, 41 insertions(+), 39 deletions(-) diff --git a/doc.zih.tu-dresden.de/docs/access/key_fingerprints.md b/doc.zih.tu-dresden.de/docs/access/key_fingerprints.md index 6be427f53..cec0634d6 100644 --- a/doc.zih.tu-dresden.de/docs/access/key_fingerprints.md +++ b/doc.zih.tu-dresden.de/docs/access/key_fingerprints.md @@ -1,4 +1,4 @@ -# SSH Key Fingerprints +# Key Fingerprints !!! hint diff --git a/doc.zih.tu-dresden.de/docs/contrib/contribute_browser.md b/doc.zih.tu-dresden.de/docs/contrib/contribute_browser.md index 45e8018d2..83bb8c159 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/contribute_browser.md +++ b/doc.zih.tu-dresden.de/docs/contrib/contribute_browser.md @@ -1,4 +1,4 @@ -# Contribution Guide for Browser-based Editing +# Browser-based Editing In the following, it is outlined how to contribute to the [HPC documentation](https://doc.zih.tu-dresden.de/) of diff --git a/doc.zih.tu-dresden.de/docs/contrib/contribute_container.md b/doc.zih.tu-dresden.de/docs/contrib/contribute_container.md index dd44fafa1..c69921f30 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/contribute_container.md +++ b/doc.zih.tu-dresden.de/docs/contrib/contribute_container.md @@ -1,4 +1,4 @@ -# Contributing Using a Local Clone and a Docker Container +# Work Locally Using Containers ## Git Procedure diff --git a/doc.zih.tu-dresden.de/docs/data_lifecycle/beegfs.md b/doc.zih.tu-dresden.de/docs/data_lifecycle/beegfs.md index 1e2460c38..c4fc5ec24 100644 --- a/doc.zih.tu-dresden.de/docs/data_lifecycle/beegfs.md +++ b/doc.zih.tu-dresden.de/docs/data_lifecycle/beegfs.md @@ -1,4 +1,4 @@ -# BeeGFS +# BeeGFS Filesystems Commands to work with the BeeGFS filesystem. diff --git a/doc.zih.tu-dresden.de/docs/data_lifecycle/preservation_research_data.md b/doc.zih.tu-dresden.de/docs/data_lifecycle/preservation_research_data.md index 79ae1cf00..d63529bf2 100644 --- a/doc.zih.tu-dresden.de/docs/data_lifecycle/preservation_research_data.md +++ b/doc.zih.tu-dresden.de/docs/data_lifecycle/preservation_research_data.md @@ -1,4 +1,4 @@ -# Long-term Preservation for Research Data +# Preservation for Research Data ## Why should research data be preserved? diff --git a/doc.zih.tu-dresden.de/docs/data_transfer/datamover.md b/doc.zih.tu-dresden.de/docs/data_transfer/datamover.md index 41333949c..bd4e615e2 100644 --- a/doc.zih.tu-dresden.de/docs/data_transfer/datamover.md +++ b/doc.zih.tu-dresden.de/docs/data_transfer/datamover.md @@ -1,4 +1,4 @@ -# Transferring Files Between ZIH Systems +# Datamover With the **datamover**, we provide a special data transfer machine for transferring data with best transfer speed between the filesystems of ZIH systems. The datamover machine is not accessible diff --git a/doc.zih.tu-dresden.de/docs/data_transfer/overview.md b/doc.zih.tu-dresden.de/docs/data_transfer/overview.md index c2f4fe1e6..a8af87cc5 100644 --- a/doc.zih.tu-dresden.de/docs/data_transfer/overview.md +++ b/doc.zih.tu-dresden.de/docs/data_transfer/overview.md @@ -1,6 +1,6 @@ -# Transfer of Data +# Data Transfer -## Moving Data to/from ZIH Systems +## Data Transfer to/from ZIH Systems: Export Nodes There are at least three tools for exchanging data between your local workstation and ZIH systems: `scp`, `rsync`, and `sftp`. Please refer to the offline or online man pages of @@ -12,7 +12,7 @@ No matter what tool you prefer, it is crucial that the **export nodes** are used copy data to/from ZIH systems. Please follow the link to the documentation on [export nodes](export_nodes.md) for further reference and examples. -## Moving Data Inside ZIH Systems: Datamover +## Data Transfer Inside ZIH Systems: Datamover The recommended way for data transfer inside ZIH Systems is the **datamover**. It is a special data transfer machine that provides the best transfer speed. To load, move, copy etc. files from one diff --git a/doc.zih.tu-dresden.de/docs/jobs_and_resources/alpha_centauri.md b/doc.zih.tu-dresden.de/docs/jobs_and_resources/alpha_centauri.md index c2e1bac98..dadc94855 100644 --- a/doc.zih.tu-dresden.de/docs/jobs_and_resources/alpha_centauri.md +++ b/doc.zih.tu-dresden.de/docs/jobs_and_resources/alpha_centauri.md @@ -1,6 +1,6 @@ -# Alpha Centauri - Multi-GPU Sub-Cluster +# Alpha Centauri -The sub-cluster "Alpha Centauri" had been installed for AI-related computations (ScaDS.AI). +The multi-GPU sub-cluster "Alpha Centauri" had been installed for AI-related computations (ScaDS.AI). It has 34 nodes, each with: * 8 x NVIDIA A100-SXM4 (40 GB RAM) diff --git a/doc.zih.tu-dresden.de/docs/jobs_and_resources/hardware_overview.md b/doc.zih.tu-dresden.de/docs/jobs_and_resources/hardware_overview.md index 218bd3d4b..c7b6374a4 100644 --- a/doc.zih.tu-dresden.de/docs/jobs_and_resources/hardware_overview.md +++ b/doc.zih.tu-dresden.de/docs/jobs_and_resources/hardware_overview.md @@ -1,6 +1,6 @@ -# ZIH Systems +# HPC Resources -ZIH systems comprises the *High Performance Computing and Storage Complex* and its +HPC resources in ZIH systems comprises the *High Performance Computing and Storage Complex* and its extension *High Performance Computing – Data Analytics*. In total it offers scientists about 60,000 CPU cores and a peak performance of more than 1.5 quadrillion floating point operations per second. The architecture specifically tailored to data-intensive computing, Big Data diff --git a/doc.zih.tu-dresden.de/docs/jobs_and_resources/partitions_and_limits.md b/doc.zih.tu-dresden.de/docs/jobs_and_resources/partitions_and_limits.md index 1b0b7e434..780d73675 100644 --- a/doc.zih.tu-dresden.de/docs/jobs_and_resources/partitions_and_limits.md +++ b/doc.zih.tu-dresden.de/docs/jobs_and_resources/partitions_and_limits.md @@ -1,4 +1,4 @@ -# Partitions, Memory and Run Time Limits +# Partitions and Limits There is no such thing as free lunch at ZIH systems. Since, compute nodes are operated in multi-user node by default, jobs of several users can run at the same time at the very same node sharing diff --git a/doc.zih.tu-dresden.de/docs/jobs_and_resources/power9.md b/doc.zih.tu-dresden.de/docs/jobs_and_resources/power9.md index 40c477024..aae23705c 100644 --- a/doc.zih.tu-dresden.de/docs/jobs_and_resources/power9.md +++ b/doc.zih.tu-dresden.de/docs/jobs_and_resources/power9.md @@ -1,4 +1,4 @@ -# IBM Power9 Nodes for Machine Learning +# IBM Power9 Nodes For machine learning, we have 32 IBM AC922 nodes installed with this configuration: 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..2fba1e4b6 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 +# EasyBuild Modules 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. diff --git a/doc.zih.tu-dresden.de/docs/software/data_analytics_with_python.md b/doc.zih.tu-dresden.de/docs/software/data_analytics_with_python.md index 00ce0c5c4..50d60b1d3 100644 --- a/doc.zih.tu-dresden.de/docs/software/data_analytics_with_python.md +++ b/doc.zih.tu-dresden.de/docs/software/data_analytics_with_python.md @@ -1,4 +1,4 @@ -# Python for Data Analytics +# Data Analytics with Python Python is a high-level interpreted language widely used in research and science. Using ZIH system allows you to work with Python quicker and more effective. Here, a general introduction to working diff --git a/doc.zih.tu-dresden.de/docs/software/data_analytics_with_r.md b/doc.zih.tu-dresden.de/docs/software/data_analytics_with_r.md index 72224113f..b9a665b13 100644 --- a/doc.zih.tu-dresden.de/docs/software/data_analytics_with_r.md +++ b/doc.zih.tu-dresden.de/docs/software/data_analytics_with_r.md @@ -1,4 +1,4 @@ -# R for Data Analytics +# Data Analytics with R [R](https://www.r-project.org/about.html) is a programming language and environment for statistical computing and graphics. It provides a wide variety of statistical (linear and nonlinear modeling, diff --git a/doc.zih.tu-dresden.de/docs/software/licenses.md b/doc.zih.tu-dresden.de/docs/software/licenses.md index 3173cf98a..aaeec5bd1 100644 --- a/doc.zih.tu-dresden.de/docs/software/licenses.md +++ b/doc.zih.tu-dresden.de/docs/software/licenses.md @@ -1,4 +1,4 @@ -# Use of External Licenses +# External Licenses It is possible (please [contact the support team](../support/support.md) first) for users to install their own software and use their own license servers, e.g. FlexLM. The outbound IP addresses from diff --git a/doc.zih.tu-dresden.de/docs/software/mpi_usage_error_detection.md b/doc.zih.tu-dresden.de/docs/software/mpi_usage_error_detection.md index b083e80cf..a26a8c6ee 100644 --- a/doc.zih.tu-dresden.de/docs/software/mpi_usage_error_detection.md +++ b/doc.zih.tu-dresden.de/docs/software/mpi_usage_error_detection.md @@ -1,4 +1,4 @@ -# Correctness Checking and Usage Error Detection for MPI Parallel Applications +# MPI Error Detection MPI as the de-facto standard for parallel applications of the message passing paradigm offers more than one hundred different API calls with complex restrictions. As a result, developing diff --git a/doc.zih.tu-dresden.de/docs/software/nanoscale_simulations.md b/doc.zih.tu-dresden.de/docs/software/nanoscale_simulations.md index 7b40b9e48..14018d374 100644 --- a/doc.zih.tu-dresden.de/docs/software/nanoscale_simulations.md +++ b/doc.zih.tu-dresden.de/docs/software/nanoscale_simulations.md @@ -1,4 +1,4 @@ -# Nanoscale Modeling Tools +# Nanoscale Simulations ## ABINIT diff --git a/doc.zih.tu-dresden.de/docs/software/ngc_containers.md b/doc.zih.tu-dresden.de/docs/software/ngc_containers.md index f19612d9a..18fc2a5b5 100644 --- a/doc.zih.tu-dresden.de/docs/software/ngc_containers.md +++ b/doc.zih.tu-dresden.de/docs/software/ngc_containers.md @@ -1,4 +1,4 @@ -# GPU-accelerated Containers for Deep Learning (NGC Containers) +# NGC Containers A [container](containers.md) is an executable and portable unit of software. On ZIH systems, [Singularity](https://sylabs.io/) is used as a standard container solution. diff --git a/doc.zih.tu-dresden.de/docs/software/perf_tools.md b/doc.zih.tu-dresden.de/docs/software/perf_tools.md index 83398f49c..8afac08a8 100644 --- a/doc.zih.tu-dresden.de/docs/software/perf_tools.md +++ b/doc.zih.tu-dresden.de/docs/software/perf_tools.md @@ -1,4 +1,6 @@ -# Introduction +# Perf Tools + +## Introduction `perf` consists of two parts: the kernel space implementation and the userland tools. This wiki entry focusses on the latter. These tools are installed on ZIH systems, and others and provides diff --git a/doc.zih.tu-dresden.de/docs/software/pika.md b/doc.zih.tu-dresden.de/docs/software/pika.md index deecced31..3b9cd3fd7 100644 --- a/doc.zih.tu-dresden.de/docs/software/pika.md +++ b/doc.zih.tu-dresden.de/docs/software/pika.md @@ -1,4 +1,4 @@ -# Performance Analysis of HPC Applications with PIKA +# PIKA PIKA is a hardware performance monitoring stack to identify inefficient HPC jobs. Users of ZIH systems have the possibility to visualize and analyze the efficiency of their jobs via the diff --git a/doc.zih.tu-dresden.de/docs/software/power_ai.md b/doc.zih.tu-dresden.de/docs/software/power_ai.md index b4beda5ce..b5e35eee0 100644 --- a/doc.zih.tu-dresden.de/docs/software/power_ai.md +++ b/doc.zih.tu-dresden.de/docs/software/power_ai.md @@ -1,4 +1,4 @@ -# PowerAI Documentation Links +# PowerAI There are different documentation sources for users to learn more about the PowerAI Framework for Machine Learning. In the following the links diff --git a/doc.zih.tu-dresden.de/docs/software/private_modules.md b/doc.zih.tu-dresden.de/docs/software/private_modules.md index 4b79463f0..56ad32a45 100644 --- a/doc.zih.tu-dresden.de/docs/software/private_modules.md +++ b/doc.zih.tu-dresden.de/docs/software/private_modules.md @@ -1,4 +1,4 @@ -# Project and User Private Modules +# Private Modules Private module files allow you to load your own installed software packages into your environment and to handle different versions without getting into conflicts. Private modules can be setup for a diff --git a/doc.zih.tu-dresden.de/mkdocs.yml b/doc.zih.tu-dresden.de/mkdocs.yml index 51885fab7..62603f564 100644 --- a/doc.zih.tu-dresden.de/mkdocs.yml +++ b/doc.zih.tu-dresden.de/mkdocs.yml @@ -2,21 +2,21 @@ nav: - Home: index.md - Application for Login and Resources: - Overview: application/overview.md - - Terms: application/terms_of_use.md + - Terms of Use: application/terms_of_use.md - Request for Resources: application/request_for_resources.md - Project Request Form: application/project_request_form.md - Project Management: application/project_management.md - Access to ZIH Systems: - Overview: access/overview.md - Connecting with SSH: access/ssh_login.md - - Desktop Visualization: access/desktop_cloud_visualization.md + - Desktop Cloud Visualization (DCV): access/desktop_cloud_visualization.md - Graphical Applications with WebVNC: access/graphical_applications_with_webvnc.md - JupyterHub: - JupyterHub: access/jupyterhub.md - JupyterHub for Teaching: access/jupyterhub_for_teaching.md - Key Fingerprints: access/key_fingerprints.md - Security Restrictions: access/security_restrictions.md - - Transfer of Data: + - Data Transfer: - Overview: data_transfer/overview.md - Datamover: data_transfer/datamover.md - Export Nodes: data_transfer/export_nodes.md @@ -24,8 +24,8 @@ nav: - Overview: software/overview.md - Environment: - Modules: software/modules.md - - Private Modulefiles: software/private_modules.md - - Custom EasyBuild Modules: software/custom_easy_build_environment.md + - Private Modules: software/private_modules.md + - EasyBuild Modules: software/custom_easy_build_environment.md - Python Virtual Environments: software/python_virtual_environments.md - ZSH: software/zsh.md - Containers: @@ -35,9 +35,9 @@ nav: - Virtual Machines: software/virtual_machines.md - NGC Containers: software/ngc_containers.md - Applications: - - Licenses: software/licenses.md + - External Licenses: software/licenses.md - Computational Fluid Dynamics (CFD): software/cfd.md - - Mathematics: software/mathematics.md + - Mathematics Applications: software/mathematics.md - Nanoscale Simulations: software/nanoscale_simulations.md - FEM Software: software/fem_software.md - Visualization: software/visualization.md @@ -62,7 +62,7 @@ nav: - Building Software: software/building_software.md - Compilers: software/compilers.md - GPU Programming: software/gpu_programming.md - - Libraries: software/math_libraries.md + - Mathematics Libraries: software/math_libraries.md - Debugging: software/debuggers.md - MPI Error Detection: software/mpi_usage_error_detection.md - Score-P: software/scorep.md @@ -75,9 +75,9 @@ nav: - Overview: data_lifecycle/overview.md - Filesystems: - Overview: data_lifecycle/file_systems.md - - Permanent File Systems: data_lifecycle/permanent.md - - Lustre: data_lifecycle/lustre.md - - BeeGFS: data_lifecycle/beegfs.md + - Permanent Filesystems: data_lifecycle/permanent.md + - Lustre Filesystems: data_lifecycle/lustre.md + - BeeGFS Filesystems: data_lifecycle/beegfs.md - Warm Archive: data_lifecycle/warm_archive.md - Intermediate Archive: data_lifecycle/intermediate_archive.md - Workspaces: data_lifecycle/workspaces.md @@ -87,7 +87,7 @@ nav: - Overview: jobs_and_resources/overview.md - HPC Resources: - Overview: jobs_and_resources/hardware_overview.md - - AMD Rome Nodes: jobs_and_resources/rome_nodes.md + - Island 7 - AMD Rome Nodes: jobs_and_resources/rome_nodes.md - IBM Power9 Nodes: jobs_and_resources/power9.md - NVMe Storage: jobs_and_resources/nvme_storage.md - Alpha Centauri: jobs_and_resources/alpha_centauri.md @@ -126,7 +126,7 @@ nav: - VampirTrace: archive/vampirtrace.md - Windows Batchjobs: archive/windows_batch.md - Contribute: - - How-To: contrib/howto_contribute.md + - How-To Contribute: contrib/howto_contribute.md - Content Rules: contrib/content_rules.md - Browser-based Editing: contrib/contribute_browser.md - Work Locally Using Containers: contrib/contribute_container.md -- GitLab