Differences

This shows you the differences between two versions of the page.

--- software:paraview:farber [2020-08-05 16:41] – [Running ParaView GUI on Farder] mkyle
+++ software:paraview:farber [2021-04-06 20:08] (current) – anita
@@ Line 4: / Line 4: @@
 Below is the list of ParaView version available on Farber as of August 2020. The current default version is 4.1.0
 <code>
-[mkyle@farber ~]$ vpkg_versions paraview
+[traine@farber ~]$ vpkg_versions paraview
 Available versions in package (* = default version):
@@ Line 16: / Line 16: @@
 </code>
-==== Running ParaView GUI on Farder ===
+==== Setting up ParaView with GUI on Farber ====
-<note tip>The following example will use the user of //traine//. The //traine// user account will have to substituted for your usename. </note>
+To use ParaView with a GUI on Farber a couple of steps have to be taken. You will need to load the software into your environment, set up the SSH tunnel for VNC to use, and connect to ParaView with VNC software.
+Working with ParaView in this method is useful because it creates a more resilient work environment. With this setup if you lose your connection to the network, you will not lose your work. You simple just need to setup the tunnel again and connect with VNC. After completing those steps, you will find your work just as you left it, prior to losing your connection. It is also important that you properly exit ParaView when you are done using it, so that it releases the shared resources.
+<note tip>
+The following example will use the account //traine//, so you will need to substitute your username when you perform the steps.
+</note>
+=== Loading ParaView ===
-To use ParaView with a GUI on Farber a script has been created to run ParaView with vnc. The below steps will set up load the ParaView software into your environment. Then set run the vnc scripts which will setup ParaView's GUI to run with VNC.
+The below steps will load the ParaView software into your environment.
 <code>
@@ Line 29: / Line 37: @@
 Adding package `paraview/5.8.0` to your environment
 (/opt/shared/paraview/5.8.0) [traine@farber ~]
-(/opt/shared/paraview/5.8.0) [traine@farber ~]paraview-vnc
+</code>
+Now you can run the VNC script ''paraview-vnc'' to setup ParaView's GUI to run with VNC.
+<code>
+(/opt/shared/paraview/5.8.0) [traine@farber ~]$ paraview-vnc
 New 'login000:1 (traine)' desktop is login000:1
@@ Line 48: / Line 61: @@
 </code>
-<note important>You will only be asked to set up your password the first time you run paraview-vnc. Remember that password as you will need to use it to login into your VNC sessions for paraview in the feature. </note>
+<note important>
+You will only be asked to set up your password the first time you run ''paraview-vnc''. This should **NOT** be your login password! This mechanism only deters unauthorized connections; it is not fully secure, as only the first eight characters of the password are saved. Make sure to remember that password as you will need to use it to login into your VNC sessions for ParaView in the future. If you forget your password then you can use the ''vncpasswd'' command to reset your password.
+</note>
-The base port for VNC is 5900, add your display number :1 (that can be found in the above code segment) and we get 5901.
+The base port for VNC is 5900, add your display number '':1'' (that can be found in the above code segment) and we get 5901.
-After running the //paraview-vnc// the GUI you will need to set up tunnel. The steps on how to do this will are shown below for the PuTTY SSH client and Linux/Mac Terminals.
+=== Setting up SSH Tunuel for VNC Connection ===
+After running ''paraview-vnc'' you will need to set up a SSH tunnel. The steps on how to do this are shown below for Windows (PuTTY) and Linux/Mac Terminals.
-==PuTTY==
+==Windows (PuTTY)==
 Open PuTTY
-In addition to your standard connection PuTTY settings you will need to set up the tunnel settings. The image below shows you how this in done in PuTTY. The tunnel setting are found under the Category //Connection --> SSH --> Tunnels//
+In addition to your standard connection PuTTY settings you will need to set up the tunnel settings. The image below shows you how this in done in PuTTY. The tunnel setting are found under the Category //Connection -> SSH -> Tunnels//
-{{ :software:paraview:puttytunnel.jpg?400 |}}
+{{ :software:paraview:farber_tunnel.jpg?400 | Farber Tunnel}}
-After you add this setting to your session you can save them or just open the session. You will have to leave this session open and open a VNC Client software to start the ParaView GUI on your system.
+Add the "Source port" and "Destination" as shown in the image above and click the "Add" button. After you add this setting to your session you can save them or just open the session. You will have to leave this session open and open a VNC viewer (client) software to start the ParaView GUI on your system.
 ==Linux/Mac==
 Open a new terminal session on your local machine. Set up a SSH Tunnel using the below //ssh// command.
@@ Line 66: / Line 82: @@
 <code>
-$ ssh -L 5901:localhost:5901 mkyle@farber.hpc.udel.edu
+$ ssh -L 5901:localhost:5901 traine@farber.hpc.udel.edu
 ............................................................
@@ Line 82: / Line 98: @@
 ............................................................
-[mkyle@farber ~]$
+[traine@farber ~]$
 </code>
-With that SSH tunnel active, my MacBook port 5901 is logically mirroring port 5901 on farber. Now you can open a VNC client on your local machine that views the Paraview VNC display (e.g. command-K in the Finder, use URL "vnc:%%//%%localhost:5901").
+<note important>
+Make sure that you leave this tunnel SSH session open and running in the background. If you close out of it, then you will not be able to connect ParaView on Farber with the VNC viewer (client) software.
+</note>
-{{ :software:paraview:paraview_gui.jpg?400 |}}
+=== Setting Up VNC ===
+Now ParaView is running on port 5901 on Farber. A SSH tunnel is connected on your local machine port 5901 and it is mirroring port 5901 on Farber. The last step is to set up your VNC viewer (client) to connect to ParaView on port 5901. These are general steps that should apply to any operating system.
+  * Open a VNC viewer (client) software.
+  * Add a new connection to localhost:5901
+<note tip>
+If you don't have a VNC viewer (client) software you can visit [[https://www.realvnc.com/en/connect/download/viewer/|REAL VNC Viewer]]. There you can find software downloads for many popular operating systems, and directions on how to install it.
+</note>
+=== Connecting to Paraview GUI with VNC ===
+Once the VNC connection is created you can use it to open the ParaView GUI. When connecting you will be asked for a password. This password is the one you set the first time you ran ''paraview-vnc''. Once you enter the password, ParaView should open and you can begin working.
+{{ :software:paraview:paraview_gui.jpg?400 | Example ParaView GUI }}
 <note warning>
-This step will run ParaView on a login node. Login nodes have limits resources, and are shared with all users. It's important that once you are done using ParaView that you should close out of the program to free up its resources. If you leave it running to long it could be killed by the IT-RCI sysadmin.
+This step will run ParaView on a login node. Login nodes have limited resources, and are shared with all users. It's important that once you are done using ParaView that you should close out of the program to free up its resources. If you leave it running too long, then it may be killed by the IT-RCI sysadmin.
 </note>
-==== Close ParaView GUI on Farder ===
+==== Close ParaView GUI on Farber ===
+It is very important to correctly close out of ParaView when you are done working with it. If ParaView is not closed correctly, then it could continue to use computational resources. To quit ParaView, in the GUI click //File//->//Exit//. This will close ParaView running in your VNC viewer and exit Paraview running on Farber. After that you can close your SSH tunnel connection to Farber.
+{{ :software:paraview:closeparaview.jpg?400 | Quit ParaView}}