Merge pull request #216 from NYU-RTS/coldfront-improve

s-sajid-ali · web-flow · commit 46464884b4b9 · 2025-11-07T16:14:58.000-05:00
clarify that allocations are needed
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
@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
 # HPC project management portal
 
 :::warning[Only applicable to Torch]
-This section is only applicable to the Torch cluster!
+This section is only applicable to the Torch cluster. An active allocation is necessary to sumbmit jobs on Torch.
 :::
 
 The HPC project and allocation management portal for Torch can access it by navigating to [projects.hpc.nyu.edu](https://projects.hpc.nyu.edu). With it you can:
diff --git a/docs/hpc/01_getting_started/08_creating_hpc_projects.mdx b/docs/hpc/01_getting_started/08_creating_hpc_projects.mdx
@@ -14,3 +14,5 @@ If you are a PI, you will be able to see a "+ Add a Project" button that will le
 
 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.<br/>
 ![Project Create](./static/project_create.png)
+
+Please head to the next section to learn about how you can submit an allocation request.
diff --git a/docs/hpc/01_getting_started/09_requesting_an_allocation.mdx b/docs/hpc/01_getting_started/09_requesting_an_allocation.mdx
@@ -47,5 +47,9 @@ Please select a resource and fill in justification to complete the allocation re
 Now your allocation request is created! You'll see an allocation request with "New" status.
 !["Allocation request created" section](./static/allocation_request_created.png)
 
-Once your school approver approves the request, the status will change to "Active" (and you will receive an email notifying you of the change). 
+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
+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/static/allocation_slurm_account_name.png b/docs/hpc/01_getting_started/static/allocation_slurm_account_name.png
diff --git a/docs/hpc/05_submitting_jobs/01_slurm_submitting_jobs.md b/docs/hpc/05_submitting_jobs/01_slurm_submitting_jobs.md
@@ -4,6 +4,10 @@
 If you are new to using HPC resources and would like to learn about the principles of using the `SLURM` scheduler for submitting batch jobs, please refer to [this section](../13_tutorial_intro_hpc/04_scheduler_fundamentals.mdx). This section focuses on the specifics of the Torch cluster and assumes familiarity with the tutorial.
 :::
 
+:::warning Active allocation in the HPC projects portal
+An active allocation in the HPC projects portal is needed to submit any jobs on Torch. For more information on how to get one, please refer to [this section](../01_getting_started/07_hpc_project_management_portal.mdx). All job submissions must include the `--account` parameter.
+::: 
+
 ## Partitions
 
 `SLURM` partitions on Torch control stakeholder resource access. No physical nodes are tied to partitions — instead, equivalent compute resources are allocated via partition `QoS`([QualityOfService](https://slurm.schedmd.com/qos.html)).
