View source for Graphic Environment

For graphical pre- and post-processing purposes some visualisation nodes have been integrated into the Vulcan cluster. 
<pre>
user@cl5fr2>qsub -I -l select=1:node_type=visamd -q vis
</pre>

To use the graphic hardware for remote rendering there are currently two ways tested.
The first is via TurboVNC the second one is directly via VirtualGL.

== VNC Setup ==
If you want to use the vulcan Graphic Hardware e.g. for graphical pre- and post-processing, on way to do it is via a vnc-connection. For that purpose you have to download/install a VNC viewer to/on your local machine. 

E.g. TurboVNC comes as a pre-compiled package which can be downloaded from [https://sourceforge.net/projects/turbovnc/ https://sourceforge.net/projects/turbovnc/]. For Fedora Linux from version 13 onwards the package tigervnc is available via the package manager.

Other VNC viewers can also be used but we recommend the usage of TurboVNC, an accelerated version of TightVNC 
designed for video and 3D applications, since we run the TurboVNC server on the visualisation nodes and  the combination of the two components will give the best performance for GL applications.

==== Preparation of vulcan Cluster ====
Before using vnc for the first time you have to log on to the Vulcan frontend and create the vnc settings directory 
<pre>
cd $HOME
mkdir .vnc
</pre>
With the command 
<pre>vncpasswd</pre>
the vnc password file vncpasswd is created within the $HOME/.vnc directory which is required for a correct server startup.

==== Starting the TurboVNC server ====

To start a TurboVNC server you simply have to login to the cluster frontend cl3fr1.hww.de via ssh.

<pre>
user@client>ssh cl1fr3.hww.hlrs.de
</pre>

Then load the VirtualGL module to setup the VNC environment and launch the VNC startscript.
<pre>
user@eslogin001>module load VirtualGL
user@eslogin001>vis_via_vnc.sh
</pre>

This will set up a default VNC session with one hour walltime running a TurboVNC server with a resolution of 1240x900.
To control the configuration of the VNC session the vis_via_vnc.sh script has three '''optional''' parameters.

<pre>
vis_via_vnc.sh [walltime] [geometry] [x0vnc]
</pre>

where walltime can be specified in format hh:mm:ss or only hh. 

The geometry option sets the resolution of the Xvnc server launched by the TurboVNC session and has to be given in format 1234x1234.

If x0vnc is specified instead of a TurboVNC server with own Xvnc Display a X0-VNC server is started. As its name says this server is directly connected to the :0.0 Display which is contoled by an X-Server always running on the visualisation nodes. A session started with this option will have a maximum resolution of 1152x864 pixels which can not be changed.

There is also a -help option which returns the explanation of the parameters and gives examples for script usage.

The vis_via_vnc.sh script returns the name of the node reserved for you, a display number and the IP-address.

==== VNC viewer with -via option ====
If you got a VNC viewer which supports the via option like TurboVNC or TigerVNC you can simply call the viewer
like stated below
<pre>
user@client>vncviewer -via cl1fr3.hww.hlrs.de <node name>:<Display#>
</pre>

==== VNC viewer without -via option ====
If you got a VNC viewer without support of the vis option, like JavaVNC or TightVNC for Windows, you have to setup a ssh tunnel via the frontend first and then launch the VNC viewer with a connection to localhost
<pre>
user@client>ssh -N -L10000:<IP-address of vis-node>:5901 &
user@client>vncviewer localhost:10000
</pre>

Enter the vnc password you set on the frontend and you should get a Gnome session running in your VNC viewer.

==== GL applications within the VNC session with TurboVNC ====
To execute 64Bit GL Applications within this session you have to open a shell and again load the VirtualGL module to set the VirtualGL environment and then start the application with the VirtualGL wrapper command
<pre>
vglrun <Application command>
</pre>

[[Image:vgl_in_vnc_session.png]]

==== GL applications within the VNC session with X0-VNC ====
Since the X0-VNC server is directly reading the frame buffer of the visualisation node's graphic card, GL applications can be directly executed within the VNC session without using any wrapping command.

==== Ending the vnc session ====

If the vnc session isn't needed any more and the requested walltime isn't expired already you should kill your queue job with

<pre>
user@cl1fr3>qdel [Job ID]
</pre>

==== Usage under Windows ====

VNC viewers for Windows often do not support the '-via' option to tunnel via SSH. In this manual tunneling is required, which can be done using the PLink tool which comes with the [[http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html|Putty] distribution.

Open a command prompt window and run PLink with the options
<pre>
plink.exe -N -L 10000:<IP-address of vis-node>:5901
</pre>
The you can need to start your VNC client and connect to the address localhost:10000.

== VirtualGL Setup (WITHOUT turbovnc) ==

To use VirtualGL you have to install it on your local client. It is available in the form of pre-compiled packages at [http://www.virtualgl.org/Downloads/VirtualGL http://www.virtualgl.org/Downloads/VirtualGL].

==== Linux ====
After the installation of VirtualGL you can connect to cl3fr1.hww.de via the vglconnect command. Please be aware that vglconnect uses the nettest binary on the remote side to determine a free port for  the VGL connection. Since on the hww machines, VGL is installed in a non standard path one has either to use the -bindir option or set the environment variable VGL_BINDIR on the client side to the correct directory. I.e. to connect to the vulcan front-ends please use the following commands:
<pre>
user@client>export VGL_BINDIR=/opt/hlrs/non-spack/2022-02/vis/VirtualGL/2.6.5/bin
user@client>vglconnect -s cl1fr3.hww.hlrs.de
</pre>
To prepare the visualisation queue job use the vis_via_vnc.sh script that is made available via the VirtualGL module.
<pre>
user@cl3fr1>module load VirtualGL
user@cl3fr1>vis_via_vnc.sh XX:XX:XX
</pre>
where XX:XX:XX is the walltime required for your visualisation job.

Once the job is running and the node is set up, the job-id as well as the node name are printed in front of the instructions on how to connect via vnc. To be able to connect to the reserved visualization node directly it is necessary to export the environment variable PBS_JOBID to the job-id of the corresponding queue job. I.e.:
<pre>
export PBS_JOBID=<job.no>.cl1intern
user@cl3fr1>vglconnect -s n<node.no>
</pre>

On the visualisation node you can then execute 64Bit GL applications with the VirtualGL wrapper command

<pre>
user@vis-node>module load VirtualGL
user@vis-node>vglrun <Application command>
</pre>