Difference between revisions of "Getting Started"

From UFRC
Jump to navigation Jump to search
 
(165 intermediate revisions by 13 users not shown)
Line 1: Line 1:
−
{|align=right
+
[[Category:Essentials]]
−
  |__TOC__
+
Welcome to UF Research Computing! This page is intended to help new clients getting started on HiPerGator use.
−
  |}
 
−
==Getting an account==
 
−
To get an account at the UF Research Computing, you need to read [https://www.rc.ufl.edu/about/policies/account/ UFRC Account Policy] and then [https://www.rc.ufl.edu/help/account-request/ submit an account request].
 
  
−
==Login==
+
Note that new users are highly encouraged to take the [[New_user_training|New User Training]] course to familiarize themselves with using a supercomputer for research, save time, and avoid many beginner mistakes.
−
NOTE: If you are using UF's Visitor Wireless, you will not be able to login to our systems using SSH. You will need to arrange for access using some other network.
 
−
===Linux / Unix===
 
−
Open a terminal and run
 
−
ssh <YOUR_USERNAME>@hpg2.rc.ufl.edu
 
−
where <code><YOUR_USERNAME></code> is your Research Computing username, which was sent to you when you got your Research Computing account.
 
  
−
The command <code>ssh <YOUR_USERNAME>@hpg2.rc.ufl.edu</code> is what you would type in at a command prompt on your system.  After this, it asks you for a password, which you type in. After that, you are logged in and ready to work.  As a concrete example, if your Research Computing username is "smith", you would use the command <code>ssh smith@hpg2.rc.ufl.edu</code> to log into the Research Computing.
 
  
−
===Windows===
+
=From Zero to HiPerGator=
−
Microsoft Windows does not come with a built-in SSH client. You have to download a client from the web. We recommend the following software:
+
===Initial Consult===
−
* SSH client - [http://www.chiark.greenend.org.uk/~sgtatham/putty Putty]
+
If a face-to-face discussion about the group's needs is needed you can [https://outlook.office365.com/owa/calendar/UFITResearchComputingSupport@uflorida.onmicrosoft.com/bookings/ schedule an appointment] to [https://www.rc.ufl.edu/get-support/walk-in-support/ meet with one of the UF Research Computing Facilitators] face-to-face or virtually, or [https://support.rc.ufl.edu/ submit a support request to start the conversation].
−
** [[PuTTY|configuration instructions for UFRC]]
 
−
* SSH client - [http://mobaxterm.mobatek.net/ MobaXterm]
 
−
* Graphical file transfer clients:
 
−
** [https://filezilla-project.org/download.php?show_all=1 FileZilla]
 
−
<!-- [http://filezilla-project.org/download.php?type=client FileZilla]. See our [[FileZilla|tutorial on transferring files to UFRC using FileZilla]]. -->
 
−
** [http://winscp.net/eng/index.php WinSCP]
 
−
===MacOS===
 
−
For MacOS users, the connection instructions are very similar to those for Linux/Unix users.
 
  
−
''Terminal'', the terminal emulation application under MacOS is located in Applications/Utilities.
 
  
−
Both [http://filezilla-project.org/download.php?type=client FileZilla] and [http://cyberduck.ch/ Cyberduck] are available for MacOS if you prefer a graphical interface for transferring files.
+
For the initial interview we recommend prospective users to be ready to answer questions such as:
  
−
==Running Graphical Programs==
+
* Does the data fall under FERPA, HIPAA, or another restricted classification?
−
See the [[GUI_Programs|Gui Programs]] page for information on running graphical user interface applications at UFRC.
+
* Explain in simple words what your research is about.
 +
* What file types will be processed initially?
 +
** Input files, average size of individual files, total amount of data in Gb/Tb, etc.
 +
* What software or pipeline is needed to process the files?
 +
Define success for you:
 +
* What is the expected output?
 +
** Expected results, output file types and individual file size, amount of data produced after processing in Gb/Tb.
 +
* Do you have any estimations on compute needs?
 +
* Are you or will you be working with external collaborators?
  
−
==Getting Help==
+
===HiPerGator Accounts===
−
If you are having problems connecting to the UFRC system, please let the UFRC Staff know by submitting a [http://support.rc.ufl.edu Support Request].
+
====Sponsor Username and Group Creation====
 +
The group's sponsor has to be the first person to [https://www.rc.ufl.edu/access/account-request/ request a HiPerGator account] indicating that they are a new sponsor. In the process we will create their sponsored group.
  
−
==Interactive work under Linux==
+
====User Account Creation====
−
Once you are logged in to a Research Computing server, you will find yourself at a Linux command line prompt. That may be daunting at first. However, you only need to know a small subset of Linux commands to accomplish most tasks. There are many Linux "Getting Started" guides online and in print. Below are just a few possibilities. Many more are easily found via a Google search.
+
Group members will be able to [https://www.rc.ufl.edu/access/account-request/ submit HiPerGator account requests] indicating their PI as the sponsor. Once approved, their HPG Linux accounts will be created.
  
−
* [http://www.tldp.org/LDP/intro-linux/html/ Introduction to Linux]
+
====Joining a Group====
−
* [http://www.linux.org/tutorial/view/beginners-level-course Linux for Beginners]
+
Once their HPG username is created users must [https://support.rc.ufl.edu submit a request] to be added to a sponsor's group. Once the sponsor or an assigned manager replies to the request with approval, the user is added to the requested group. Accounts can only be added to groups with active resource allocations (see below for details).
−
* [[Getting_Started_on_Linux]]
 
−
* [https://www.lynda.com/Linux-tutorials/Learn-Linux-Command-Line-Basics/435539-2.html Linux Command Line Basics - Lynda.com]
 
−
** Users with a Gatorlink account can sign into Lynda.com by clicking "Log In," then "Sign in with your organization"
 
  
−
==A Few Basic Commands==
+
[https://support.rc.ufl.edu Request to be added to a group]:
−
While it is advantageous to have a working knowledge of the most common Linux commands, it is not a requirement. For the uninitiated, the following information may be useful as well as a good "Introduction to Using Linux" book.
+
* Include the following in the Summary line: "Add [username] to [groupname] group".
 +
* Include the reason in the request's description.
 +
* If possible, add your sponsor's email to the ticket's CC list.
  
−
{| border=1
+
===Trial Allocation===
−
|-
+
We recommend that the group's sponsor [https://gravity.rc.ufl.edu/access/request-trial-allocation/ request a '''free''' trial allocation] for storage and computational resources to get the group started on HiPerGator. Group members can then use HiPerGator for the 3 month duration of the trial allocation to figure out what resources and applications they really need.
−
! Command !! Description
 
−
|-
 
−
| ls || List files in the current directory
 
−
|-
 
−
| cd || Change directory
 
−
|-
 
−
| more || View a file's contents
 
−
|-
 
−
| mkdir <dir> || Create a directory
 
−
|-
 
−
| cp file1 file2 || Copy a file
 
−
|-
 
−
| mv file1 file2 || Move (i.e. rename) a file
 
−
|-
 
−
| rm file || Delete a file
 
−
|-
 
−
| rmdir dir || Delete an ''empty'' directory
 
−
|}
 
  
−
==Editing==
+
===Purchasing Resources===
−
Editing files on the cluster can be done through a couple of different methods...
+
After or while the group uses a trial allocation to determine the computational and storage resources it needs the group's sponsor can submit a purchase request for [https://gravity.rc.ufl.edu/access/purchase-request/hpg-hardware/ hardware (5-years)] or [https://gravity.rc.ufl.edu/access/purchase-request/hpg-service/ services (3-months to longer)] to invest into the resources to cover the group's HiPerGator use.
−
===Native Editors===
 
−
* '''vi''' - The visual editor (vi) is the traditonal Unix editor. However, it is not necessarily the most intuitive editor.  That being the case, if you are unfamiliar with it, the following tutorial may be useful.
 
−
** [http://www.eng.hawaii.edu/Tutor/vi.html VI Tutorial]
 
−
** Another resource for vi is [[vi | right here]] on our wiki.
 
−
** There is also a vi tutorial, '''vimtutor'''. Once logged in, simply type "<code>vimtutor</code>" at the command line to start the tutorial.
 
−
* '''emacs''' - Emacs is a much heavier duty editor, but again has the problem of having commands that are non-intuitive. Again, we have provided a link to a tutorial for this editor.
 
−
** [http://www2.lib.uchicago.edu/~keith//tcl-course/emacs-tutorial.html Emacs Tutorial]
 
−
* '''pico''' - While pico is not installed on the system, [[nano]] is installed, and is a pico work-a-like.
 
−
* '''nano''' - Nano has a good bit of on-screen help to make it easier to use.
 
  
−
===External Editors===
+
Some groups may have access to shared departmental allocations. In this case, instead of purchasing resources, group members can [https://support.rc.ufl.edu/ request] to be added to the departmental group to gain access to the shared resources.  
−
You can also use your favorite editor on your local machine and then transfer the files over to the Research Computing afterwards. One caveat to this is that with files created on Windows machines, usually contain unprintable characters which may be misinterpreted by Linux command interpreters (shells). If this happens, there is a utility called <code>dos2unix</code> that you can use to convert the text file from DOS/Windows formatting to Linux formatting.
 
  
−
==Using Installed Software==
+
Some examples of departments with shared allocations include the [http://ufgi.ufl.edu/ Genetics Institute], [http://epi.ufl.edu/ Emerging Pathogens Institute], [https://stat.ufl.edu/ Statistics Department], [http://biostat.ufl.edu/ Biostatistics Department], [https://www.eng.ufl.edu/ccmt/ Center for Compressible Multiphase Turbulence (CCMT)], [https://chp.phhp.ufl.edu/research/affiliated-centers/center-for-cognitive-aging-memory-cam/ Cognitive Aging and Memory Clinical Translational Research Program (CAMCTRP)], [https://efrc.ufl.edu/ Center for Molecular Magnetic Quantum Materials], [https://www.phys.ufl.edu/ Physics Department], and [https://plantpath.ifas.ufl.edu/ Plant Pathology Department]. In addition, several research groups working on collaborative projects have shared allocations accessible to members of those projects.
  
−
We use [[Modules|Environment Modules]] to provide access to the installed software. Read about the [[Modules_Basic_Usage|basic usage of environment modules]] for information on loading software.
+
'''At this point a group is established on HiPerGator and can continue their computational work. See below for more details on the basic use.'''
  
−
==Running Jobs==
+
=Using HiPerGator=
 +
To use HiPerGator or HiPerGator-AI you must have basic understanding the following concepts:
 +
* Use the various [[HPG Interfaces]] to connect to the system.
 +
* See [[HPG Computation]] for an overview of running analyses on HiPerGator.
 +
* Read [[HPG Scheduling]] for an overview of managing resources in jobs.
 +
* Learn how to manage data on the filesystems in [[Storage]] and how to transfer it in or out in [[HPG Data Management]].
  
−
See [[Sample_SLURM_Scripts]] for a simple SLURM job script examples.
+
Click on the buttons below to explore.
−
||
+
<div style = 'text-align: center;'>
−
To submit this job from one of login nodes via hpg2.rc.ufl.edu, you would use the following command:
+
[[Image:Interface.png|frameless|upright=1| link=HPG Interfaces]]
−
<pre>
+
[[Image:Computation.png|frameless|upright=1|link=HPG Computation]]
−
$ sbatch <your job script>
+
[[Image:Scheduling.png|frameless|upright=1|link=HPG Scheduling]]
−
</pre>
+
[[Image:Storage.png|frameless|upright=1|link=HPG Data Management]]
−
To check the status of running jobs, you would use the following command:
+
</div>
−
<pre>
 
−
$ squeue [-u <username>]
 
−
</pre>
 
−
|}
 
  
−
====DRMAA====
+
=Getting help=
−
It's possible to submit jobs by using the scheduler API via the DRMAA library. A python example that uses our installed Python DRMAA library can be found in [[Example_pbs-drmaa_python_script]].
+
If you are having problems using the UFRC system, try our resources at [https://help.rc.ufl.edu/doc/Category:Help Help] or let our staff know by submitting a [http://support.rc.ufl.edu support request].
−
 
 
−
====Notes on Batch Scripts====
 
−
* The script can handle only one set of directives. '''Do not submit a script that has more than one set of directives''' included in it.
 
−
 
 
−
* For more info on '''advanced directives''' see [[PBS_Directives]].
 
−
 
 
−
* Please see our [[Batch Script Explanation | annotated submission script]].
 
−
 
 
−
===Job Status===
 
−
You can view the job status of your jobs and your group's jobs via the [http://rc.ufl.edu/jobstatus/ PBS Job Status] page as described in [[PBS_Job_Status|PBS Job Status Documentation]]
 
−
===Scratch Storage===
 
−
See [[Scratch]] for notes on the main high-performance storage.
 
−
 
 
−
===Developmental Nodes===
 
−
See [[Test_Nodes]] to read about the available interactive servers.
 

Latest revision as of 17:56, 19 August 2024

Welcome to UF Research Computing! This page is intended to help new clients getting started on HiPerGator use.

Note that new users are highly encouraged to take the New User Training course to familiarize themselves with using a supercomputer for research, save time, and avoid many beginner mistakes.


From Zero to HiPerGator

Initial Consult

If a face-to-face discussion about the group's needs is needed you can schedule an appointment to meet with one of the UF Research Computing Facilitators face-to-face or virtually, or submit a support request to start the conversation.


For the initial interview we recommend prospective users to be ready to answer questions such as:

  • Does the data fall under FERPA, HIPAA, or another restricted classification?
  • Explain in simple words what your research is about.
  • What file types will be processed initially?
    • Input files, average size of individual files, total amount of data in Gb/Tb, etc.
  • What software or pipeline is needed to process the files?

Define success for you:

  • What is the expected output?
    • Expected results, output file types and individual file size, amount of data produced after processing in Gb/Tb.
  • Do you have any estimations on compute needs?
  • Are you or will you be working with external collaborators?

HiPerGator Accounts

The group's sponsor has to be the first person to request a HiPerGator account indicating that they are a new sponsor. In the process we will create their sponsored group.

User Account Creation

Group members will be able to submit HiPerGator account requests indicating their PI as the sponsor. Once approved, their HPG Linux accounts will be created.

Joining a Group

Once their HPG username is created users must submit a request to be added to a sponsor's group. Once the sponsor or an assigned manager replies to the request with approval, the user is added to the requested group. Accounts can only be added to groups with active resource allocations (see below for details).

Request to be added to a group:

  • Include the following in the Summary line: "Add [username] to [groupname] group".
  • Include the reason in the request's description.
  • If possible, add your sponsor's email to the ticket's CC list.

Trial Allocation

We recommend that the group's sponsor request a free trial allocation for storage and computational resources to get the group started on HiPerGator. Group members can then use HiPerGator for the 3 month duration of the trial allocation to figure out what resources and applications they really need.

Purchasing Resources

After or while the group uses a trial allocation to determine the computational and storage resources it needs the group's sponsor can submit a purchase request for hardware (5-years) or services (3-months to longer) to invest into the resources to cover the group's HiPerGator use.

Some groups may have access to shared departmental allocations. In this case, instead of purchasing resources, group members can request to be added to the departmental group to gain access to the shared resources.

Some examples of departments with shared allocations include the Genetics Institute, Emerging Pathogens Institute, Statistics Department, Biostatistics Department, Center for Compressible Multiphase Turbulence (CCMT), Cognitive Aging and Memory Clinical Translational Research Program (CAMCTRP), Center for Molecular Magnetic Quantum Materials, Physics Department, and Plant Pathology Department. In addition, several research groups working on collaborative projects have shared allocations accessible to members of those projects.

At this point a group is established on HiPerGator and can continue their computational work. See below for more details on the basic use.

Using HiPerGator

To use HiPerGator or HiPerGator-AI you must have basic understanding the following concepts:

Click on the buttons below to explore.

Interface.png Computation.png Scheduling.png Storage.png

Getting help

If you are having problems using the UFRC system, try our resources at Help or let our staff know by submitting a support request.

Retrieved from "https://help.rc.ufl.edu/mediawiki/index.php?title=Getting_Started&oldid=29039"