HPC Cluster Getting Started: Difference between revisions

From HPC Docs
Jump to navigation Jump to search
No edit summary
 
(24 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Who Is Eligible for Access to the ELSA HPC Cluster ==
== 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. Access for those that do not meet the stated criteria may request access by emailing 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.
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.
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 ==
== 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 estabishes 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.  
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://elsa.hpc.tcnj.edu:4200/.  This step needs to be done from an on-campus computer (wired or wireless) or from an off-campus computer utilizing the [https://tcnj.teamdynamix.com/TDClient/KB/ArticleDet?ID=17531 TCNJ VPN].
#To begin, point your web browser to https://ondemand.hpc.tcnj.edu
# At the '''elsa login:''' prompt, enter your TCNJ username (in all lowercase)
#Provide your TCNJ email address and password when prompted
# At the '''password:''' prompt, enter your TCNJ password (the same one you use to access email, Canvas, etc.)
#If you've never logged into the cluster before, you will need to follow the on-screen instructions to setup your home directory.
# Once successful, you should see messages similar to the following (this assumes you haven't set up your account previously).<blockquote><code>Creating directory '/home/hpc/''your_username''<nowiki>'</nowiki>.</code><br><code>Creating ECDSA key for ssh</code></blockquote>
##Click the '''Open Shell to create home directory''' link. This will open a new browser tab with a terminal window
# At the '''$''' prompt, type <code>exit</code> and close the browser window/tab.
##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 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
#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.


You are now ready to access your cluster account using Open OnDemand or an SSH shell.
'''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=XUlX2XHysyQ</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 using the [https://tcnj.teamdynamix.com/TDClient/KB/ArticleDet?ID=17531 TCNJ VPN]. Use your existing TCNJ login and password when prompted. To logout of Open OnDemand, you must fully quit your browser.
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.
 
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=KoyfI1a1fww</embedvideo>


== Accessing the Cluster via SSH ==
== Accessing the Cluster via SSH ==
Line 29: 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 username (in all lowercase) and TCNJ password
# 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 HPC Cluster Shell Access''' for regular access or '''>_ELSA HPC Developer Shell Access''' if you need to do software development or compile code
# 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.
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=tawqK8D0weI</embedvideo>
 
'''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>


=== MacOS ===
=== 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 [https://www.dummies.com/computers/macs/adding-and-removing-dock-icons-in-mac-os-x/ you add it (i.e. drag it) to your application dock] for easy access in the future.
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 [https://www.dummies.com/computers/macs/adding-and-removing-dock-icons-in-mac-os-x/ you add it (i.e. drag it) to your application dock] for easy access in the future.
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=epuia4cWRWQ</embedvideo>
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=P_XW70AZgVU</embedvideo>


=== Microsoft Windows ===
=== Microsoft Windows ===
Line 45: Line 48:


Launch MobaXterm or PuTTY and connect to the cluster. Use <code>elsa.hpc.tcnj.edu</code> 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.
Launch MobaXterm or PuTTY and connect to the cluster. Use <code>elsa.hpc.tcnj.edu</code> 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.
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=WzlcKu-IVMc</embedvideo>
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=haUIdrJrKUk</embedvideo>


== Transferring Files To and From the Cluster ==
== Transferring Files To and From the Cluster ==
=== Using MobaXterm on Microsoft Windows ===
=== Using MobaXterm on Microsoft Windows ===
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=KwL4K51ncVc</embedvideo>
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=ecyjQtS0LPA</embedvideo>
=== Using Filezilla on MacOS ===
=== Using Filezilla on MacOS ===
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=j5hsm8wDiu0</embedvideo>
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=2DM-EAPIIuo</embedvideo>


=== Using Open OnDemand via a Web Browser ===
=== Using Open OnDemand via a Web Browser ===
<embedvideo service="youtube" urlargs="rel=0">https://www.youtube.com/watch?v=J5pdgBTiwpw</embedvideo>
'''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>

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.

  1. To begin, point your web browser to https://ondemand.hpc.tcnj.edu
  2. Provide your TCNJ email address and password when prompted
  3. If you've never logged into the cluster before, you will need to follow the on-screen instructions to setup your home directory.
    1. Click the Open Shell to create home directory link. This will open a new browser tab with a terminal window
    2. 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 ENTER or RETURN button on your keyboard after entering your password.
    3. After some text is displayed, type exit and then press the ENTER or RETURN button on your keyboard
    4. Close just the terminal window browser tab
  4. Back at the original browser tab, click the Restart Web Server link.
  5. 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:

  1. Login to Open OnDemand at https://ondemand.hpc.tcnj.edu/ using your TCNJ email address (in all lowercase) and TCNJ password
  2. Choose Clusters from the menu
  3. 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.

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.

Retrieved from "https://docs.hpc.tcnj.edu/index.php?title=HPC_Cluster_Getting_Started&oldid=568"