diff --git a/docs/hpc/01_getting_started/02_getting_and_renewing_an_account.md b/docs/hpc/01_getting_started/02_getting_and_renewing_an_account.mdx
similarity index 77%
rename from docs/hpc/01_getting_started/02_getting_and_renewing_an_account.md
rename to docs/hpc/01_getting_started/02_getting_and_renewing_an_account.mdx
index 7c80c4a067..4417b699b7 100644
--- a/docs/hpc/01_getting_started/02_getting_and_renewing_an_account.md
+++ b/docs/hpc/01_getting_started/02_getting_and_renewing_an_account.mdx
@@ -1,3 +1,6 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
# Getting and Renewing an Account
[nyu vpn link]: https://www.nyu.edu/life/information-technology/infrastructure/network-services/vpn.html
@@ -25,11 +28,11 @@ NYU HPC clusters and related resources are available to full-time NYU faculty an
## Getting a new account on the NYU HPC clusters
-To request an NYU HPC account please log in to [NYU Identity Management service][nyu ims link] and follow the link to "Request HPC account". We have a walkthrough of how to \[request an account through IIQ]. If you are a student, alumni or an external collaborator you need an NYU faculty sponsor.
+To request an NYU HPC account please log in to [NYU Identity Management service][nyu ims link] and follow the link to "Request HPC account". We have a walkthrough of how to [request an account through IIQ](03_walkthrough_request_hpc_account.mdx). If you are a student, alumni or an external collaborator you need an NYU faculty sponsor.
## Renewing HPC account
-Each year, non-faculty users must renew their HPC account by filling in the account renewal form from the [NYU Identity Management service][nyu ims link]. See [Renewing your HPC account with IIQ](./03_walkthrough_approve_hpc_account_request.md) for a walkthrough of the process.
+Each year, non-faculty users must renew their HPC account by filling in the account renewal form from the [NYU Identity Management service][nyu ims link]. See [Renewing your HPC account](05_walkthrough_renew_hpc_account.md) for a walkthrough of the process.
## Information for faculty who sponsor HPC users
@@ -61,13 +64,13 @@ HPC faculty sponsors are expected to:
- Respond promptly to account-related requests from HPC staff
-Each year, your sponsored users must renew their account. You will need to approve the renewal by logging into the [NYU Identity Management service][nyu ims link]. We have a [walkthrogh of the approval process here](./03_walkthrough_approve_hpc_account_request.md)
+Each year, your sponsored users must renew their account. You will need to approve the renewal by logging into the [NYU Identity Management service][nyu ims link]. We have a [walkthrogh of the approval process here](04_walkthrough_approve_hpc_account_request.md)
## Bulk HPC Accounts for Courses
HPC bulk accounts request is disabled for HPC sponsors.
-- If you would like to use JupyterHub for your classes, please don't submit the form below, read \[Jupyter Hub page] instead (the link to an intake form is also there)
+- If you would like to use JupyterHub for your classes, please don't submit the form below, read \[Jupyter Hub page]**TODO Add a page for JHub in the Cloud section** instead (the link to an intake form is also there)
- Please fill out this [request form][hpc account request form link for courses] for the course, we'll create HPC accounts for the class per request
@@ -81,7 +84,7 @@ NYU partners (\[look for the list here]) with many state and national facilities
If you are part of collaboration with NYU researcher you need to obtain an **affiliate** status before applying for an NYU HPC account. A full-time NYU faculty member must sponsor a non-NYU collaborator for an affiliate status.
-Please see [instructions for affiliate management][affiliate and account management link] (NYU NetID login is required to follow the link). [Please read instructions about sponsoring external collaborators here](./05_hpc_accounts_external_collaborators.md).
+Please see [instructions for affiliate management][affiliate and account management link] (NYU NetID login is required to follow the link). [Please read instructions about sponsoring external collaborators here](06_hpc_accounts_external_collaborators.md).
## Access to cluster after Graduation
@@ -97,13 +100,25 @@ If you are not part of a collaboration, your access to cluster will end together
In order to request a new HPC account or renew an expired one, you need to be connected to the NYU VPN if you are working remotely, Please see [instructions on how to install and use the NYU VPN][nyu vpn link]. Linux clients are not officially supported, however we were able to successfully use openVPN client. Here are installation and connection instructions for a debian linux distribution with apt package manager:
-```sh
-apt-get install openconnect
-sudo openconnect -b vpn.nyu.edu
-```
-_When prompted follow the instructions and provide your netID, password, and authenticate with ('push', 'phone1' or 'sms')_
+
+
+ - Download the VPN package from [here](https://cdn.shanghai.nyu.edu/sites/default/files/anyconnect-core-linux64-4.10.07061.zip) and unzip the file;
+ - Type the following command in the Terminal
+ ```sh
+ sudo sh anyconnect-core-linux64-4.10.07061.sh
+ ```
+
+
+ - Type the following command in the Terminal
+ ```sh
+ apt-get install openconnect
+ sudo openconnect -b vpn.nyu.edu
+ ```
+ - When prompted follow the instructions and provide your netID, password, and authenticate with ('push', 'phone1' or 'sms')
+ This method was tested on few Linux distributions and settings however is not guaranteeed to work in future.
+
+
-This method was tested on few Linux distributions and settings however is not guaranteeed to work in future.
:::
diff --git a/docs/hpc/01_getting_started/03_walkthrough_request_hpc_account.mdx b/docs/hpc/01_getting_started/03_walkthrough_request_hpc_account.mdx
new file mode 100644
index 0000000000..59eb15b0d8
--- /dev/null
+++ b/docs/hpc/01_getting_started/03_walkthrough_request_hpc_account.mdx
@@ -0,0 +1,49 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# How to request an HPC account
+
+First, check if you already have an account. You can check this by attempting to log in to the cluster, according to the instructions at [Connecting to the HPC Cluster](../02_connecting_to_hpc/01_connecting_to_hpc.md)
+
+:::info VPN Needed
+You need to be on the NYU VPN to perform this task!
+:::
+
+Login to the URL given below, using your NetID/password, to create or manage HPC Account Requests:
+https://identity.it.nyu.edu/
+
+
+
+
+ Upon logging in, an end user’s landing page will look like this:
+ 
+
+ Note that if the menu does not appear, select the "burger" menu on the top left hand corner:
+ 
+
+ Navigate to Manage Accounts > Request HPC Account:
+
+ 
+
+ You will be prompted with a form. Continue to fill it out and Submit.
+ 
+
+
+ When an approver/sponsor/faculty logs in, it will look like this:
+ 
+ with “QuickLinks” to both “Bulk HPC Account Request” and “Request HPC Account” and will show any recent or pending approvals or forms.
+
+ If the **Request HPC Account** QuickLink is clicked, the following form appears:
+ 
+
+ The user’s name will be prepopulated, and the forms required fields must be completed (sponsor, reason for request, consent to terms of use). After clicking “Submit” the chosen sponsor will be notified of the request and provisioning will only occur after approval.
+
+ If the **Bulk HPC Account Request** QuickLink is clicked, the following form appears:
+ 
+
+ The requestor’s name will be prepopulated, and the forms required fields must be completed (sponsor, list of netids, course identifier, reason for request, consent to terms of use). These requests are auto-approved since they are usually submitted by the sponsor themselves or a member of the HPC Admin team.
+
+
+
+
+
diff --git a/docs/hpc/01_getting_started/03_walkthrough_approve_hpc_account_request.md b/docs/hpc/01_getting_started/04_walkthrough_approve_hpc_account_request.md
similarity index 54%
rename from docs/hpc/01_getting_started/03_walkthrough_approve_hpc_account_request.md
rename to docs/hpc/01_getting_started/04_walkthrough_approve_hpc_account_request.md
index 2b140761bc..0cd1ddefa5 100644
--- a/docs/hpc/01_getting_started/03_walkthrough_approve_hpc_account_request.md
+++ b/docs/hpc/01_getting_started/04_walkthrough_approve_hpc_account_request.md
@@ -1,5 +1,9 @@
# How to approve an HPC Account Request
+:::info VPN Needed
+You need to be on the NYU VPN to perform this task!
+:::
+
When someone nominates you as their HPC sponsor, you should be notified by email. You can also [log into IIQ at any time](https://iiq.nyu.edu/identityiq), and if you have a request awaiting your approval, it will appear in your "Actions Items" box, as per the following screenshot:
@@ -9,5 +13,11 @@ Another way to get to pending approvals is to click on the line item in the “L
Here, the Approve or Deny button should be clicked, then confirmed, in order to complete the request.
-If you have any difficulties or questions, please contact us at hpc@nyu.edu.
+For HPC Account Renewals, the page will look like this:
+
+
+Here, all systems should be selected by clicking the check box in the menu bar, and choosing “Select Everything”.
+
+
+Then, the “Select Bulk Action” menu is used to Approve or Reject all items selected. Please note that the line items may span multiple pages and all items must be acted upon in order to complete the request. Clicking “Complete” will complete the request.
diff --git a/docs/hpc/01_getting_started/04_walkthrough_renew_hpc_account_iiq.md b/docs/hpc/01_getting_started/05_walkthrough_renew_hpc_account.md
similarity index 89%
rename from docs/hpc/01_getting_started/04_walkthrough_renew_hpc_account_iiq.md
rename to docs/hpc/01_getting_started/05_walkthrough_renew_hpc_account.md
index ed2f3c01d0..27b245488f 100644
--- a/docs/hpc/01_getting_started/04_walkthrough_renew_hpc_account_iiq.md
+++ b/docs/hpc/01_getting_started/05_walkthrough_renew_hpc_account.md
@@ -1,8 +1,12 @@
-# Renewing your HPC Account with IIQ
+# Renewing your HPC Account
-Login to the URL given below, using your netid/password, to create or manage HPC Account Requests:
+Login to the URL given below, using your NetID/password, to create or manage HPC Account Requests:
-https://identity.it.nyu.edu/ (NYU VPN is required)
+:::info VPN Needed
+You need to be on the NYU VPN to perform this task!
+:::
+
+https://identity.it.nyu.edu/
Upon logging in, an end user’s landing page will look like this
diff --git a/docs/hpc/01_getting_started/06_coldfront_requesting_an_allocation_request.md b/docs/hpc/01_getting_started/06_coldfront_requesting_an_allocation_request.md
deleted file mode 100644
index a233bb8ac5..0000000000
--- a/docs/hpc/01_getting_started/06_coldfront_requesting_an_allocation_request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# How to submit an Allocation Request
-
-If you would ike to raise an allocation request, please first login to coldfront page and you'll see "Project" navigation bar.
-Click the "Project" navigation bar and click "Projects" to choose which project you would like to raise the allocation request for.
-
-
-Now, you'll see a list of projects and if you click a project, you'll see this project detail page.
-
-
-If you scroll down a bit, you'll see "+Request Resource Allocation" button.
-
-
-After clicking "+Request Resource Allocation", you'll see a list of resources you can request for.
-Basically, you'll see general "University HPC" which is default for all and school-wise resources (e.g., Tandon(Generic)) based on a school that your project belongs to.
-Please select a resource and fill in justification to complete the allocation request process.
-
-
-
-Now your allocation request is created! You'll see an allocation request with "New" status.
-
-
-If you have any difficulties or questions, please contact us at hpc@nyu.edu.
-
diff --git a/docs/hpc/01_getting_started/05_hpc_accounts_external_collaborators.md b/docs/hpc/01_getting_started/06_hpc_accounts_external_collaborators.md
similarity index 100%
rename from docs/hpc/01_getting_started/05_hpc_accounts_external_collaborators.md
rename to docs/hpc/01_getting_started/06_hpc_accounts_external_collaborators.md
diff --git a/docs/hpc/01_getting_started/07_what_is_coldfront.mdx b/docs/hpc/01_getting_started/07_what_is_coldfront.mdx
new file mode 100644
index 0000000000..7a50fb3516
--- /dev/null
+++ b/docs/hpc/01_getting_started/07_what_is_coldfront.mdx
@@ -0,0 +1,37 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# HPC project management portal
+
+Coldfront is the HPC project and allocation management portal for Torch at NYU. You can access it by navigating to [coldfront.hpc.nyu.edu](https://coldfront.hpc.nyu.edu). With it you can:
+
+
+ - Create a project
+ - Request allocations for your projects
+ - Add/Delete members associated with your project
+ - Modify access to allocations for the members of your project
+
+
+
+ - View the projects and allocations you are part of
+ - View the SLURM accounts for projects you are part of
+
+
+ - Approve the resource allocation requests from PIs for projects associated with your school
+
+
+
+
+
+
+:::info[VPN Needed]
+You need to be connected to the NYU VPN or be present on campus to access the Coldfront HPC project management portal.
+:::
+
+How do I:
+- Create a project: refer to [creating a project](08_coldfront_creating_a_project.mdx)
+- Request an allocation: refer to [submitting an allocation request](09_coldfront_requesting_an_allocation_request.mdx)
+- Approve an allocation request: refer to [approving an allocation request](10_approving_an_allocation_request.md)
+- View resources that are available to me: refer to [current allocations sub-section here](09_coldfront_requesting_an_allocation_request.mdx)
+
+A coldfront allocation is needed to perform any work on Torch. The next sections describe the project and allocation request process in detail.
diff --git a/docs/hpc/01_getting_started/08_coldfront_creating_a_project.mdx b/docs/hpc/01_getting_started/08_coldfront_creating_a_project.mdx
new file mode 100644
index 0000000000..100a0a2763
--- /dev/null
+++ b/docs/hpc/01_getting_started/08_coldfront_creating_a_project.mdx
@@ -0,0 +1,12 @@
+# How to create a project on Coldfront
+
+Login to coldfront at [coldfront.hpc.nyu.edu](https://coldfront.hpc.nyu.edu) either on-campus or on the VPN. Navigate to the "Project" item in the navigation bar on the top of the page and select "Projects" from the drop down menu.
+
+
+
+If you are a PI, you will be able to see a button "+ Add a Project" button that will let you create a new project.
+
+
+
+Click on it to head to the project creation page where you can add the project title, description and the school it will be associated with. The school a project is associated with determines the resources it will have access to. The school approver for the associated school has the capacity to approve allocation requests for resources associated with the school.
+
diff --git a/docs/hpc/01_getting_started/09_coldfront_requesting_an_allocation_request.mdx b/docs/hpc/01_getting_started/09_coldfront_requesting_an_allocation_request.mdx
new file mode 100644
index 0000000000..e7c841592d
--- /dev/null
+++ b/docs/hpc/01_getting_started/09_coldfront_requesting_an_allocation_request.mdx
@@ -0,0 +1,42 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Managing allocations for your project
+
+Login to coldfront at [coldfront.hpc.nyu.edu](https://coldfront.hpc.nyu.edu) either on-campus or on the VPN. Navigate to the "Project" item in the navigation bar on the top of the page and select "Projects" from the drop down menu.
+
+
+From the list of project, click on the project you'd like to submit an allocation request for and you'll see the current details:
+
+
+## Current allocations
+Scroll down and you'll reach the Allocations section. This section lists all the allocations associated with this project. All allocations have SLURM accounts associated with them. Allocations that are "Active" will allow you to submit jobs using the SLURM account associated with it.
+
+## Requesting new allocations
+If you scroll down, you'll see "+Request Resource Allocation" button.
+
+
+After clicking "+Request Resource Allocation", you'll see a list of resources you can request for. All projects can request access to Torch, which provides access to the cluster. However, depending on the school the project is affiliated with, high priority resources are available.
+
+:::info Available resource for each school:
+
+
+ - **tandon_advanced**: includes both A100 and H100 GPUs
+ - **tandon_priority**: includes A100 GPUs only
+
+
+ - **cilvr**: A100 GPUs
+ - **cds**: rtx8000 and A100
+ - **chemistry**: A100 GPUs
+
+
+:::
+
+Please select a resource and fill in justification to complete the allocation request process.
+
+
+Now your allocation request is created! You'll see an allocation request with "New" status.
+
+
+Once your school approver approves the request, the status will change to "Active" (and you will receive an email notifying you of the change).
+
diff --git a/docs/hpc/01_getting_started/07_approving_an_allocation_request.md b/docs/hpc/01_getting_started/10_approving_an_allocation_request.md
similarity index 97%
rename from docs/hpc/01_getting_started/07_approving_an_allocation_request.md
rename to docs/hpc/01_getting_started/10_approving_an_allocation_request.md
index 1e1197a7e7..58c0889d25 100644
--- a/docs/hpc/01_getting_started/07_approving_an_allocation_request.md
+++ b/docs/hpc/01_getting_started/10_approving_an_allocation_request.md
@@ -1,4 +1,4 @@
-# How to approve an Allocation Request
+# How to approve an allocation request
If you are an approver for your school, first login to coldfront page and you'll see "staff" navigation bar.
Click the "staff" navigation bar and click "Allocation Requests" to see a list of requests waiting for your approval.
diff --git a/docs/hpc/01_getting_started/static/allocation_request_submit.png b/docs/hpc/01_getting_started/static/allocation_request_submit.png
new file mode 100644
index 0000000000..72cc8d8b90
Binary files /dev/null and b/docs/hpc/01_getting_started/static/allocation_request_submit.png differ
diff --git a/docs/hpc/01_getting_started/static/allocation_requests.png b/docs/hpc/01_getting_started/static/allocation_requests.png
index 7d0292445a..57348e940a 100644
Binary files a/docs/hpc/01_getting_started/static/allocation_requests.png and b/docs/hpc/01_getting_started/static/allocation_requests.png differ
diff --git a/docs/hpc/01_getting_started/static/approve_renewal.png b/docs/hpc/01_getting_started/static/approve_renewal.png
new file mode 100644
index 0000000000..99b37423dd
Binary files /dev/null and b/docs/hpc/01_getting_started/static/approve_renewal.png differ
diff --git a/docs/hpc/01_getting_started/static/approve_select_everything.png b/docs/hpc/01_getting_started/static/approve_select_everything.png
new file mode 100644
index 0000000000..46ab5459bf
Binary files /dev/null and b/docs/hpc/01_getting_started/static/approve_select_everything.png differ
diff --git a/docs/hpc/01_getting_started/static/approver_staff.png b/docs/hpc/01_getting_started/static/approver_staff.png
index ec2f47483a..692e1eea52 100644
Binary files a/docs/hpc/01_getting_started/static/approver_staff.png and b/docs/hpc/01_getting_started/static/approver_staff.png differ
diff --git a/docs/hpc/01_getting_started/static/approving_allocation.png b/docs/hpc/01_getting_started/static/approving_allocation.png
index 42f76b9b2e..79bdd5e616 100644
Binary files a/docs/hpc/01_getting_started/static/approving_allocation.png and b/docs/hpc/01_getting_started/static/approving_allocation.png differ
diff --git a/docs/hpc/01_getting_started/static/bulk_acct_req_form.png b/docs/hpc/01_getting_started/static/bulk_acct_req_form.png
new file mode 100644
index 0000000000..9c9f7395c9
Binary files /dev/null and b/docs/hpc/01_getting_started/static/bulk_acct_req_form.png differ
diff --git a/docs/hpc/01_getting_started/static/faculty_request_form.png b/docs/hpc/01_getting_started/static/faculty_request_form.png
new file mode 100644
index 0000000000..26bf7496b4
Binary files /dev/null and b/docs/hpc/01_getting_started/static/faculty_request_form.png differ
diff --git a/docs/hpc/01_getting_started/static/faculty_request_landing.png b/docs/hpc/01_getting_started/static/faculty_request_landing.png
new file mode 100644
index 0000000000..7b624cac37
Binary files /dev/null and b/docs/hpc/01_getting_started/static/faculty_request_landing.png differ
diff --git a/docs/hpc/01_getting_started/static/identity_landing.png b/docs/hpc/01_getting_started/static/identity_landing.png
new file mode 100644
index 0000000000..376026e994
Binary files /dev/null and b/docs/hpc/01_getting_started/static/identity_landing.png differ
diff --git a/docs/hpc/01_getting_started/static/project_add_button.png b/docs/hpc/01_getting_started/static/project_add_button.png
new file mode 100644
index 0000000000..027d8e8298
Binary files /dev/null and b/docs/hpc/01_getting_started/static/project_add_button.png differ
diff --git a/docs/hpc/01_getting_started/static/project_create.png b/docs/hpc/01_getting_started/static/project_create.png
new file mode 100644
index 0000000000..7d035968e8
Binary files /dev/null and b/docs/hpc/01_getting_started/static/project_create.png differ
diff --git a/docs/hpc/01_getting_started/static/project_dropdown.png b/docs/hpc/01_getting_started/static/project_dropdown.png
new file mode 100644
index 0000000000..665a59315e
Binary files /dev/null and b/docs/hpc/01_getting_started/static/project_dropdown.png differ
diff --git a/docs/hpc/01_getting_started/static/request_account.png b/docs/hpc/01_getting_started/static/request_account.png
new file mode 100644
index 0000000000..edd17021c9
Binary files /dev/null and b/docs/hpc/01_getting_started/static/request_account.png differ
diff --git a/docs/hpc/01_getting_started/static/request_burger.png b/docs/hpc/01_getting_started/static/request_burger.png
new file mode 100644
index 0000000000..fd278b4dab
Binary files /dev/null and b/docs/hpc/01_getting_started/static/request_burger.png differ
diff --git a/docs/hpc/01_getting_started/static/request_form.png b/docs/hpc/01_getting_started/static/request_form.png
new file mode 100644
index 0000000000..ddb74f2860
Binary files /dev/null and b/docs/hpc/01_getting_started/static/request_form.png differ
diff --git a/docs/hpc/01_getting_started/static/school_resource.png b/docs/hpc/01_getting_started/static/school_resource.png
deleted file mode 100644
index 24f4c6b047..0000000000
Binary files a/docs/hpc/01_getting_started/static/school_resource.png and /dev/null differ
diff --git a/docs/hpc/01_getting_started/static/uni_resource.png b/docs/hpc/01_getting_started/static/uni_resource.png
deleted file mode 100644
index 48ee73c6ec..0000000000
Binary files a/docs/hpc/01_getting_started/static/uni_resource.png and /dev/null differ
diff --git a/docs/hpc/03_storage/05_research_project_space.mdx b/docs/hpc/03_storage/05_research_project_space.mdx
index 479536c94d..f5e3e1c362 100644
--- a/docs/hpc/03_storage/05_research_project_space.mdx
+++ b/docs/hpc/03_storage/05_research_project_space.mdx
@@ -44,7 +44,7 @@ Determine the total annual cost of the request and the contact info of the Schoo
### Step 3: Verify that the project PI has a valid HPC user account
-The PI administers the top level RTS directory and grants access to other users. Thus ***the PI must have a valid HPC user account*** at the time of request. Please note that the HPC user account of NYU faculty never expires and thus does not need to be renewed every year. If the PI does not have an HPC account, please [request one here](../01_getting_started/02_getting_and_renewing_an_account.md).
+The PI administers the top level RTS directory and grants access to other users. Thus ***the PI must have a valid HPC user account*** at the time of request. Please note that the HPC user account of NYU faculty never expires and thus does not need to be renewed every year. If the PI does not have an HPC account, please [request one here](../01_getting_started/02_getting_and_renewing_an_account.mdx).
### Step 4: The PI submits the request to the HPC team via email
diff --git a/docs/hpc/05_submitting_jobs/03_slurm_tutorial.md b/docs/hpc/05_submitting_jobs/03_slurm_tutorial.md
index e1b0021ace..7e165f6b45 100644
--- a/docs/hpc/05_submitting_jobs/03_slurm_tutorial.md
+++ b/docs/hpc/05_submitting_jobs/03_slurm_tutorial.md
@@ -12,7 +12,7 @@ In NYU HPC clusters the users coming from many departments with various discipli
The Slurm software system is a resource manager and a job scheduler, which is designed to allocate resources and schedule jobs. Slurm is an open-source software, with a large user community, and has been installed on many top 500 supercomputers.
-- This tutorial assumes you have a NYU HPC account. If not, you may find the steps to apply for an account on the [Getting and renewing an account page](../01_getting_started/02_getting_and_renewing_an_account.md).
+- This tutorial assumes you have a NYU HPC account. If not, you may find the steps to apply for an account on the [Getting and renewing an account page](../01_getting_started/02_getting_and_renewing_an_account.mdx).
- It also assumes you are comfortable with Linux command-line environment. To learn about linux please read our [Linux Tutorial](../13_tutorial_intro_shell_hpc/01_intro.mdx).