Difference between revisions of "CIRCE/SC Desktop"

 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
= CIRCE/SC Desktop Environment =
Click the appropriate link below to access the Desktop Environment page for the cluster of your choice:


For users wishing to connect to the CIRCE/SC clusters via a remote graphical desktop, RC provides this functionality via the program X2Go. X2Go has free-to-use clients that work with all 3 major operating systems (Windows, MacOS, and Linux). A short description and guide for X2Go is provided below.
* [[CIRCE Desktop Environment]]
 
* [[RRA Desktop Environment]]
'''WARNING''': Memory or CPU-intensive processes will be terminated. Such processes are defined as those that consume greater than 1GB of memory, heavily utilize the CPU for more than 30 minutes, or utilize more than one CPU either through threads or MPI. These processes should be  [[Guide to SLURM|submitted to the batch queue via SLURM]]. Repeated abuse of the login nodes for these purposes will result in account suspension.
* [[SC Desktop Environment]]
 
== What is X2Go? ==
 
X2Go is a Remote Desktop solution, which some vendors vaguely call remote access or control. This is not to be confused with Microsoft Remote Desktop Connection, which is a competing Remote Desktop solution and protocol. X2Go enables you to access a graphical desktop of a computer over a low bandwidth (or high bandwidth) connection. This method also uses either the MATE or GNOME desktop environments to provide access to CIRCE/SC and its applications. Advanced users can also configure X2Go to launch individual applications (e.g. xterm or MatLAB) without the entire desktop window.
 
== Installing the X2Go Client ==
 
In order to use X2Go, you will need to install the X2Go Client on your desktop or workstation. Please click the appropriate link for X2Go for your operating system:
 
* [https://code.x2go.org/releases/binary-win32/x2goclient/releases/4.1.2.0-2018.06.22/x2goclient-4.1.2.0-2018.06.22-setup.exe Windows (v4.1.2.0)]
** '''Note:''' For Windows, you '''must''' use v4.1.2.0 to connect to CIRCE/SC!
* [http://code.x2go.org/releases/X2GoClient_latest_macosx_10_11.dmg Mac OSX 10.11 and higher]
* [http://code.x2go.org/releases/X2GoClient_latest_macosx_10_13.dmg Mac OSX 10.13 and higher]
* [https://wiki.x2go.org/doku.php/doc:installation:x2goclient#ubuntu_debian Ubuntu/Debian]
* [https://wiki.x2go.org/doku.php/doc:installation:x2goclient#redhat Red Hat]
* [https://wiki.x2go.org/doku.php/doc:installation:x2goclient#fedora Fedora]
 
 
 
For all operating systems, the directions for install are available from the vendor website:
 
* [http://wiki.x2go.org/doku.php/doc:installation:x2goclient Installing the X2Go Client]
** Please read and understand all instructions related to your OS ''before'' getting started.
 
= Connecting to CIRCE via X2Go =
 
== Setting up a Graphical Desktop Session ==
 
=== Configuring X2Go ===
 
When you first log into CIRCE via X2Go, you will begin a new session. A session provides a full desktop environment and will include any applications you launch while you are logged in. This will not include any programs running in the queue.
 
==== Session Settings ====
 
Enter the host <code>circe.rc.usf.edu</code> . You will also enter your USF NetID next to “Login” and leave the “SSH Port” as 22. Then, set the “Session type” to '''MATE''' from the drop down list. Use the below image as a guide.
 
[[File:Circe desktop 01 session.PNG]]
 
==== Connection Settings ====
 
You can tailor the connection speed to fit your network type, but the default ADSL is fine for most connections, and may eliminate some issues with latency. The 4k-png compression method has been the most stable in testing, while providing reasonable resolution. Tinker at your own risk!
 
[[File:Circe desktop 02 connection.PNG]]
 
==== Input/Output Settings ====
 
For Display settings, select "Custom", and start with size 1024x768. Additionally, the Display can be adjusted to “Fullscreen”, “Use whole display” for multiple monitor setups, or adjusted to whatever size you like. '''Important''': Most user will want to ''uncheck'' the box for “Set display DPI”. See image below. Leaving this active may cause some applications to display improperly.
 
[[File:Circe desktop 03 io.PNG]]
 
==== Media Settings ====
 
Sound and printing can be turned off to improve speed and stability. Most other settings can be left as the default.
 
[[File:Circe desktop 04 media.PNG]]
 
==== Shared Folders Settings ====
 
The "Shared Folders" tab can remain as the default, shown below:
 
[[File:Circe desktop 05 shared-folders.PNG]]
 
 
=== Logging In ===
 
Select the appropriate box on the right side of the X2Go window representing your CIRCE session. You should be prompted for your NetID password.
 
Upon selecting OK, a new connection will be initiated. It can take several seconds for the desktop to initialize, so please be patient.
 
Mac users may need to open the desktop settings once X2Go is running, and disable all keyboard shortcuts on the Linux system. It seems there is a bug which may cause X2Go to think the “Super Key” is continually pressed.
 
=== Minimizing from Fullscreen Mode ===
 
Active X2Go windows can be minimized to the background without closing the session. The method varies by OS.
 
* '''Windows:''' Using Alt+Tab to switch windows will place X2Go in the background.
* '''Linux:''' Using Ctrl+Alt+m will minimize X2Go to the panel. On some systems, you can mouse-over or click in the very top right corner of the screen (if you are using hot-corners).
* '''Mac:''' Using the top Mac menu.
 
=== Ending a Session ===
 
Sessions can be ended by logging out (going to <code>System-&gt;Logoff</code> in the top tool bar).
* '''NOTE:''' Please do not click the X in the upper-right-hand corner to exit, as this will suspend your session and not exit.
 
=== Suspending Sessions ===
 
Session suspension and resume is not fully supported. All new connections may or may not restore previous sessions regardless of whether you attempted to suspend an existing session currently open. Plan accordingly.
 
== Setting up an Xterm-only Session ==
 
=== Configuring X2Go ===
 
For those users who wish to only have an Xterm-only connection (and not a full Graphical Desktop) to CIRCE for GUI-based applications . To do so, please configure all tabs as shown above, except configure the "Session" tab as shown below:
 
[[File:Circe xterm session.PNG]]
 
=== Logging In ===
 
Select the appropriate box on the right side of the X2Go window representing your CIRCE session. You should be prompted for your NetID password.
 
Upon selecting OK, a new connection will be initiated. It can take several seconds for the Xterm window to initialize, so please be patient.
 
=== Ending a Session ===
 
Once completed, just type "exit" at the terminal prompt to exit the Xterm session.
 
= Connecting to SC via X2Go =
 
== Setting up a Graphical Desktop Session ==
 
=== Configuring X2Go ===
 
When you first log into SC via X2Go, you will begin a new session. A session provides a full desktop environment and will include any applications you launch while you are logged in. This will not include any programs running in the queue.
 
==== Session Settings ====
 
Enter the host <code>sc.rc.usf.edu</code> . You will also enter your USF NetID next to “Login” and leave the “SSH Port” as 22. Then, set the “Session type” to '''GNOME''' from the drop down list. Use the below image as a guide.
 
[[File:Sc desktop 01 session.PNG]]
 
==== Connection Settings ====
 
You can tailor the connection speed to fit your network type, but the default ADSL is fine for most connections, and may eliminate some issues with latency. The 4k-png compression method has been the most stable in testing, while providing reasonable resolution. Tinker at your own risk!
 
[[File:Sc desktop 02 connection.PNG]]
 
==== Input/Output Settings ====
 
For Display settings, select "Custom", and start with size 1024x768. Additionally, the Display can be adjusted to “Fullscreen”, “Use whole display” for multiple monitor setups, or adjusted to whatever size you like. '''Important''': Most user will want to ''uncheck'' the box for “Set display DPI”. See image below. Leaving this active may cause some applications to display improperly.
 
[[File:Sc desktop 03 io.PNG]]
 
==== Media Settings ====
 
Sound and printing can be turned off to improve speed and stability. Most other settings can be left as the default.
 
[[File:Sc desktop 04 media.PNG]]
 
==== Shared Folders Settings ====
 
The "Shared Folders" tab can remain as the default, shown below:
 
[[File:Sc desktop 05 shared-folders.PNG]]
 
=== Logging In ===
 
Select the appropriate box on the right side of the X2Go window representing your SC session. You should be prompted for your NetID password.
 
Upon selecting OK, the a new connection will be initiated. It can take several seconds for the desktop to initialize, so please be patient.
 
Mac users may need to open the desktop settings once X2Go is running, and disable all keyboard shortcuts on the Linux system. It seems there is a bug which may cause X2Go to think the “Super Key” is continually pressed.
 
=== Minimizing from Fullscreen Mode ===
 
Active X2Go windows can be minimized to the background without closing the session. The method varies by OS.
 
* '''Windows:''' Using Alt+Tab to switch windows will place X2Go in the background.
* '''Linux:''' Using Ctrl+Alt+m will minimize X2Go to the panel. On some systems, you can mouse-over or click in the very top right corner of the screen (if you are using hot-corners).
* '''Mac:''' Using the top Mac menu.
 
=== Ending a Session ===
 
Sessions can be ended by logging out (going to <code>System-&gt;Logoff</code> in the top tool bar).
* '''NOTE:''' Please do not click the X in the upper-right-hand corner to exit, as this will suspend your session and not exit.
 
=== Suspending Sessions ===
 
Session suspension and resume is not fully supported. All new connections may or may not restore previous sessions regardless of whether you attempted to suspend an existing session currently open. Plan accordingly.
 
== Setting up an Xterm-only Session ==
 
=== Configuring X2Go ===
 
For those users who wish to only have an Xterm-only connection (and not a full Graphical Desktop) to SC for GUI-based applications . To do so, please configure all tabs as shown above, except configure the "Session" tab as shown below:
 
[[File:Sc xterm session.PNG]]
 
=== Logging In ===
 
Select the appropriate box on the right side of the X2Go window representing your SC session. You should be prompted for your NetID password.
 
Upon selecting OK, a new connection will be initiated. It can take several seconds for the Xterm window to initialize, so please be patient.
 
=== Ending a Session ===
 
Once completed, just type "exit" at the terminal prompt to exit the Xterm session.

Latest revision as of 20:13, 22 February 2021

Click the appropriate link below to access the Desktop Environment page for the cluster of your choice: