Skip to content

Commit bce34a5

Browse files
authored
Merge pull request #165 from NYU-RTS/review_getting_started
minor changes - All language choices help with clarity and consistency.
2 parents 6b34117 + 40cf134 commit bce34a5

7 files changed

+36
-31
lines changed

docs/hpc/01_getting_started/02_getting_and_renewing_an_account.mdx

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
1111

1212
[hpc account request form link for courses]: https://docs.google.com/forms/d/e/1FAIpQLSdehngqL1xso-YV6MOhplKNwxXjASHYnDtM_5THB3P2vrDKcg/viewform?usp=sf_link
1313

14-
This section deals with the eligibility for getting HPC accounts, the process to create new accounts, renew existing ones and touches on access policies after graduation from NYU and access for non-NYU researchers.
14+
This section deals with the eligibility for getting HPC accounts, the process to create new accounts, renew existing ones, touches on access policies after graduation from NYU, and access for non-NYU researchers.
1515

1616
:::info
1717

@@ -23,12 +23,12 @@ This section deals with the eligibility for getting HPC accounts, the process to
2323

2424
## Who is eligible for an NYU HPC account ?
2525

26-
NYU HPC clusters and related resources are available to full-time NYU faculty and to all NYU staff and, students with sponsorship from a full-time NYU faculty.
26+
NYU HPC clusters and related resources are available to full-time NYU faculty and to all NYU staff and students with sponsorship from a full-time NYU faculty.
2727

2828

2929
## Getting a new account on the NYU HPC clusters
3030

31-
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.
31+
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" by clicking on the hamburger icon on the top left of the page and selecting "Manage Access" . 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 will need an NYU faculty sponsor.
3232

3333
## Renewing HPC account
3434

@@ -50,7 +50,7 @@ All full-time NYU faculty members (other than NYU Med School) are eligible to be
5050

5151
- Non-NYU researchers with whom they are actively collaborating
5252

53-
If you need to sponsor an HPC account for an external collaborator (for example, for an NYU alumnus), please, request a "research affiliate" affiliation for your collaborator. You can find the instructions at https://start.nyu.edu/.
53+
If you need to sponsor an HPC account for an external collaborator (for example, for an NYU alumnus), please, request that they become a "research affiliate". You can find the instructions at https://start.nyu.edu/.
5454

5555
You can request a NetID for your student(s) or collaborator(s) at https://start.nyu.edu/pwm/public/. The request form has additional information about affiliates.
5656

@@ -73,32 +73,35 @@ HPC bulk accounts request is disabled for HPC sponsors.
7373
- 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)
7474

7575
- 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
76-
77-
- Note that accounts created for courses last until the end of the semester, rather than a full year.
78-
76+
:::note
77+
Accounts created for courses last until the end of the semester, rather than a full year.
78+
:::
7979
## Getting an account with one of NYU partners
8080

81-
NYU partners (\[look for the list here]) with many state and national facilities with a variety of HPC systems and expertise. \[Contact us] for assistance setting up a collaboration with any of these.
81+
\[NYU partners with many state and national facilities](**TODO:link to list**) with a variety of HPC systems and expertise.
82+
83+
[Contact us](email:hpc@nyu.edu) for assistance setting up a collaboration with any of these.
8284

8385
## Non-NYU Researchers
8486

85-
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.
87+
If you are collaboratng with NYU researchers you will need to obtain **affiliate** status before applying for an NYU HPC account. A full-time NYU faculty member must sponsor a non-NYU collaborator for affiliate status.
8688

8789
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).
8890

8991

9092
## Access to cluster after Graduation
9193

92-
If you will still work on a project with an NYU researchers after graduation - refer to the section above for "Non-NYU Researchers"
94+
If you will need to work on a project with an NYU researchers after graduation - refer to the section above for "Non-NYU Researchers"
9395

94-
If you are not part of a collaboration, your access to cluster will end together with NetID becoming non-active. Please copy all your data cluster (if you need any) before that time.
96+
If you are not part of a collaboration, your access to the cluster will end with your NetID becoming non-active. Please copy all your data from the cluster (if you need any) before that time.
9597

9698

9799
## VPN on a Linux machine
98100

99-
:::note
101+
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].
100102

101-
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:
103+
:::tip
104+
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:
102105

103106

104107
<Tabs>

docs/hpc/01_getting_started/03_walkthrough_request_hpc_account.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ import TabItem from '@theme/TabItem';
33

44
# How to request an HPC account
55

6-
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.mdx)
7-
8-
:::info VPN Needed
9-
You need to be on the NYU VPN to perform this task!
6+
:::tip
7+
Make sure you don't already have an HPC 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.mdx).
108
:::
119

1210
Login to the URL given below, using your NetID/password, to create or manage HPC Account Requests:
1311
https://identity.it.nyu.edu/
14-
12+
:::info VPN Needed
13+
You need to be on the NYU VPN to perform this task!
14+
:::
1515

1616
<Tabs>
1717
<TabItem value="end-users" label="Researcher/End-User" default>
@@ -25,7 +25,7 @@ https://identity.it.nyu.edu/
2525

2626
![Request account left hand button](./static/request_account.png)
2727

28-
You will be prompted with a form. Continue to fill it out and Submit.
28+
You will be prompted with a form. Please fill it out and Submit.
2929
![Request account form](./static/request_form.png)
3030
</TabItem>
3131
<TabItem value="sponsors" label="Faculty/Sponsor/Approver">

docs/hpc/01_getting_started/05_walkthrough_renew_hpc_account.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,17 @@ The burger menu will show an "Update/Renew HPC Account" option - select this.
2121
Next complete the form as instructed. Please note that all accounts require the sponsorship of a full-time NYU faculty member.
2222
![Select sponsor](./static/renew_04.png)
2323

24-
The user’s name will be pre-populated, 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.
24+
The user’s name will be pre-populated, and the form's 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.
2525

26-
NOTE: If your HPC Account is due for renewal you will get an update on your dashboard which will suggest you to fill out a form given in the "Latest form" widget for renewing your account
26+
:::note
27+
If your HPC Account is due for renewal, you will get an update on your dashboard that will suggest that you fill out a form given in the "Latest form" widget for renewing your account:
2728
![Banner messages](./static/renew_05.png)
29+
:::
2830

2931
If you are not a full-time NYU faculty member, you will need an NYU faculty member to sponsor your application. This is probably your thesis supervisor, or NYU collaborator.
3032

3133
Hit submit, and the request will go to your sponsor to approve (if applicable), and your account will be created, usually within a day of being approved.
3234

33-
You will be returned to the dashboard, and now you should see your request in the "Pending Approvals" tables.
35+
You will be returned to the dashboard, and now you should see your request in the "Pending Approvals" table.
3436

3537
If after a few days you still do not have an account, check with your sponsor - they may have missed a step in the approval process. If you are still stuck, contact us at hpc@nyu.edu for assistance.

docs/hpc/01_getting_started/06_hpc_accounts_external_collaborators.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@
22

33
External (non-NYU) collaborators can access, with proper sponsorship, the NYU HPC Environment.
44

5-
- The first step is to sponsor a collaborator for an NYU netid (if they do not have one already). A department administrator or the faculty sponsor must submit the [Affiliate Management Form](https://identity.it.nyu.edu/identityiq/plugins/pluginPage.jsf?pn=AffiliateManagement) (the link is only accessible over VPN, or within NYU-Net).
6-
- Once a netid for the external collaborator is created, the collaborator must submit the [Request for an NYU HPC account](https://identity.it.nyu.edu/identityiq/workitem/commonWorkItem.jsf#/commonWorkItem/session).
5+
- The first step is to sponsor a collaborator for an NYU NetID (if they do not have one already). A department administrator or the faculty sponsor must submit the [Affiliate Management Form](https://identity.it.nyu.edu/identityiq/plugins/pluginPage.jsf?pn=AffiliateManagement) (the link is only accessible over VPN, or within NYU-Net).
6+
- Once a NetID for the external collaborator is created, the collaborator must submit the [Request for an NYU HPC account](https://identity.it.nyu.edu/identityiq/workitem/commonWorkItem.jsf#/commonWorkItem/session) form.
77
:::tip
88
- The collaborator must setup [VPN access][nyu vpn link] to be able to access the HPC account request form.
9-
- The collaborator must enter in the account request form the Netid of the sponsoring NYU Full time faculty
9+
- The collaborator must enter in the account request form the NetID of the sponsoring NYU Full time faculty
1010
- The collaborator should select "External Collaborator" as Affiliation, when filing the HPC account request form.
1111
:::
1212
- Once the HPC request is submitted, the sponsoring faculty will receive an email with a [link to approve (or deny) the HPC account request](https://identity.it.nyu.edu/identityiq/workitem/workItems.jsf#/workItems) for the external collaborator. The [account approval link](https://identity.it.nyu.edu/identityiq/workitem/workItems.jsf#/workItems) can only be accessed [over VPN][nyu vpn link].
1313
:::note
1414
Once the sponsoring faculty approves the account request, the HPC account is created within one hour.
1515
:::
16-
- Once the HPC account is created, the external collaborator can access HPC resources as described here.
16+
- Once the HPC account is created, the external collaborator can access HPC resources as described in our documentation page [Connecting to the HPC Cluster](../02_connecting_to_hpc/01_connecting_to_hpc.mdx).
1717

1818
:::note
19-
As with all sponsored accounts, HPC accounts for external collaborators are valid for a period of 12 months, at which point a renewal process is required to continue access to the NYU HPC environment.
19+
As with all sponsored accounts, HPC accounts for external collaborators are valid for a period of 12 months, at which point a renewal process is required to continue access to the NYU HPC environment. You can find information about renewing your account on our documentation page [Getting and Renewing an HPC Account](./02_getting_and_renewing_an_account.mdx).
2020
:::
2121

2222
[nyu vpn link]: https://www.nyu.edu/life/information-technology/infrastructure/network-services/vpn.html

docs/hpc/01_getting_started/08_coldfront_creating_a_project.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Login to coldfront at [coldfront.hpc.nyu.edu](https://coldfront.hpc.nyu.edu) eit
44
![Project Dropdown](./static/project_dropdown.png)
55

66
<br/>
7-
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. <br/>
7+
If you are a PI, you will be able to see a "+ Add a Project" button that will let you create a new project. <br/>
88

99
![Project Add Button](./static/project_add_button.png)
1010

docs/hpc/01_getting_started/09_coldfront_requesting_an_allocation_request.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Scroll down and you'll reach the Allocations section. This section lists all the
1616
If you scroll down, you'll see "+Request Resource Allocation" button.
1717
!["PI request allocation" section](./static/PI_request_allocation.png)
1818

19-
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.
19+
After clicking "+Request Resource Allocation", you'll see a list of resources you can request. 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 may be available.
2020

2121
:::info Available resource for each school:
2222
<Tabs>

docs/hpc/01_getting_started/10_approving_an_allocation_request.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# How to approve an allocation request
22

3-
If you are an approver for your school, first login to coldfront page and you'll see "staff" navigation bar.
3+
If you are an approver for your school, first login to the coldfront page and you'll see "staff" in the navigation bar.
44
Click the "staff" navigation bar and click "Allocation Requests" to see a list of requests waiting for your approval.
55
!["Staff Allocation Requests" section](./static/approver_staff.png)
66

77
Now, you'll see a list of allocation requests. Click "Details" button for the request that you would like to approve.
88
You should click "Details" instead of just "Approve" button if you'd like to set more details.
99
!["Allocation Requests Details" section](./static/allocation_requests.png)
1010

11-
After clicking "Details", now you'll see Allocation information part to fill in with your approval.
11+
After clicking "Details", you'll see Allocation information part to fill in with your approval.
1212
Here, you could set start date, end date, description, etc.
1313
If you're done with adding the information, you could click "Update" button to update the allocation request with the information you put.
1414
!["Approving Allocation Requests via Details" section](./static/approving_allocation.png)

0 commit comments

Comments
 (0)