Difference between revisions of "HPG Interfaces"

From UFRC
Jump to navigation Jump to search
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
Back to [[Getting Started]]
 
Back to [[Getting Started]]
===Connecting to a HiPerGator Terminal via SSH===
 
To work on HiPerGator you will have to connect to hpg.rc.ufl.edu from your local computer either via SSH (terminal session) or via one of the web/application interfaces we provide such as [[Galaxy]], [[Open_OnDemand|Open OnDemand]], or [[Jupyter#JupyterHub|JupyterHub]]. You can also [[SSH Using VSCode]] to easily view and edit files, but remember to not run jobs on it, and use sbatch instead.
 
  
The default port 22 will require password authentication whereas port 2222 can be used for ssh key authentication.
+
You use Interfaces to interact with the system, manage data, initialize computation, and view the results. The main categories of interfaces 'Command-Line' also known as Terminal, Graphical User Interfaces, and Web Interfaces or applications for more specialized use.
 +
 
 +
=Connecting to HiPerGator=
 +
You can connect to a HiPerGator server on hpg.rc.ufl.edu from your local computer either via SSH (terminal session) or via one of the web/application interfaces we provide such as [[Galaxy]], [[Open_OnDemand|Open OnDemand]], or [[Jupyter#JupyterHub|JupyterHub]]. You can also [[SSH Using VSCode]] to easily view and edit files, but remember to not run jobs on it, and use sbatch instead.
 +
==SSH via a local Terminal (Command-Line)==
 +
The default port 22 will require password authentication whereas port 2222 can be used for [https://help.rc.ufl.edu/doc/Using_SSH_Keys_To_Access_HPG ssh key authentication].
  
 
Note that the UF security requirements include the use of [[Authentication_With_MFA|Multi-Factor Authentication]] when connecting to HiPerGator. See the [[SSH Multiplexing]] help if you are connecting from Linux or MacOS to reduce the frequency of MFA use.
 
Note that the UF security requirements include the use of [[Authentication_With_MFA|Multi-Factor Authentication]] when connecting to HiPerGator. See the [[SSH Multiplexing]] help if you are connecting from Linux or MacOS to reduce the frequency of MFA use.
Line 15: Line 18:
 
Since Microsoft Windows does not come with a built-in SSH client, you must download a client from the web.  
 
Since Microsoft Windows does not come with a built-in SSH client, you must download a client from the web.  
  
For University-managed computers [http://www.chiark.greenend.org.uk/~sgtatham/putty PuTTY], [https://tabby.sh/ Tabby], and [https://gitforwindows.org/ Git Bash] are approved for 'fast track' installations.
+
For University-managed computers [http://www.chiark.greenend.org.uk/~sgtatham/putty PuTTY], [https://tabby.sh/ Tabby], and [https://gitforwindows.org/ Git Bash] are approved for 'fast track' installations. You can also use [[Bitvise]] with our guide.
 
 
'''PuTTY'''
 
* [http://www.chiark.greenend.org.uk/~sgtatham/putty Download PuTTY] to your local machine and start the program.
 
* Connect to hpg.rc.ufl.edu.
 
* At the login prompt, enter your username (this should be the same as your GatorLink username)
 
* Enter your password when prompted. You are now connected and ready to work!
 
  
 
'''Tabby'''
 
'''Tabby'''
Line 29: Line 26:
 
   Host: hpg.rc.ufl.edu
 
   Host: hpg.rc.ufl.edu
 
   Username: <username>
 
   Username: <username>
  Password: "Set password" or "Add a private key"
+
* Keep Authentication on Auto and don't set a password, this will let the prompt work
 
* Click "Save"
 
* Click "Save"
* Click on the window icon "New tab with profile" and select "HiPerGator hpg.rc.ufl.edu"
+
* Click on the window icon "New tab with profile" and select "HiPerGator hpg.rc.ufl.edu". Success!
* You are now connected and ready to work!
+
 
 +
'''PuTTY'''
 +
* [http://www.chiark.greenend.org.uk/~sgtatham/putty Download PuTTY] to your local machine and start the program.
 +
* Connect to hpg.rc.ufl.edu.
 +
* At the login prompt, enter your username (this should be the same as your GatorLink username)
 +
* Enter your password when prompted. You are now connected and ready to work!
 +
 
 
</div>
 
</div>
 
</div>
 
</div>
Line 51: Line 54:
 
</div>
 
</div>
  
===Logging in via web browser===
+
==Logging in via web browser==
<div class="mw-collapsible mw-collapsed" style="width:70%; padding: 5px; border: 1px solid gray;">
+
====[[Open_OnDemand|Open OnDemand]]====
''Expand to view instructions for Logging in via web browser.''
+
To start a GUI application go to [https://ood.rc.ufl.edu https://ood.rc.ufl.edu] and choose the interactive application you would like to use, like RStudio or MatLab.
<div class="mw-collapsible-content" style="padding: 5px;">
+
 
* To start a GUI application go to [https://ood.rc.ufl.edu https://ood.rc.ufl.edu] and choose the application you would like to use, for example HiPerGator Desktop is a linux GUI.
+
* '''HiPerGator Desktop''' is a Linux Virtual Machine which allows users to run HPG GUI applications from a compute node.
**
+
 
** To start a Jupyter Notebook with OOD, select the “Jupyter Notebook” application server under the “Interactive Applications” tab on the main dashboard. Specify the resources you need in the resource request and click “Launch” at the bottom of the form. Once your job starts, click “Connect to Jupyter” to start your Notebook.
+
* '''Jupyter Notebook''' can be used via OOD by selecting the “Jupyter Notebook” application server under the “Interactive Applications” tab on the main dashboard. Specify the resources you need in the resource request and click “Launch” at the bottom of the form. Once your job starts, click “Connect to Jupyter” to start your Notebook.
*
+
 
* To start a Jupyter Notebook go to [http://jhub.rc.ufl.edu http://jhub.rc.ufl.edu] and select the resources you need. This JupyterHub server has preset resource options.
+
====JupyterHub====
**
+
JupyterHub is an alternative portal to start a Jupyter Notebook easily. It can be accessed on [http://jhub.rc.ufl.edu http://jhub.rc.ufl.edu] and has preset resource settings for each session, unlike OOD where you can customize technical parameters.
** Jupyterhub and OutOfMemory (OOM) – if your Notebook stops responding it might be an indication of the job running out of memory. Currently this does not produce an error message. You can check your <code>/home/<user>/</code>jupyter slurm spawner logs to be sure. You will need to restart the job with additional RAM.
+
* '''Note:''' Jupyterhub and OutOfMemory (OOM) – if your Notebook stops responding it might be an indication of the job running out of memory. Currently this does not produce an error message. You can check your <code>/home/<user>/</code>jupyter slurm spawner logs to be sure. You will need to restart the job with additional RAM.
*
+
 
* To start a Galaxy instance go to [https://galaxy.rc.ufl.edu/ https://galaxy.rc.ufl.edu/]. Galaxy is a web-based framework for accessible, reproducible, and transparent biological computing.
+
====Galaxy====
</div>
+
To start a Galaxy instance go to [https://galaxy.rc.ufl.edu/ https://galaxy.rc.ufl.edu/]. Galaxy is a web-based framework for accessible, reproducible, and transparent biological computing.
</div>
+
#</div>
 +
#</div>
  
 
===Invalid Password===
 
===Invalid Password===
If you have forgotten your password or need to change it, use the following link to set a new one: [https://my.ufl.edu/ps/signon.html Change or Reset Password]
+
If you forgot your password or need to change it, use the following link to set a new one: [https://my.ufl.edu/ps/signon.html Change or Reset Password]
  
'''NOTE''': Research Computing now uses Gatorlink Authentication for all passwords. Please use the UF Gatorlink password system for all password issues.
+
* '''NOTE''': Research Computing now uses Gatorlink Authentication for all passwords. Please use the UF Gatorlink password system for all password issues.
 
__NOTOC__
 
__NOTOC__

Latest revision as of 19:37, 22 April 2024

Back to Getting Started

You use Interfaces to interact with the system, manage data, initialize computation, and view the results. The main categories of interfaces 'Command-Line' also known as Terminal, Graphical User Interfaces, and Web Interfaces or applications for more specialized use.

Connecting to HiPerGator

You can connect to a HiPerGator server on hpg.rc.ufl.edu from your local computer either via SSH (terminal session) or via one of the web/application interfaces we provide such as Galaxy, Open OnDemand, or JupyterHub. You can also SSH Using VSCode to easily view and edit files, but remember to not run jobs on it, and use sbatch instead.

SSH via a local Terminal (Command-Line)

The default port 22 will require password authentication whereas port 2222 can be used for ssh key authentication.

Note that the UF security requirements include the use of Multi-Factor Authentication when connecting to HiPerGator. See the SSH Multiplexing help if you are connecting from Linux or MacOS to reduce the frequency of MFA use.

For any given command below, <username> should be replaced with the UFRC username (same as your GatorLink username).

Connecting from Windows

Expand this section to view instructions for logging in with Windows.

Since Microsoft Windows does not come with a built-in SSH client, you must download a client from the web.

For University-managed computers PuTTY, Tabby, and Git Bash are approved for 'fast track' installations. You can also use Bitvise with our guide.

Tabby

  • Download Tabby to your local machine: tabby-version#-setup.exe or tabby-version#-portable.zip for a portable version.
  • Start the program and click Settings > Profiles > +New profile > SSH connection
 Name: HiPerGator
 Host: hpg.rc.ufl.edu
 Username: <username>
  • Keep Authentication on Auto and don't set a password, this will let the prompt work
  • Click "Save"
  • Click on the window icon "New tab with profile" and select "HiPerGator hpg.rc.ufl.edu". Success!

PuTTY

  • Download PuTTY to your local machine and start the program.
  • Connect to hpg.rc.ufl.edu.
  • At the login prompt, enter your username (this should be the same as your GatorLink username)
  • Enter your password when prompted. You are now connected and ready to work!

Connecting from Linux and MacOS

Expand to view instructions for connecting from Linux or MacOS.

You may omit GatorLinkUsername if the username on your local computer matches your GatorLink username e.g.

Open a terminal and run

$ ssh <GatorLink Username>@hpg.rc.ufl.edu
or
$ ssh hpg.rc.ufl.edu

Enter your password when the prompt appears. You are now connected to a login node and your working directory will be /home/<GatorLink>, ready to work!

Logging in via web browser

Open OnDemand

To start a GUI application go to https://ood.rc.ufl.edu and choose the interactive application you would like to use, like RStudio or MatLab.

  • HiPerGator Desktop is a Linux Virtual Machine which allows users to run HPG GUI applications from a compute node.
  • Jupyter Notebook can be used via OOD by selecting the “Jupyter Notebook” application server under the “Interactive Applications” tab on the main dashboard. Specify the resources you need in the resource request and click “Launch” at the bottom of the form. Once your job starts, click “Connect to Jupyter” to start your Notebook.

JupyterHub

JupyterHub is an alternative portal to start a Jupyter Notebook easily. It can be accessed on http://jhub.rc.ufl.edu and has preset resource settings for each session, unlike OOD where you can customize technical parameters.

  • Note: Jupyterhub and OutOfMemory (OOM) – if your Notebook stops responding it might be an indication of the job running out of memory. Currently this does not produce an error message. You can check your /home/<user>/jupyter slurm spawner logs to be sure. You will need to restart the job with additional RAM.

Galaxy

To start a Galaxy instance go to https://galaxy.rc.ufl.edu/. Galaxy is a web-based framework for accessible, reproducible, and transparent biological computing.

Invalid Password

If you forgot your password or need to change it, use the following link to set a new one: Change or Reset Password

  • NOTE: Research Computing now uses Gatorlink Authentication for all passwords. Please use the UF Gatorlink password system for all password issues.