From 77d03816f2e5a5e25db0f9c474725c01636ab694 Mon Sep 17 00:00:00 2001
From: Bert Wesarg <bert.wesarg@tu-dresden.de>
Date: Thu, 29 Jul 2021 11:57:14 +0200
Subject: [PATCH] Update docs/software/vampir.md
---
.../docs/software/misc}/vampir-framework.png | Bin
.../vampir-open-remote-dialog-auto-start.png | Bin
.../vampir-open-remote-dialog-unstable.png | Bin
.../misc/vampir-open-remote-dialog.png | Bin
doc.zih.tu-dresden.de/docs/software/vampir.md | 52 +++++++++---------
5 files changed, 25 insertions(+), 27 deletions(-)
rename {Compendium_attachments/Vampir => doc.zih.tu-dresden.de/docs/software/misc}/vampir-framework.png (100%)
rename Compendium_attachments/Vampir/vampir_open_remote_dialog_auto_start.png => doc.zih.tu-dresden.de/docs/software/misc/vampir-open-remote-dialog-auto-start.png (100%)
rename Compendium_attachments/Vampir/vampir_open_remote_dialog_unstable.png => doc.zih.tu-dresden.de/docs/software/misc/vampir-open-remote-dialog-unstable.png (100%)
rename Compendium_attachments/Vampir/vampir_open_remote_dialog.png => doc.zih.tu-dresden.de/docs/software/misc/vampir-open-remote-dialog.png (100%)
diff --git a/Compendium_attachments/Vampir/vampir-framework.png b/doc.zih.tu-dresden.de/docs/software/misc/vampir-framework.png
similarity index 100%
rename from Compendium_attachments/Vampir/vampir-framework.png
rename to doc.zih.tu-dresden.de/docs/software/misc/vampir-framework.png
diff --git a/Compendium_attachments/Vampir/vampir_open_remote_dialog_auto_start.png b/doc.zih.tu-dresden.de/docs/software/misc/vampir-open-remote-dialog-auto-start.png
similarity index 100%
rename from Compendium_attachments/Vampir/vampir_open_remote_dialog_auto_start.png
rename to doc.zih.tu-dresden.de/docs/software/misc/vampir-open-remote-dialog-auto-start.png
diff --git a/Compendium_attachments/Vampir/vampir_open_remote_dialog_unstable.png b/doc.zih.tu-dresden.de/docs/software/misc/vampir-open-remote-dialog-unstable.png
similarity index 100%
rename from Compendium_attachments/Vampir/vampir_open_remote_dialog_unstable.png
rename to doc.zih.tu-dresden.de/docs/software/misc/vampir-open-remote-dialog-unstable.png
diff --git a/Compendium_attachments/Vampir/vampir_open_remote_dialog.png b/doc.zih.tu-dresden.de/docs/software/misc/vampir-open-remote-dialog.png
similarity index 100%
rename from Compendium_attachments/Vampir/vampir_open_remote_dialog.png
rename to doc.zih.tu-dresden.de/docs/software/misc/vampir-open-remote-dialog.png
diff --git a/doc.zih.tu-dresden.de/docs/software/vampir.md b/doc.zih.tu-dresden.de/docs/software/vampir.md
index 464f29bb1..036df6e86 100644
--- a/doc.zih.tu-dresden.de/docs/software/vampir.md
+++ b/doc.zih.tu-dresden.de/docs/software/vampir.md
@@ -8,15 +8,17 @@ graphical displays, including state diagrams, statistics, and timelines, can be
to obtain a better understanding of their parallel program inner working and to subsequently
optimize it. Vampir allows to focus on appropriate levels of detail, which allows the detection and
explanation of various performance bottlenecks such as load imbalances and communication
-deficiencies. [Follow this link for further
-information](http://tu-dresden.de/die_tu_dresden/zentrale_einrichtungen/zih/forschung/projekte/vampir).
+deficiencies. Follow this
+[link](http://tu-dresden.de/die_tu_dresden/zentrale_einrichtungen/zih/forschung/projekte/vampir)
+for further information.
-A growing number of performance monitoring environments like [VampirTrace](../archive/vampir_trace.md),
-Score-P, TAU or KOJAK can produce trace files that are readable by Vampir. The tool supports trace
-files in Open Trace Format (OTF, OTF2) that is developed by ZIH and its partners and is especially
-designed for massively parallel programs.
+[Score-P](scorep.md) is the primary code instrumentation and run-time measurement framework for
+Vampir and supports various instrumentation methods, including instrumentation at source level and
+at compile/link time. The tool supports trace files in Open Trace Format (OTF, OTF2) that is
+developed by ZIH and its partners and is especially designed for massively parallel programs.
-\<img alt="" src="%ATTACHURLPATH%/vampir-framework.png" title="Vampir Framework" />
+
+{: align="center"}
## Starting Vampir
@@ -24,14 +26,14 @@ Prior to using Vampir you need to set up the correct environment on one
the HPC systems with:
```Bash
-module load vampir
+module load Vampir
```
For members of TU Dresden the Vampir tool is also available as
[download](http://tu-dresden.de/die_tu_dresden/zentrale_einrichtungen/zih/forschung/projekte/vampir/vampir_download_tu)
for installation on your personal computer.
-Make sure, that compressed display forwarding (e.g. `ssh -XC taurus.hrsk.tu-dresden.de`) is
+Make sure, that compressed display forwarding (e.g., `ssh -YC taurus.hrsk.tu-dresden.de`) is
enabled. Start the GUI by typing
```Bash
@@ -47,15 +49,15 @@ for a tutorial on using the tool.
## Using VampirServer
VampirServer provides additional scalable analysis capabilities to the Vampir GUI mentioned above.
-To use VampirServer on the HPC resources of TU Dresden proceed as follows: start the Vampir GUI as
+To use VampirServer on the ZIH Systems proceed as follows: start the Vampir GUI as
described above and use the *Open Remote* dialog with the parameters indicated in the following
-figure to start and connect a VampirServer instance running on taurus.hrsk.tu-dresden.de. Make sure
+figure to start and connect a VampirServer already instance running on the HPC system. Make sure
to fill in your personal ZIH login name.
-\<img alt="" src="%ATTACHURLPATH%/vampir_open_remote_dialog.png"
-title="Vampir Open Remote Dialog" />
+
+{: align="center"}
-Click on the Connect button and wait until the connection is established. Enter your password when
+Click on the *Connect* button and wait until the connection is established. Enter your password when
requested. Depending on the available resources on the target system, this setup can take some time.
Please be patient and take a look at available resources beforehand.
@@ -90,9 +92,8 @@ After scheduling this job the server prints out the port number it is serving on
Connecting to the most recently started server can be achieved by entering `auto-detect` as *Setup
name* in the *Open Remote* dialog of Vampir.
-\<img alt=""
-src="%ATTACHURLPATH%/vampir_open_remote_dialog_auto_start.png"
-title="Vampir Open Remote Dialog" />
+
+{: align="center"}
Please make sure you stop VampirServer after finishing your work with
the front-end or with
@@ -107,9 +108,8 @@ Type
vampirserver help
```
-for further information. The [user manual of
-VampirServer](http://tu-dresden.de/die_tu_dresden/zentrale_einrichtungen/zih/forschung/projekte/vampir/dateien/VampirServer-User-Manual.pdf)
-can be found at *installation directory* /doc/vampirserver-manual.pdf.
+for further information. The [user manual](http://tu-dresden.de/die_tu_dresden/zentrale_einrichtungen/zih/forschung/projekte/vampir/dateien/VampirServer-User-Manual.pdf)
+of VampirServer can be found at `doc/vampirserver-manual.pdf` in the installation directory.
Type
```Bash
@@ -123,10 +123,9 @@ to find the revision dependent *installation directory*.
VampirServer listens to a given socket port. It is possible to forward
this port (SSH tunnel) to a remote machine. This procedure is not
recommended and not needed at ZIH. However, the following example shows
-the tunneling to a VampirServer on a compute node at Taurus. The same
-procedure works on Venus.
+the tunneling to a VampirServer on a compute node.
-Start VampirServer on Taurus and wait for its scheduling:
+Start VampirServer on the ZIH system and wait for its scheduling:
```Bash
vampirserver start
@@ -157,13 +156,12 @@ taurusi1253 of Taurus. Finally, start your local Vampir client and establish a r
Remark: Please substitute the ports given in this example with appropriate numbers and available
ports.
-### Nightly builds (unstable)
+### Nightly Builds (unstable)
Expert users who subscribed to the development program can test new, unstable tool features. The
corresponding Vampir and VampirServer software releases are provided as nightly builds. Unstable
versions of VampirServer are also installed on the HPC systems. The most recent version can be
launched/connected by entering `unstable` as *Setup name* in the *Open Remote* dialog of Vampir.
-\<img alt=""
-src="%ATTACHURLPATH%/vampir_open_remote_dialog_unstable.png"
-title="Connecting to unstable VampirServer" />
+
+{: align="center"}
--
GitLab