Difference between revisions of "X"

From Storrs HPC Wiki
Jump to: navigation, search
(Update for Windows instructions.)
(Installation)
 
(24 intermediate revisions by 6 users not shown)
Line 1: Line 1:
We have setup our HORNET cluster to run graphical applications using [http://x2go.org/ x2go].
+
We have setup our HPC Cluster to run graphical applications using [http://x2go.org/ x2go].
 
x2go is a fast remote desktop manager that allows you to reconnect and continue working with graphical applications even if your work is interrupted by network issues.
 
x2go is a fast remote desktop manager that allows you to reconnect and continue working with graphical applications even if your work is interrupted by network issues.
 
You can close your session and continue exactly where you left off whenever you want (just like you would be able to with a command-line equivalent like [http://directory.fsf.org/wiki/Tmux tmux]).
 
You can close your session and continue exactly where you left off whenever you want (just like you would be able to with a command-line equivalent like [http://directory.fsf.org/wiki/Tmux tmux]).
  
We generally, recommend against running any sort of graphical applications on the HORNET login nodes since graphical applications consume much more resources and is impolite to other users.
+
We generally, recommend against running any sort of graphical applications on the HPC login nodes since graphical applications consume much more resources and is impolite to other users sharing the login node.
 
However there are a few cases where using x2go is necessary.
 
However there are a few cases where using x2go is necessary.
The main reason is to run proprietary [[:Category:Software|software applications]] that have no command-line interface and only provide a graphical interface. Inside x2go these applications must be run using [[SLURM_Guide#Interactive|fisbatch]].
+
The main reason is to run proprietary [[:Category:Software|software applications]] that have no command-line interface and only provide a graphical interface.
 +
Inside x2go these applications must be run using [[SLURM_Guide#Interactive|fisbatch]].
  
 
== Installation ==
 
== Installation ==
  
 
For GNU / Linux, OS X and Windows, follow the instructions on the [http://wiki.x2go.org/doku.php/doc:installation:x2goclient x2go wiki].
 
For GNU / Linux, OS X and Windows, follow the instructions on the [http://wiki.x2go.org/doku.php/doc:installation:x2goclient x2go wiki].
 +
 +
The newest install of X2Go 4.1.2.2 has a bug on the Windows OS, which prevents the software from being loaded and causes it to crash. Please download a previous version located on the installing X2Go page on their website and perform the following steps:
 +
#click the X2Go client link
 +
#click the Older Versions link
 +
#releases folder
 +
#select an older release to download the .exe file.
  
 
== Configuration ==
 
== Configuration ==
Line 18: Line 25:
 
-->If you do not see this window, click on Session > New session ...
 
-->If you do not see this window, click on Session > New session ...
 
# Enter the following:
 
# Enter the following:
## Host: hornet-login1.engr.uconn.edu
+
## Host: login1.storrs.hpc.uconn.edu
 
## Login: <Your NetID>
 
## Login: <Your NetID>
## (At the very bottom) Session type: GNOME
+
## (At the very bottom) Session type: Single Application
## (If you have <code>~/.ssh/authorized_keys</code> setup) Check the box for "Try auto login (ssh-agent of default ssh key)"
+
## (On that same line) Type in <code>fisbatch-launcher</code>.
## Click OK
+
## (If you [[SSH_on_Windows#Login_with_SSH_keys|created your key pair]], otherwise leave this field blank) In the "Use RSA/DSA key for ssh connection" click the folder icon, then your ".ssh" folder and then your "id_rsa" private key.
# A new box will appear on the top-right hand side of x2go showing your connection settings.
+
## Click OK to save your new session settings
 +
# A new grey box will appear on the top-right hand side of x2go showing your connection settings.
 +
[[File:X2go-settings-annotated.png]]
  
 
== Usage ==
 
== Usage ==
  
 
=== Starting a session ===
 
=== Starting a session ===
# Run x2goclient and click the gray "New session" box at the top-right and login with your HORNET credentials.
+
# Run x2goclient and click the gray "New session" box at the top-right and login with your HPC credentials.
 
# If this is your first time logging in, click "Yes" in the a message "Host key verification failed: The server is unknown. Do you trust the host key?"
 
# If this is your first time logging in, click "Yes" in the a message "Host key verification failed: The server is unknown. Do you trust the host key?"
# The status message will change from "connecting" to "running" and after a few seconds you will see a new window with your desktop appear.
+
# The status message will change from "connecting" to "running" and after a few seconds you will see a new Terminal window appear.
# To run your software, at the top-left side of the screen, click on "Applications" > "System Tools" > "Terminal".
 
 
# Inside the terminal, start [[SLURM_Guide#Interactive|fisbatch]] to reserve your compute nodes, and then you can run your interactive job.
 
# Inside the terminal, start [[SLURM_Guide#Interactive|fisbatch]] to reserve your compute nodes, and then you can run your interactive job.
  
 
=== Pausing and resuming a session===
 
=== Pausing and resuming a session===
# By default, if you close either your running desktop window or the x2goclient window, the session will pause.
+
# If you want to resume your session at a later time, simply close the X2Go Client window (not the Terminal or your application software!)  You can also explicitly pause the session in the X2Go Client window using the pause button at the bottom of the gray session box.
 
# Now when you log in the next time you can pick up where you left off.
 
# Now when you log in the next time you can pick up where you left off.
  
 
=== Terminate session ===
 
=== Terminate session ===
# To terminate your session and start from scratch later, in the main x2go window you will see a power button at the bottom-right side of the gray session box.
+
# To terminate your session and start over later, in the main X2Go Client window you will see a power button at the bottom-right side of the gray session box.
 
# Click on the button acknowledge the warning about unsaved documents being lost.
 
# Click on the button acknowledge the warning about unsaved documents being lost.
 +
 +
[[File:X2go-session-box-annotated.png]]
 +
 +
== Troubleshooting ==
 +
 +
=== OS X: Black screen after connecting ===
 +
Please make sure you have installed [http://wiki.x2go.org/doku.php/doc:installation:x2goclient#os_x XQuartz as explained in the x2go installation docs].
 +
 +
'''Notice''': Some of modules do not compatible with the latest version of XQuartz, please check the exceptions below:
 +
1. Please use XQuartz 2.7.8 when you use Ansys/17.1.EM
  
 
[[Category:Core]]
 
[[Category:Core]]

Latest revision as of 09:04, 20 August 2020

We have setup our HPC Cluster to run graphical applications using x2go. x2go is a fast remote desktop manager that allows you to reconnect and continue working with graphical applications even if your work is interrupted by network issues. You can close your session and continue exactly where you left off whenever you want (just like you would be able to with a command-line equivalent like tmux).

We generally, recommend against running any sort of graphical applications on the HPC login nodes since graphical applications consume much more resources and is impolite to other users sharing the login node. However there are a few cases where using x2go is necessary. The main reason is to run proprietary software applications that have no command-line interface and only provide a graphical interface. Inside x2go these applications must be run using fisbatch.

Installation

For GNU / Linux, OS X and Windows, follow the instructions on the x2go wiki.

The newest install of X2Go 4.1.2.2 has a bug on the Windows OS, which prevents the software from being loaded and causes it to crash. Please download a previous version located on the installing X2Go page on their website and perform the following steps:

  1. click the X2Go client link
  2. click the Older Versions link
  3. releases folder
  4. select an older release to download the .exe file.

Configuration

Configure the connection settings as follows:

  1. Run x2goclient
  2. When you run x2go for the first time, it shows you a "New session" window. If you do not see this window, click on Session > New session ...
  3. Enter the following:
    1. Host: login1.storrs.hpc.uconn.edu
    2. Login: <Your NetID>
    3. (At the very bottom) Session type: Single Application
    4. (On that same line) Type in fisbatch-launcher.
    5. (If you created your key pair, otherwise leave this field blank) In the "Use RSA/DSA key for ssh connection" click the folder icon, then your ".ssh" folder and then your "id_rsa" private key.
    6. Click OK to save your new session settings
  4. A new grey box will appear on the top-right hand side of x2go showing your connection settings.

X2go-settings-annotated.png

Usage

Starting a session

  1. Run x2goclient and click the gray "New session" box at the top-right and login with your HPC credentials.
  2. If this is your first time logging in, click "Yes" in the a message "Host key verification failed: The server is unknown. Do you trust the host key?"
  3. The status message will change from "connecting" to "running" and after a few seconds you will see a new Terminal window appear.
  4. Inside the terminal, start fisbatch to reserve your compute nodes, and then you can run your interactive job.

Pausing and resuming a session

  1. If you want to resume your session at a later time, simply close the X2Go Client window (not the Terminal or your application software!) You can also explicitly pause the session in the X2Go Client window using the pause button at the bottom of the gray session box.
  2. Now when you log in the next time you can pick up where you left off.

Terminate session

  1. To terminate your session and start over later, in the main X2Go Client window you will see a power button at the bottom-right side of the gray session box.
  2. Click on the button acknowledge the warning about unsaved documents being lost.

X2go-session-box-annotated.png

Troubleshooting

OS X: Black screen after connecting

Please make sure you have installed XQuartz as explained in the x2go installation docs.

Notice: Some of modules do not compatible with the latest version of XQuartz, please check the exceptions below: 
1. Please use XQuartz 2.7.8 when you use Ansys/17.1.EM