Added RMACC allocation info to allocations.md

docs/clusters/alpine/allocations.md

@@ -1,3 +1,13 @@
+---
+myst:
+    substitutions:
+        trailhead_SUs: "2,000"
+        boulder_ascent_SUs: "350,000"
+        boulder_ascent_SU_group_limit: "1.4 M"
+        boulder_peak_SUs: "6,000,000"
+        rmacc_ascent_SUs: "100,000"
+---
+
 # Alpine Allocations
 
 ## What are allocations and why do I need one?
@@ -28,11 +38,13 @@ A Level Fairshare (`LevelFS`) is a value calculated by [Slurm's Fairshare
 Algorithm](https://slurm.schedmd.com/fair_tree.html). A user's 
 assigned shares (determined by their allocation) and usage (based on their 
 job history) contribute to their `LevelFS` value. Information on how to 
-check your `LevelFS` score can be found 
-[here](../../getting_started/faq.md#how-can-i-see-my-current-fairshare-priority).
+check your `LevelFS` score can be found on the 
+["How can I see my current FairShare priority?"](../../getting_started/faq.md#how-can-i-see-my-current-fairshare-priority) section of our FAQ page.
 
-Note that if there are no other pending jobs and enough resources are 
-available then your job will run regardless of your previous usage.
+```{note}
+If there are no other pending jobs, and enough resources are 
+available, then your job will run regardless of your previous usage.
+```
 
 ### Priority Score
 When you request resources on Alpine, your job's priority determines its 
@@ -41,74 +53,270 @@ multiple factors, including (but not limited to) FairShare score, job age,
 resources requested, job size, and QOS. 
 
 ### Allocations
-When you receive a Research Computing account you are automatically 
+
+```{warning}
+**Allocations for CSU and AMC are managed by those institutions.** Please see the **CSU** and **AMC** tabs in each section below for more information.
+```
+
+
+#### Alpine Allocation Tiers
+
+(tabset-ref-alpine-alloc-tiers)=
+`````{tab-set}
+:sync-group: tabset-alpine-allocs
+
+````{tab-item} CU Boulder
+:sync: alpine-cub-inst
+
+**Trailhead:**
+
+When you receive a Research Computing account, you are automatically 
 assigned a **Trailhead Auto-Allocation**, which grants you a fixed share 
-of `ucb-general`. The Trailhead is a great allocation for smaller jobs or 
-testing and benchmarking your code. However, if you consume more than your 
-fixed share of `ucb-general`,  your `LevelFS` will decrease, causing your 
+of `ucb-general`.
+
+The Trailhead is a great allocation for smaller jobs or 
+testing and benchmarking your code. However, if you consume more than your allocated share of `ucb-general`,  your `LevelFS` will decrease, causing your 
 priority score to decrease. The end result is that your jobs will sit 
-lower (read: longer) in the queue relative to other jobs. One way to 
-combat this is to apply for an allocation.
+lower (i.e., longer) in the queue relative to other jobs.
 
-## Alpine Allocation Tiers
+One way to combat this is to apply for an allocation. In addition to the Trailhead auto-allocation (`ucb-general`) that all users are awarded automatically, CURC offers two 
+additional tiers to accommodate larger computing needs on Alpine, called **Ascent** and **Peak**.
 
-In addition to the Trailhead auto-allocation (`ucb-general`) that all users are awarded automatically, CURC offers two 
-additional tiers to accommodate larger computing needs on Alpine. The **Ascent Allocation** tier provides users 
-with 350,000 SUs over a 12 month period. The **Peak Allocation** tier is 
-aimed at projects that will consume between 350,000 and 6,000,000 SUs in a 
-12 month period. Users may apply for these tiers as described below.
+**Ascent:**
 
-CURC's tiered allocations are structured in a way such that your jobs are 
-likely to have a higher priority if they are running in Ascent or Peak 
-Allocations than if they are running in a Trailhead 
-Auto-Allocation.
+The **Ascent** allocation tier provides CU Boulder users 
+with {{ boulder_ascent_SUs }} SUs over a 12 month period. Please see the table below for a comparison with other allocation tiers; application instructions are in the next section.
+
+**Peak:**
+
+The **Peak Allocation** tier is 
+aimed at projects that will consume between {{ boulder_ascent_SUs }} and {{ boulder_peak_SUs }} SUs in a 
+12 month period. Please see the table below for a comparison with other allocation tiers; application instructions are in the next section.
+
+**Comparison of Allocation Tiers:**
 
-### Comparing Trailhead Auto-Allocation, Ascent Allocation, and Peak Allocation Tiers
+::::{dropdown} Show 
+:icon: note
 
 The following table summarizes the required information, size, approval 
 process, and renewal requirements for each tier.
 
-![](images/alpine-allocation-tiers-chart.png)
+|                          | **Trailhead Auto-Allocation**                                                | **Ascent Allocation**                                                                                                                                                                                                                      | **Peak Allocation**                                                                                                                                                                                                                                                                                                              |
+|--------------------------|------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Required information** | - None                                                                       | - Title and project description<br>- Funding information<br>- Field of study/research area<br>- PI and role<br>- IdentiKeys of collaborators<br>- Slurm partitions to be used<br>- Acknowledgement of CURC User Polices                    | - All information required by Ascent allocation<br>- Example jobs<br>- List of software the project utilizes and how they will install each application                                                                                                                                                                          |
+| **Size**                 | - Approximately {{ trailhead_SUs }} SUs per month                                          | - Equivalent to 0.25% of the system (currently {{ boulder_ascent_SUs }} SUs) for one year<br>- Total SU limit equal to 1% of the system (currently {{ boulder_ascent_SU_group_limit }} SUs) per research group/PI<br>    - Group members may divide this among as many allocations as desired | - Variable (based on user's request), but must not exceed the number of SUs equivalent to 5% of the system (currently {{ boulder_peak_SUs }} SUs) over a one-year period<br>- Members of research group may divide the maximum amount of SUs among as many or as few allocations as they desire                                                      |
+| **Approval process**     | - Automatically granted when users register for a Research Computing account | - Approved quickly and without review by the Allocations Committee<br>- User Support will include summary information about Ascent allocations from the previous month in the monthly Allocations Committee meeting                        | - Peak allocation proposals will be initially reviewed by a member of CURC User Support<br>    - Users may be asked to improve the memory efficiency and CPU efficiency of their jobs<br>- Once the team member is satisfied with the proposal, it will be reviewed by the Allocations Committee during the next monthly meeting |
+| **Renewal requirements** | - None; Trailhead allocations do not expire                                  | - Sign their acknowledgement of CURC User Policies<br>- There is no limit to the number of renewals                                                                                                                                        | - Same as Ascent allocation renewal requirements, but users may be asked to justify the size of their allocation based on the previous year's usage                                                                                                                                                                              |
 
 Individual and group size limits for new and renewed allocations will be 
 reviewed on an annual basis.
 
-### Get an Ascent Allocation 
+::::
+
+
+````
+
+````{tab-item} RMACC
+:sync: alpine-rmacc-inst
+
+**Trailhead:**
+
+When you receive a Research Computing account, you are automatically 
+assigned a **Trailhead Auto-Allocation**, which grants you a fixed share 
+of `rmacc-general`.
+
+The Trailhead is a great allocation for smaller jobs or 
+testing and benchmarking your code. However, if you consume more than your allocated share of `rmacc-general`,  your `LevelFS` will decrease, causing your 
+priority score to decrease. The end result is that your jobs will sit 
+lower (i.e., longer) in the queue relative to other jobs.
+
+One way to combat this is to apply for an allocation. In addition to the Trailhead auto-allocation (`rmacc-general`) that all users are awarded automatically, CURC offers RMACC users an 
+additional tier to accommodate larger computing needs on Alpine, called RMACC Ascent.
+
+**Ascent:**
+
+The RMACC Ascent tier provides users with {{ rmacc_ascent_SUs }} SUs over a 12 month period. Please see the table below for a comparison with other allocation tiers; application instructions are in the next section.
+
+**Peak:**
+
+At this time, RMACC users are not eligible for Peak allocations. However, if you are an RMACC user with additional resource needs beyond the RMACC Ascent allocation, please contact us at (<[email protected]>).
+
+**Comparison of Allocation Tiers:**
+
+::::{dropdown} Show 
+:icon: note
+
+The following table summarizes the required information, size, approval 
+process, and renewal requirements for each tier.
+
+|                          | **Trailhead Auto-Allocation**                                                | **RMACC Ascent Allocation**                                                                                                                                                                                                                                        |
+|--------------------------|------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **Required information** | - None                                                                       | - Title and project description<br>- Funding information<br>- Field of study/research area<br>- Institutional affiliation<br>- PI and role<br>- ACCESS/XSEDE usernames of collaborators<br>- Slurm partitions to be used<br>- Acknowledgement of CURC User Polices |
+| **Size**                 | - Approximately {{ trailhead_SUs }} SUs per month                                          | - Currently {{ rmacc_ascent_SUs }} SUs                                                                                                                                                                                                                                            |
+| **Approval process**     | - Automatically granted when users register for a Research Computing account | - Approved quickly and without review by the Allocations Committee                                                                                                                                                                                                 |
+| **Renewal requirements** | - None; Trailhead allocations do not expire                                  | - Handled on a case-by-case basis; please contact us  
+
+Individual and group size limits for new and renewed allocations will be 
+reviewed on an annual basis.
+
+::::
+
+````
+
+````{tab-item} CSU
+:sync: alpine-csu-inst
+
+**Allocations for CSU are managed by that institution.** CSU users who are interested in learning about their institution's Alpine allocation processes should email (<[email protected]>).
+
+````
+
+````{tab-item} AMC
+:sync: alpine-amc-inst
+
+**Allocations for AMC are managed by that institution.** AMC users who are interested in learning about their institution's Alpine allocation processes should email (<[email protected]>).
+
+````
+
+`````
+
+
+```{note}
+CURC's tiered allocations are structured in a way such that your jobs are 
+likely to have a higher priority if they are running in Ascent, Peak, or RMACC Ascent 
+Allocations than if they are running in a Trailhead 
+Auto-Allocation.
+```
+
+#### Get an Allocation
+
+(tabset-ref-alpine-alloc-procs)=
+`````{tab-set}
+:sync-group: tabset-alpine-allocs
+
+````{tab-item} CU Boulder
+:sync: alpine-cub-inst
+
+**Ascent:**
 
 Step 1: Fill out the [Ascent Allocation 
 Request](https://forms.office.com/r/eAA15b8Gsg) form. You need to be 
-logged in to Office365 with your CU Boulder account.
+logged in to Office 365 with your CU Boulder account.
 
-Step 2: Look out for an email message from the CURC ticketing system (<[email protected]>) indicating when your allocation is ready to 
-use.
+Step 2: Look out for an email message from the CURC ticketing system (<[email protected]>) indicating when your allocation is ready to use.
 
-### Get a Peak Allocation 
+**Peak:**
 
 Step 1: Download and complete the [Peak Allocation Request Supplementary 
 Information](https://o365coloradoedu.sharepoint.com/:x:/s/RC-Team/EajdPBAejjpDru7kvEEA29QBI8CoO8lj7-kUjotBIIusEg?e=geLBBP) 
-document. You need to be logged into Office365 with your CU Boulder 
+document. You need to be logged into Office 365 with your CU Boulder 
 account.
 
 Step 2: Fill out the [Peak Allocation 
 Request](https://forms.office.com/r/5VtLpiCh01) form. You need to be 
-logged into Office365 with your CU Boulder account.
+logged into Office 365 with your CU Boulder account.
 The last question will ask you to upload your completed Peak Allocation 
 Request Supplementary Information document from step 1. 
 
 Step 3: Look out for email messages from the CURC ticketing system (<[email protected]>). User Support will contact you when the proposal 
 is received, during the initial 
 review stages, and when the allocation is ready to use.
 
-### Renewing Your Allocation
+
+````
+
+````{tab-item} RMACC
+:sync: alpine-rmacc-inst
+
+**Ascent:**
+
+Step 1: Fill out the [RMACC Ascent Allocation 
+Request](https://forms.office.com/Pages/ResponsePage.aspx?id=G4vtPQ0HKUaC5MCwGfRgVxVuc407_5dMhLp4SuO1aoJUODlNNThXTTRUNklTQk02TlFKV1gxUUZTWCQlQCN0PWcu) form. You need to be 
+logged in to Office 365 with your CU Boulder account.
+
+Step 2: Look out for an email message from the CURC ticketing system (<[email protected]>) indicating when your allocation is ready to use.
+
+**Peak:**
+
+At this time, RMACC users are not eligible for Peak allocations. However, if you are an RMACC user with additional resource needs beyond the RMACC Ascent allocation, please contact us at (<[email protected]>).
+
+````
+
+````{tab-item} CSU
+:sync: alpine-csu-inst
+
+**Allocations for CSU are managed by that institution.** CSU users who are interested in learning about their institution's Alpine allocation processes should email (<[email protected]>).
+
+````
+
+````{tab-item} AMC
+:sync: alpine-amc-inst
+
+**Allocations for AMC are managed by that institution.** AMC users who are interested in learning about their institution's Alpine allocation processes should email (<[email protected]>).
+
+````
+
+`````
+
+#### Renewing Your Allocation
+
+```{note}
+**Trailhead** Auto-Allocations do not expire.
+```
+
+(tabset-ref-alpine-alloc-renew)=
+`````{tab-set}
+:sync-group: tabset-alpine-allocs
+
+````{tab-item} CU Boulder
+:sync: alpine-cub-inst
+
+**Ascent:**
 
 Step 1: Keep an eye on your email inbox for a notification that your allocation is about to expire. Notifications will be sent one month prior to expiration to give you plenty of time to renew. Allocations will automatically expire one year after they are provisioned. 
 
-Step 2: Fill out either the [Peak Allocation Renewal](https://forms.office.com/r/wimT1SCsWz) form, or the [Ascent Allocation Renewal](https://forms.office.com/r/1ymj7gxQF3) form. You need to be logged into Office365 with your CU Boulder account.
+Step 2: Fill out the [Ascent Allocation Renewal](https://forms.office.com/r/1ymj7gxQF3) form. You need to be logged into Office 365 with your CU Boulder account.
 
 Step 3: Look out for email messages from the CURC ticketing system (<[email protected]>). User Support will contact you when the renewal request is received and when the renewed allocation is ready to use.
 
-Alpine is jointly funded by the University of Colorado Boulder, the University of Colorado Anschutz, Colorado State University, and the 
-National Science Foundation (award 2201538).
+**Peak:**
 
+Step 1: Keep an eye on your email inbox for a notification that your allocation is about to expire. Notifications will be sent one month prior to expiration to give you plenty of time to renew. Allocations will automatically expire one year after they are provisioned. 
+
+Step 2: Fill out the [Peak Allocation Renewal](https://forms.office.com/r/wimT1SCsWz) form. You need to be logged into Office 365 with your CU Boulder account.
 
+Step 3: Look out for email messages from the CURC ticketing system (<[email protected]>). User Support will contact you when the renewal request is received and when the renewed allocation is ready to use.
+
+
+````
+
+````{tab-item} RMACC
+:sync: alpine-rmacc-inst
+
+**Ascent:**
+
+Step 1: Keep an eye on your email inbox for a notification that your allocation is about to expire. Notifications will be sent one month prior to expiration to give you plenty of time to renew. Allocations will automatically expire one year after they are provisioned. 
 
+Step 2: Please send an email to <[email protected]> requesting the renewal of your allocation. Be sure to provide your CURC username, the name of your allocation, and the CURC usernames of any of your collaborators.
+
+Step 3: Look out for email messages from the CURC ticketing system (<[email protected]>). User Support will contact you when the renewal request is received and when the renewed allocation is ready to use.
+
+````
+
+````{tab-item} CSU
+:sync: alpine-csu-inst
+
+**Allocations for CSU are managed by that institution.** CSU users who are interested in learning about their institution's Alpine allocation processes should email (<[email protected]>).
+
+````
+
+````{tab-item} AMC
+:sync: alpine-amc-inst
+
+**Allocations for AMC are managed by that institution.** AMC users who are interested in learning about their institution's Alpine allocation processes should email (<[email protected]>).
+
+````
+
+`````
+
+Alpine is jointly funded by the University of Colorado Boulder, the University of Colorado Anschutz, Colorado State University, and the 
+National Science Foundation (award 2201538).

docs/conf.py

@@ -5,7 +5,7 @@
 extensions = ['myst_parser', 'sphinx_copybutton', 'sphinx.ext.graphviz', 'sphinx_design', 'sphinx.ext.extlinks']
 graphviz_output_format = 'svg'
 
-myst_enable_extensions = ["colon_fence", "attrs_inline", "attrs_block", "tasklist"]
+myst_enable_extensions = ["colon_fence", "attrs_inline", "attrs_block", "tasklist", "substitution"]
 myst_enable_checkboxes = True
 
 source_suffix = {