HPC Cluster Getting Started: Difference between revisions
No edit summary |
|||
| (14 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
== How Do I "Activate" My TCNJ Account on the Cluster == | == How Do I "Activate" My TCNJ Account on the Cluster == | ||
Activating your account creates some critical files that are needed before you can use the cluster. '''This only need to be done once.''' It | Activating your account creates some critical files that are needed before you can use the cluster. '''This only need to be done once.''' It establishes your HPC ''home directory'' which is a space for you to store your personal files, programs and their configurations. It also creates SSH keys which are used by to encrypt network traffic between computers. | ||
#To begin, point your web browser to https://ondemand.hpc.tcnj.edu | #To begin, point your web browser to https://ondemand.hpc.tcnj.edu | ||
#Provide your TCNJ | #Provide your TCNJ email address and password when prompted | ||
#If you've never logged into the cluster before, you will need to follow the on-screen instructions to setup your home directory. | #If you've never logged into the cluster before, you will need to follow the on-screen instructions to setup your home directory. | ||
##Click the '''Open Shell to create home directory''' link. This will open a new browser tab with a terminal window | ##Click the '''Open Shell to create home directory''' link. This will open a new browser tab with a terminal window | ||
##Provide your TCNJ password again when prompted | ##Provide your TCNJ password again when prompted. '''Note:''' there is no feedback (e.g. asterisks) as you type your password. Make sure to press the <code>ENTER</code> or <code>RETURN</code> button on your keyboard after entering your password. | ||
##After some text is | ##After some text is displayed, type <code>exit</code> and then press the <code>ENTER</code> or <code>RETURN</code> button on your keyboard | ||
##Close just the terminal window browser tab | ##Close just the terminal window browser tab | ||
#Back at the original browser tab, click the '''Restart Web Server''' link. | #Back at the original browser tab, click the '''Restart Web Server''' link. | ||
#After a few seconds you should see the Open OnDemand main dashboard. If you get the '''Home directory not found''' page again, wait 30 seconds before clicking the '''Restart Web Server''' link again. | #After a few seconds you should see the Open OnDemand main dashboard. If you get the '''Home directory not found''' page again, wait 30 seconds before clicking the '''Restart Web Server''' link again. | ||
'''Note: Video shows old login method. New login method requires using your TCNJ email address and TCNJ password. The remainder of the video is still accurate.''' | |||
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=Iodd8Bs_SgM</embedvideo> | <embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=Iodd8Bs_SgM</embedvideo> | ||
== Accessing the Cluster via Open OnDemand == | == Accessing the Cluster via Open OnDemand == | ||
Once you have activated your account, you can use the web portal to access common functions on the cluster. This web portal is called Open OnDemand and can be accessed at https://ondemand.hpc.tcnj.edu/ from an on-campus (wired or wireless) computer or from off-campus | Once you have activated your account, you can use the web portal to access common functions on the cluster. This web portal is called Open OnDemand and can be accessed at https://ondemand.hpc.tcnj.edu/ from an on-campus (wired or wireless) computer or from off-campus (TCNJ VPN not required). Use your existing TCNJ email address and password when prompted. To logout of Open OnDemand, you must fully quit your browser. It is recommended that you open the OnDemand portal in a Private or Incognito browser window. | ||
== Accessing the Cluster via SSH == | == Accessing the Cluster via SSH == | ||
| Line 31: | Line 30: | ||
To access a Linux terminal using Open OnDemand, follow these steps: | To access a Linux terminal using Open OnDemand, follow these steps: | ||
# Login to Open OnDemand at https://ondemand.hpc.tcnj.edu/ using your TCNJ | # Login to Open OnDemand at https://ondemand.hpc.tcnj.edu/ using your TCNJ email address (in all lowercase) and TCNJ password | ||
# Choose '''Clusters''' from the menu | # Choose '''Clusters''' from the menu | ||
# Select '''>_ELSA | # Select '''>_ELSA OpenHPC Cluster Shell Access''' | ||
This will open a new tab or window and drop you at the Linux command-line in your cluster home directory. When done using the terminal, type <code>exit</code> before closing the terminal tab/window. | This will open a new tab or window and drop you at the Linux command-line in your cluster home directory. When you are done using the terminal, type <code>exit</code> before closing the terminal tab/window. | ||
'''Note: Video shows old login method. New login method requires using your TCNJ email address and TCNJ password. Some menu options may also appear different.''' | |||
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=rR8A3YF93Mw</embedvideo> | <embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=rR8A3YF93Mw</embedvideo> | ||
| Line 56: | Line 57: | ||
=== Using Open OnDemand via a Web Browser === | === Using Open OnDemand via a Web Browser === | ||
'''Note: Video shows old login method. New login method requires using your TCNJ email address and TCNJ password. Some menu options may also appear different.''' | |||
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=hcaYF_89rK0</embedvideo> | <embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=hcaYF_89rK0</embedvideo> | ||
Latest revision as of 13:29, 29 May 2024
Who Is Eligible for Access to the ELSA HPC Cluster
Use of the ELSA HPC cluster is limited to School of Science faculty and invited faculty from other TCNJ schools; TCNJ students who are required to use the cluster for coursework or mentored research; and collaborators from other institutions who have been sponsored by a TCNJ faculty for access. Those that do not meet the stated criteria may request access by emailing their proposal to hpc@tcnj.edu. TCNJ reserves the right to limit cluster resources (e.g. simultaneous active jobs, CPU core count, GPU usage, storage space, etc.) in order to maintain continued operations.
Your existing TCNJ login and password are used to access the ELSA HPC cluster and activate your cluster account.
How Do I "Activate" My TCNJ Account on the Cluster
Activating your account creates some critical files that are needed before you can use the cluster. This only need to be done once. It establishes your HPC home directory which is a space for you to store your personal files, programs and their configurations. It also creates SSH keys which are used by to encrypt network traffic between computers.
- To begin, point your web browser to https://ondemand.hpc.tcnj.edu
- Provide your TCNJ email address and password when prompted
- If you've never logged into the cluster before, you will need to follow the on-screen instructions to setup your home directory.
- Click the Open Shell to create home directory link. This will open a new browser tab with a terminal window
- Provide your TCNJ password again when prompted. Note: there is no feedback (e.g. asterisks) as you type your password. Make sure to press the
ENTERorRETURNbutton on your keyboard after entering your password. - After some text is displayed, type
exitand then press theENTERorRETURNbutton on your keyboard - Close just the terminal window browser tab
- Back at the original browser tab, click the Restart Web Server link.
- After a few seconds you should see the Open OnDemand main dashboard. If you get the Home directory not found page again, wait 30 seconds before clicking the Restart Web Server link again.
Note: Video shows old login method. New login method requires using your TCNJ email address and TCNJ password. The remainder of the video is still accurate.
Accessing the Cluster via Open OnDemand
Once you have activated your account, you can use the web portal to access common functions on the cluster. This web portal is called Open OnDemand and can be accessed at https://ondemand.hpc.tcnj.edu/ from an on-campus (wired or wireless) computer or from off-campus (TCNJ VPN not required). Use your existing TCNJ email address and password when prompted. To logout of Open OnDemand, you must fully quit your browser. It is recommended that you open the OnDemand portal in a Private or Incognito browser window.
Accessing the Cluster via SSH
Sometimes you need to directly access the Linux command-line on the HPC cluster to manage files or submit jobs. In order to do so, use one of the methods below depending on your local operating system.
Open OnDemand
Open OnDemand offers a web-based SSH client that works computers running Windows and Mac operating systems. Firefox or Chrome are the recommended web browsers to use.
To access a Linux terminal using Open OnDemand, follow these steps:
- Login to Open OnDemand at https://ondemand.hpc.tcnj.edu/ using your TCNJ email address (in all lowercase) and TCNJ password
- Choose Clusters from the menu
- Select >_ELSA OpenHPC Cluster Shell Access
This will open a new tab or window and drop you at the Linux command-line in your cluster home directory. When you are done using the terminal, type exit before closing the terminal tab/window.
Note: Video shows old login method. New login method requires using your TCNJ email address and TCNJ password. Some menu options may also appear different.
MacOS
MacOS (aka Mac OS X) already has a built-in SSH capable terminal program. It can be accessed by going to Applications > Utilities > Terminal or by clicking the search icon and typing terminal. If you will be a frequent user of the Terminal application, it is suggested that you add it (i.e. drag it) to your application dock for easy access in the future.
Microsoft Windows
Windows, unfortunately, doesn't seem to include an SSH terminal program with the base operating system. You will need to download one from the Internet. The two applications below are the most popular.
- MobaXterm (recommended) - Download site (use Home Edition) | Installation video
- PuTTY - Download site | Installation video
Launch MobaXterm or PuTTY and connect to the cluster. Use elsa.hpc.tcnj.edu when prompted for a hostname, and use your TCNJ username and password when prompted for credentials. The video below shows you how to use MobaXterm to connect to the HPC cluster.
Transferring Files To and From the Cluster
Using MobaXterm on Microsoft Windows
Using Filezilla on MacOS
Using Open OnDemand via a Web Browser
Note: Video shows old login method. New login method requires using your TCNJ email address and TCNJ password. Some menu options may also appear different.