diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000000000000000000000000000000000000..206725958938f6c69ce0b05f1321de307380f572 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +*.webm filter=lfs diff=lfs merge=lfs -text +*.mp4 filter=lfs diff=lfs merge=lfs -text diff --git a/Compendium_attachments/VirtualDesktops/start-virtual-desktop-dcv.mp4 b/Compendium_attachments/VirtualDesktops/start-virtual-desktop-dcv.mp4 index 0df2dd469ef4ab479652862d71bf156a7a6fc98d..571d6fa92a9f6ad06fbca966e4cccfe9f2d0c230 100644 Binary files a/Compendium_attachments/VirtualDesktops/start-virtual-desktop-dcv.mp4 and b/Compendium_attachments/VirtualDesktops/start-virtual-desktop-dcv.mp4 differ diff --git a/Compendium_attachments/VirtualDesktops/start-virtual-desktop-dcv.webm b/Compendium_attachments/VirtualDesktops/start-virtual-desktop-dcv.webm index 7e728464f18518a3f62e6b5eac0134dfcb2609b2..58c81cc82b241bd08b7dfa7cefbe3528d2e6a9ca 100644 Binary files a/Compendium_attachments/VirtualDesktops/start-virtual-desktop-dcv.webm and b/Compendium_attachments/VirtualDesktops/start-virtual-desktop-dcv.webm differ diff --git a/Compendium_attachments/VirtualDesktops/terminate-virtual-desktop-dcv.mp4 b/Compendium_attachments/VirtualDesktops/terminate-virtual-desktop-dcv.mp4 index a5e10e440e2e615dc0d822a4cf5dc6c907559636..80cf3853e0f672d40b75fe7ac8f322a7e3cfbc39 100644 Binary files a/Compendium_attachments/VirtualDesktops/terminate-virtual-desktop-dcv.mp4 and b/Compendium_attachments/VirtualDesktops/terminate-virtual-desktop-dcv.mp4 differ diff --git a/Compendium_attachments/VirtualDesktops/terminate-virtual-desktop-dcv.webm b/Compendium_attachments/VirtualDesktops/terminate-virtual-desktop-dcv.webm index 38d74c3e9f43f33c9f9207a623203b96a13c4469..e7450133c700bbdbb725217772286e5810c85ada 100644 Binary files a/Compendium_attachments/VirtualDesktops/terminate-virtual-desktop-dcv.webm and b/Compendium_attachments/VirtualDesktops/terminate-virtual-desktop-dcv.webm differ diff --git a/doc.zih.tu-dresden.de/docs/access/jupyterhub.md b/doc.zih.tu-dresden.de/docs/access/jupyterhub.md index 4369474e328ec3eab0b38241993356987240a0f1..3457cd669e53fa4b1ca9aaa1e087d6c469bca895 100644 --- a/doc.zih.tu-dresden.de/docs/access/jupyterhub.md +++ b/doc.zih.tu-dresden.de/docs/access/jupyterhub.md @@ -279,6 +279,14 @@ Installed kernelspec my-kernel in .../.local/share/jupyter/kernels/my-kernel (my-kernel) marie@compute$ deactivate ``` +!!! warning + + Depending on the Python module you have loaded for creating your virtual environment, you should + select the apropriate [Standard environment](#standard-environments). For example, you could + select `scs5_gcccore-10.2.0_python-3.8.6`, when you want to use `my-kernel`. Furthermore, + ensure, that you pre-load the same modules via [Spawner Options](#start-a-session) that you used + for creating your kernel. + #### Conda Environment Load the needed module depending on partition architecture: diff --git a/doc.zih.tu-dresden.de/docs/access/misc/startup_hub.webm b/doc.zih.tu-dresden.de/docs/access/misc/startup_hub.webm index 49f8a420ed372b7b7b4aec7e7bf0d8b4dc2861a1..e67be93ed273cf07bf3f407eb1cd65f2fc5dd913 100644 Binary files a/doc.zih.tu-dresden.de/docs/access/misc/startup_hub.webm and b/doc.zih.tu-dresden.de/docs/access/misc/startup_hub.webm differ diff --git a/doc.zih.tu-dresden.de/docs/contrib/content_rules.md b/doc.zih.tu-dresden.de/docs/contrib/content_rules.md index 0062ea6fee6943c3da73ba32f57b61bde63766f9..918f197404ac298081aeb6abedfd52df2311ed77 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/content_rules.md +++ b/doc.zih.tu-dresden.de/docs/contrib/content_rules.md @@ -129,6 +129,8 @@ Further tips can be found on this Please use images and graphics for illustration purposes and to improve comprehensibility. All graphics and attachments are saved within `misc` directory of the respective subdirectory in `docs`. +For video attachments please use either webm or mp4 format, in fact it would be best to upload one +file each in webm and mp4 because then you cover a wider range of browsers. !!! example "Syntax" @@ -139,6 +141,17 @@ All graphics and attachments are saved within `misc` directory of the respective {: align="center"} ``` + The syntax to insert a video attachment into a page is + + ```html + <video controls="" width="320" style="border: 1px solid black"> + <source src="https://doc.zih.tu-dresden.de/software/misc/terminate-virtual-desktop-dcv.mp4" + type="video/mp4" /> + <source src="https://doc.zih.tu-dresden.de/software/misc/terminate-virtual-desktop-dcv.webm" + type="video/webm" /> + </video> + ``` + The attribute `align` is optional. By default, graphics are left-aligned. **Note:** It is crucial to have `{: align="center"}` on a new line. It is possible to add captions for tables and figures using `{: summary="This is a table caption"}`. diff --git a/doc.zih.tu-dresden.de/docs/software/compilers.md b/doc.zih.tu-dresden.de/docs/software/compilers.md index 7bb9c3c4b9f3a65151d5292ff587decd306e35c9..d536abba9b4813fdefe32911e300b60e9bc67368 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 231ce447b0fa8157ebb9b4a8ea6dd9bb1542fa7b..e9283d6d8063bbc9dc6d4c2bd520d9dc96f341b1 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/misc/start-virtual-desktop-dcv.mp4 b/doc.zih.tu-dresden.de/docs/software/misc/start-virtual-desktop-dcv.mp4 index 0df2dd469ef4ab479652862d71bf156a7a6fc98d..571d6fa92a9f6ad06fbca966e4cccfe9f2d0c230 100644 Binary files a/doc.zih.tu-dresden.de/docs/software/misc/start-virtual-desktop-dcv.mp4 and b/doc.zih.tu-dresden.de/docs/software/misc/start-virtual-desktop-dcv.mp4 differ diff --git a/doc.zih.tu-dresden.de/docs/software/misc/start-virtual-desktop-dcv.webm b/doc.zih.tu-dresden.de/docs/software/misc/start-virtual-desktop-dcv.webm index 7e728464f18518a3f62e6b5eac0134dfcb2609b2..58c81cc82b241bd08b7dfa7cefbe3528d2e6a9ca 100644 Binary files a/doc.zih.tu-dresden.de/docs/software/misc/start-virtual-desktop-dcv.webm and b/doc.zih.tu-dresden.de/docs/software/misc/start-virtual-desktop-dcv.webm differ diff --git a/doc.zih.tu-dresden.de/docs/software/misc/terminate-virtual-desktop-dcv.mp4 b/doc.zih.tu-dresden.de/docs/software/misc/terminate-virtual-desktop-dcv.mp4 index a5e10e440e2e615dc0d822a4cf5dc6c907559636..80cf3853e0f672d40b75fe7ac8f322a7e3cfbc39 100644 Binary files a/doc.zih.tu-dresden.de/docs/software/misc/terminate-virtual-desktop-dcv.mp4 and b/doc.zih.tu-dresden.de/docs/software/misc/terminate-virtual-desktop-dcv.mp4 differ diff --git a/doc.zih.tu-dresden.de/docs/software/misc/terminate-virtual-desktop-dcv.webm b/doc.zih.tu-dresden.de/docs/software/misc/terminate-virtual-desktop-dcv.webm index 38d74c3e9f43f33c9f9207a623203b96a13c4469..e7450133c700bbdbb725217772286e5810c85ada 100644 Binary files a/doc.zih.tu-dresden.de/docs/software/misc/terminate-virtual-desktop-dcv.webm and b/doc.zih.tu-dresden.de/docs/software/misc/terminate-virtual-desktop-dcv.webm differ diff --git a/doc.zih.tu-dresden.de/docs/software/modules.md b/doc.zih.tu-dresden.de/docs/software/modules.md index b4aa437d270b4dda1a64f655d3c8a9db9238df2c..9cf35854e953b4d9c2f9380d16217dec91dfea2a 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 147758a6a66dd84aeb040c80d0000110f4af882c..6f9dd15aa0afe743a83ff7ec968766c23c302a87 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 3e35e6a92f1cc9b7eea20b33140d4c9151176b1a..c0393f91d140d5b784dca22ca7c7a1ffe0930aa4 100644 --- a/doc.zih.tu-dresden.de/mkdocs.yml +++ b/doc.zih.tu-dresden.de/mkdocs.yml @@ -26,26 +26,36 @@ 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: - - External Licenses: software/licenses.md - - Computational Fluid Dynamics (CFD): software/cfd.md - - Mathematics Applications: software/mathematics.md - - Nanoscale Simulations: software/nanoscale_simulations.md - - FEM Software: software/fem_software.md + - External Licenses: software/licenses.md + - Computational Fluid Dynamics (CFD): software/cfd.md + - Mathematics Applications: software/mathematics.md + - Nanoscale Simulations: software/nanoscale_simulations.md + - FEM Software: software/fem_software.md - Visualization: software/visualization.md - Data Analytics: - Overview: software/data_analytics.md @@ -62,13 +72,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 Engineering Tools: - MPI Error Detection: software/mpi_usage_error_detection.md - Score-P: software/scorep.md - lo2s: software/lo2s.md @@ -78,17 +90,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: