If you read nothing else, read this. This page is an insanely simple guide to just barely get you going. The documentation on this page will not be complete. It will not tell you everything. It will tell you just enough to get started with using Research Computing Cluster, SPORC (Scheduled Processing on Research Computing).
First off, please submit a ticket or contact us on Slack if you encounter any issues with the cluster.
This documentation site is the definitive source for Research Computing documentation.
If you are unfamiliar with Research Computing or want to know more about what we offer check out our About pages.
Step 1: Questionnaire
At Research Computing, we want to know our researchers, their research, and their computational/research computing needs. Before you can use Research Computing resources, you need to fill out this questionnaire. Your responses to the questionnaire help us understand your project and provide you with everything you need to do your research on our cluster.
Projects
After you fill out the questionnaire and we set up your cluster access, you will be assigned a Slurm (cluster) project. Projects should be tied to a specific research project with a start and an end date. Please fill out a new questionnaire for each distinct research project you work on.
Applying for Grant?
Check out our grant information document!
Step 2: Logistics
Acceptable Use Policy
If you use Research Computing resources, you are agreeing to our Acceptable Use Policy (AUP). Please review our AUP. If you have questions or need clarification, please don’t hesitate to contact us.
Logging Into the Cluster (SPORC)
If this is your first time using Research Computing resources, you need to login to the cluster to have your home directory created:
$ ssh <rit_username>@sporcsubmit.rc.rit.edu
Notes:
- You need to use your RIT username and password to log into the cluster.
- If you are logging in with your password via SSH, you will also receive a Duo prompt on your phone to verify the login. If you do not receive a Duo prompt, please go to start.rit.edu and verify your Multifactor Authentication settings. If you receive an error message that says “Your account is disabled” after your Duo prompt, please follow the instructions here to unlock your Duo account.
- After logging in for the first time, you will not be able to use the cluster until you fill out a new project questionnaire.
- If you need help with SSH, please read through our SSH Tutorial.
- We also have a web portal for you to access the cluster from a web browser: OnDemand.
Navigating the Terminal
If you are not familiar with navigating a terminal, or you need a refresher, please read through our Linux & Bash Tutorial. This tutorial covers navigating the file system, editing files, file permissions, and the basics of bash scripting.
Transferring Files
Linux and Mac users have a built-in command for transferring files over SSH, but there are applications available for every platform to do the same thing. We currently have some documentation for transferring files using OnDemand, scp, and Globus.
Please take a look at our Storage Tutorial for documentation on file transfer.
Maintenance Windows
We reserve one day each month for cluster maintenance. Please familiarize yourself with our maintenance window documentation.
Step 3: Accessing Software
Please read through our Software Tutorial to learn how to access the software you need for your research. This tutorial covers three ways to access software, as well as details about licensed software.
Step 4: Slurm - The Cluster Scheduler
The cluster is primarily designed for batch processing. We use software called Slurm to manage batch jobs on the cluster. When you want to run code on the cluster, you will tell slurm what resources you need, then slurm will dispatch your work to one or more computers that make up the clsuter. When your code is finished running, slurm frees up those resources so other researchers can use them.
Slurm Terminology
Before we move on, let’s clarify some terminology. Slurm has Accounts and Users. When you fill out the Questionnaire, we will create your Account and User.
A slurm Account is a tool for controlling the resources allocated to a user (or a group of users). A User must be added to an Account before they can use it. So, if multiple researchers want to use the same Account, each of their slurm Users must be added to the Account.
A User is just a simple way to connect your RIT credentials to the slurm environment. Important: Having a User and being able to log in to sporcsubmit does not mean you have been allocated resources. Your User must be added to an Account before resources are allocated.
Slurm Tutorials
We have two slurm tutorials to help you get started:
- Slurm Tutorial Part 1: This tutorial covers the basics of requesting resources and submitting compute jobs to slurm.
- Slurm Tutorial Part 2: This tutorial covers advanced methods of using slurm for specific research workflows.
Step 5: Please Cite Us
Research Computing tracks research publications that use our services on our Publications Website. You can help us do that by citing and ackwnoledging Research Computing in your publications. Thank you!
Need More Help?
If you need help using any Research Computing resources, don’t hesitate to contact us. Our infrastructure is changing all the time and our documentation may not always be up-to-date. We’re more than happy to work with you to accommodate your research needs.