diff --git a/.harper-dictionary.txt b/.harper-dictionary.txt new file mode 100644 index 0000000000..79a397e136 --- /dev/null +++ b/.harper-dictionary.txt @@ -0,0 +1 @@ +HPC diff --git a/docs/hpc/01_getting_started/02_getting_and_renewing_an_account.mdx b/docs/hpc/01_getting_started/02_getting_and_renewing_an_account.mdx index 63f6092e6e..c3be3cf395 100644 --- a/docs/hpc/01_getting_started/02_getting_and_renewing_an_account.mdx +++ b/docs/hpc/01_getting_started/02_getting_and_renewing_an_account.mdx @@ -16,33 +16,33 @@ This section deals with the eligibility for getting HPC accounts, the process to :::info - All **sponsored accounts** will be created for a period of 12 months, at which point a renewal process is required to continue to use the clusters -- Faculty, students and staff from the **NYU School of Medicine** require the sponsorship of an eligible NYU faculty member to access the NYU HPC clusters +- Faculty, students, and staff from the **NYU School of Medicine** require the sponsorship of an eligible NYU faculty member to access the NYU HPC clusters - **Non-NYU Researchers** who are collaborating with NYU researchers must obtain an affiliate status before applying for an NYU HPC account ::: :::warning -An HPC account gives you access to Torch, but an active allocation within the HPC projects management portal gives you access to a SLURM account which is needed to run jobs on Torch. More information on using the HPC project management portal can be found [here](./07_hpc_project_management_portal.mdx) +An active HPC account gives you access to Torch, but an active allocation within the HPC projects management portal gives you access to a SLURM account which is needed to run jobs on Torch. More information on using the HPC project management portal can be found [here](./07_hpc_project_management_portal.mdx) ::: -## Who is eligible for an NYU HPC account ? +## Who Is Eligible for an NYU HPC Account ? 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. -## Getting a new account on the NYU HPC clusters +## 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" 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. -## Renewing HPC account +## 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](05_walkthrough_renew_hpc_account.md) for a walkthrough of the process. -## Information for faculty who sponsor HPC users +## Information for Faculty Who Sponsor HPC Users All full-time NYU faculty members (other than NYU Med School) are eligible to become sponsors and in turn can sponsor: @@ -95,19 +95,19 @@ Accounts created for courses last until the end of the semester, rather than a f ## Non-NYU Researchers -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. +If you are collaborating 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. 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 +## Access to Cluster After Graduation If you will need to work on a project with an NYU researchers after graduation - refer to the section above for "Non-NYU Researchers" 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. -## VPN on a Linux machine +## VPN on a Linux Machine 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]. 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 index f9a7df7262..3f3f15f366 100644 --- a/docs/hpc/01_getting_started/03_walkthrough_request_hpc_account.mdx +++ b/docs/hpc/01_getting_started/03_walkthrough_request_hpc_account.mdx @@ -36,7 +36,7 @@ You need to be on the NYU VPN to perform this task! If the **Request HPC Account** QuickLink is clicked, the following form appears: ![Faculty request form](./static/faculty_request_form.png) - 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. + 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. If the **Bulk HPC Account Request** QuickLink is clicked, the following form appears: ![Bulk account request form](./static/bulk_acct_req_form.png) diff --git a/docs/hpc/01_getting_started/04_walkthrough_approve_hpc_account_request.md b/docs/hpc/01_getting_started/04_walkthrough_approve_hpc_account_request.md index eae00440ef..c59bd50082 100644 --- a/docs/hpc/01_getting_started/04_walkthrough_approve_hpc_account_request.md +++ b/docs/hpc/01_getting_started/04_walkthrough_approve_hpc_account_request.md @@ -1,4 +1,4 @@ -# How to approve an HPC Account Request +# How to Approve an HPC Account Request When someone nominates you as their HPC sponsor, you should be notified by email. diff --git a/docs/hpc/01_getting_started/07_hpc_project_management_portal.mdx b/docs/hpc/01_getting_started/07_hpc_project_management_portal.mdx index 3179a5dd82..25157dbb23 100644 --- a/docs/hpc/01_getting_started/07_hpc_project_management_portal.mdx +++ b/docs/hpc/01_getting_started/07_hpc_project_management_portal.mdx @@ -1,7 +1,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# HPC project management portal +# HPC Project Management Portal :::warning[Accessing the portal] diff --git a/docs/hpc/01_getting_started/08_creating_hpc_projects.mdx b/docs/hpc/01_getting_started/08_creating_hpc_projects.mdx index 2183ba8bbb..04531f535f 100644 --- a/docs/hpc/01_getting_started/08_creating_hpc_projects.mdx +++ b/docs/hpc/01_getting_started/08_creating_hpc_projects.mdx @@ -1,4 +1,4 @@ -# How to create a project on the HPC project management portal +# How to Create a Project on the HPC Project Management Portal :::info[VPN Needed] You need to be connected to [NYU VPN](https://www.nyu.edu/life/information-technology/infrastructure/network-services/vpn.html) to access the HPC project management portal. diff --git a/docs/hpc/01_getting_started/09_requesting_an_allocation.mdx b/docs/hpc/01_getting_started/09_requesting_an_allocation.mdx index 2875770c9e..51041aaf93 100644 --- a/docs/hpc/01_getting_started/09_requesting_an_allocation.mdx +++ b/docs/hpc/01_getting_started/09_requesting_an_allocation.mdx @@ -52,7 +52,7 @@ Now your allocation request is created! You'll see an allocation request with "N Once your school approver approves the request, the status will change to "Active" (and you will receive an email notifying you of the change). An active allocation now allows you to submit jobs on Torch. -## `SLURM` account association +## `SLURM` Account Association Within the "Allocations" section in the project, you'll see the `slurm_account_name` listed as shown below: !["SLURM account association"](./static/allocation_slurm_account_name.png) This account name needs to be specified via the `--account` flag to `srun` and `sbatch`. diff --git a/docs/hpc/01_getting_started/10_approving_an_allocation_request.mdx b/docs/hpc/01_getting_started/10_approving_an_allocation_request.mdx index a0fc165f5f..ca70c1d721 100644 --- a/docs/hpc/01_getting_started/10_approving_an_allocation_request.mdx +++ b/docs/hpc/01_getting_started/10_approving_an_allocation_request.mdx @@ -1,4 +1,4 @@ -# How to approve an allocation request +# How to Approve an Allocation Request :::info[VPN Needed] You need to be connected to [NYU VPN](https://www.nyu.edu/life/information-technology/infrastructure/network-services/vpn.html) to access the HPC project management portal. @@ -20,7 +20,7 @@ If you're done with adding the information, you could click "Update" button to u After clicking "Update", the allocation request is approved, and the allocation is activated now! !["Approved Allocation Requests via Details" section](./static/allocation_approved.png) -Slurm account name is also available on the allocation attributes if you need it. +The `SLURM` account name is also available on the allocation attributes if you need it. !["Approved Allocation Requests via Details" section](./static/slurm_account_name.png) If you have any difficulties or questions, please contact us at hpc@nyu.edu. diff --git a/docs/hpc/02_connecting_to_hpc/01_connecting_to_hpc.mdx b/docs/hpc/02_connecting_to_hpc/01_connecting_to_hpc.mdx index 4bc908bb83..b4a6428c5a 100644 --- a/docs/hpc/02_connecting_to_hpc/01_connecting_to_hpc.mdx +++ b/docs/hpc/02_connecting_to_hpc/01_connecting_to_hpc.mdx @@ -54,7 +54,7 @@ C:\WINDOWS\System32\notepad.exe $HOME\.ssh\config ``` Configuring the file above will allow you to use the cmd terminal to connect to Torch. -### Common issues +### Common Issues :::warning Man in the Middle warning If you see this warning: @@ -105,7 +105,7 @@ With [Windowns Terminal](https://apps.microsoft.com/detail/9n0dx20hk701?hl=en-US - If you are using WSL 2 (Windows subsystem for Linux 2), you may not be able to access internet when Cisco AnyConnect VPN, installed from exe file, is activated. A potential solution: uninstall Cisco AnyConnect and install AnyConnect using Microsoft Store, and then setup new VPN connection using settings described on [IT webpage][install vpn on windows link]. ::: -## Two-factor authentication for Torch +## Two-Factor Authentication for Torch There is an extra layer of security when accessing Torch which is described below: - Login as usual via the `ssh torch` command: