deploy: 7963528

SouthernMethodistUniversity · Aug 27, 2024 · 54c6b75 · 54c6b75
1 parent 3cc8317
commit 54c6b75
Show file tree

Hide file tree

Showing 29 changed files with 196 additions and 64 deletions.
diff --git a/_images/add_selected_users_alloc.png b/_images/add_selected_users_alloc.png
diff --git a/_images/alloc_panel.png b/_images/alloc_panel.png
diff --git a/_images/alloc_panel1.png b/_images/alloc_panel1.png
diff --git a/_images/allocations.png b/_images/allocations.png
diff --git a/_images/available_allocations.png b/_images/available_allocations.png
diff --git a/_images/change_permissions.png b/_images/change_permissions.png
diff --git a/_images/change_users_permissions.png b/_images/change_users_permissions.png
diff --git a/_images/eligible_users.png b/_images/eligible_users.png
diff --git a/_images/enable_notifications.png b/_images/enable_notifications.png
diff --git a/_images/i_agree.png b/_images/i_agree.png
diff --git a/_images/info.png b/_images/info.png
diff --git a/_images/info1.png b/_images/info1.png
diff --git a/_images/no_eligible_users.png b/_images/no_eligible_users.png
diff --git a/_images/ood_logo.png b/_images/ood_logo.png
diff --git a/_images/permissions.png b/_images/permissions.png
diff --git a/_images/permissions1.png b/_images/permissions1.png
diff --git a/_images/request_resource.png b/_images/request_resource.png
diff --git a/_images/review_button.png b/_images/review_button.png
diff --git a/_images/select_compute.png b/_images/select_compute.png
diff --git a/_images/select_storage.png b/_images/select_storage.png
diff --git a/_images/users_in_alloc.png b/_images/users_in_alloc.png
diff --git a/_sources/coldfront/add_remove_users.md b/_sources/coldfront/add_remove_users.md
@@ -42,7 +42,9 @@ Instructors and PI's are automatically assigned the ***Manager*** role within a
     ```
     ````
 
-5. Select the user(s) that you want to add from the list 
+5. Select which allocation you would like users to be added to within the project under <img src="../images/CF/add_remove_users/available_allocations.png" alt="Available Allocations" height="35">.
+
+6. Select the user(s) that you want to add from the list 
 
     ```{image} ../images/CF/add_remove_users/select_user.png
     :alt: select users
@@ -56,16 +58,26 @@ Instructors and PI's are automatically assigned the ***Manager*** role within a
     :height: 60px
     ```
 
-6. Click on <img src="../images/CF/add_remove_users/add_selected_users.png" alt="add selected users" height="35">
+7. Click on <img src="../images/CF/add_remove_users/add_selected_users.png" alt="add selected users" height="35">
 
-7. You can verify that a user has been added under Users on the Project/Class page.
+8. You can verify that a user has been added under Users on the Project/Class page.
 
 ### To an Allocation
 
 ```{note}
-When [requesting an allocation](https://southernmethodistuniversity.github.io/hpc_docs/coldfront/request_change_allocation.html) you can give permissions to existing users. The following instructions are for adding users to an active allocation.
+When [requesting an allocation](https://southernmethodistuniversity.github.io/hpc_docs/coldfront/request_change_allocation.html) you can give permissions to existing users. When [adding a user to a project initially](https://southernmethodistuniversity.github.io/hpc_docs/coldfront/add_remove_users.html#from-a-project-class), you can add them to active allocations. The following instructions are for adding existing users to an active allocation. 
 ```
 
+1. Navigate to the Allocation details page by clicking on the allocation under <img src="../images/CF/add_remove_users/info.png" alt="Information" height="40"> in the <img src="../images/CF/add_remove_users/alloc_panel.png" alt="Allocation Panel" height="40"> panel.
+
+2. Scroll down to the <img src="../images/CF/add_remove_users/users_in_alloc.png" alt="Users in Allocation" height="40"> panel and click on <img src="../images/CF/add_remove_users/add_users.png" alt="Add Users" height="40">.
+
+3. Select which users to add to the allocation. If it is a ***Storage*** allocation, you will also need to select their **Permissions** (*Read and Write* or *Read Only*).
+
+4. Click on <img src="../images/CF/add_remove_users/add_selected_users_alloc.png" alt="Add Selected Users to Allocation" height="40">.
+
+5. The user will still need to accept the Policies and Guidelines to use the allocation.
+
 ## Remove a User
 
 ### From a Project/Class
@@ -94,4 +106,35 @@ When [requesting an allocation](https://southernmethodistuniversity.github.io/hp
 
 3. Click on <img src="../images/CF/add_remove_users/update.png" alt="update user" height="40"/>
 
-### Allocation Permissions
+### Allocation Permissions (for ***Storage*** allocations only)
+
+1. Navigate to the Allocation details page by clicking on the allocation under <img src="../images/CF/add_remove_users/info.png" alt="Information" height="35"> in the <img src="../images/CF/add_remove_users/alloc_panel.png" alt="Allocation Panel" height="35"> panel.
+
+2. Scroll down to the <img src="../images/CF/add_remove_users/users_in_alloc.png" alt="Users in Allocation" height="35"> panel and click on <img src="../images/CF/add_remove_users/change_permissions.png" alt="Change Permissions" height="35">.
+
+3. From the <img src="../images/CF/add_remove_users/eligible_users.png" alt="Eligible Users" height="35">, set the desired Permissions.
+
+    ````{note}
+    Occassionally, it takes a while to provision users on the actual HPC systems. If you see a message like this
+    
+    ```{image} ../images/CF/add_remove_users/no_eligible_users.png
+    :alt: No users in project are currently eligible for a permissions change
+    :height: 30px
+    :align: center
+    ```
+
+    either your users have not accepted the Policies and Guidelines yet, or they are still being provisioned with their original permissions.
+    Check back in a few hours and users may be eligible for a permissions change.
+    ````
+
+4. Click on <img src="../images/CF/add_remove_users/change_users_permissions.png" alt="Change Users Permission" height="40">.
+
+### Notification Settings
+
+1. Under **Users** on your project page, you will see a column to <img src="../images/CF/add_remove_users/enable_notifications.png" alt="Enable Notifications" height="50">.
+
+2. Check or uncheck the box to enable or disable notifications for all users, or do so individually for each user.
+
+    ```{note}
+    You cannot disable notifications for someone with the ***Manager*** role. As the PI or Instructor, you are responsible for monitoring changes to allocations in your projects.
+    ```
diff --git a/_sources/coldfront/qs_student.md b/_sources/coldfront/qs_student.md
@@ -8,17 +8,28 @@ These instructions will help you get access to HPC resources in your class.
 
 ## In Class
 
-You will see your class and associated allocations on your dashboard. 
+Under <img src="../images/CF/quick_start/allocations.png" alt="Allocations" height="40"> you will see your class and associated allocations on your dashboard.
 Your class will have at least one allocation for **Compute** and possibly allocations for **Storage**. 
-You will see a button for **Pending Policies and Guidelines** next to each allocation.
-You will need to accept the Policies and Guidelines for *each* allocation in order to get access the those resources.
+
+For *each* allocation:
+
+1. Click on the **Review and Accept policies and guidelines to activate** button.
+
+    ```{image} ../images/CF/quick_start/review_button.png
+    :alt: Review and Accept policies and guidelines to activate
+    :height: 100px
+    ```
+
+2. Read the [HPC policies and guidelines](https://southernmethodistuniversity.github.io/hpc_docs/policies/policies.html), as well as the [ODSRCI guidelines](https://www.smu.edu/provost/odonnell-institute/hpc/guidelines).
+
+3. Click on <img src="../images/CF/quick_start/i_agree.png" alt="I Agree" height="40">.
 
 ```{note}
-Once you accept the Policies and Guidelines, they will be granted an HPC account.
+Once you accept the Policies and Guidelines, you will be granted an HPC account.
 In most cases this process is instantenous, however if your class has a large number of files in a storage allocation, this could take several minutes.
 ```
 
-If you are using the Open OnDemand portal [hpc.smu.edu](hpc.smu.edu) for your class, you will be able to click on the link in the top menu bar to go directly to the M3 Portal.
+If you are using the Open OnDemand portal [hpc.smu.edu](hpc.smu.edu) for your class, click on <img src="../images/CF/quick_start/ood_logo.png" alt="Open OnDemand Logo" height="40"> to go directly to the M3 Portal.
 
 If you are using `srun` commands or `sbatch` scripts, you will need to add the following to your commands/scripts in order to utilize the resources.
 
@@ -28,21 +39,16 @@ or
 
 `srun -A slurm_account_name …`
 
-The `slurm_account` can be found in the Information field under Allocations.
-
-```{image} ../images/CF/quick_start/resource_table.png
-:alt: resource table
-:width: 800px
-```
+The `slurm_account_name` can be found on the project page in the <img src="../images/CF/quick_start/info.png" alt="Information" height="40"> field under <img src="../images/CF/quick_start/alloc_panel.png" alt="Allocations" height="40">.
 
 ## To view your current usage
 
-1.	Under Allocations select the folder icon
-2.	You will see your Allocation details, Policies and Guidelines Agreements, and Usage by Hours
+1.	Under <img src="../images/CF/quick_start/alloc_panel.png" alt="Allocations" height="40"> select the folder icon
+2.	You will see your Allocation details, Policies and Guidelines Agreements, and Usage by Hours.
 
 
 ## Concluding the Semester
 
 At the end of the semester, your class will be Archived.
-Once you class is successfully archived, you will not be able to access any of the resources on the system. 
+Once your class is successfully archived, you will not be able to access any of the resources on the system. 
 Any files you have created that you wish to retain access to should be transferred off the HPC system.
diff --git a/_sources/coldfront/request_change_allocation.md b/_sources/coldfront/request_change_allocation.md
@@ -29,37 +29,44 @@ There are 3 fields to specify when requesting a ***Compute*** allocation: ***CPU
 
 ### Request ***Compute*** Allocation
 
-1. Select ***+ Request Resource Allocation***.
+1. Click on <img src="../images/CF/request_change_allocation/request_resource.png" alt="Request Resource Allocation" height="40"> in the Allocations box on your project page.
 
 2. Select ***Compute*** as your Resource from the dropwdown.
 
-3. Provide a 2-3 sentence justification for the resources you are requesting.
+    ```{image} ../images/CF/request_change_allocation/select_compute.png
+    :alt: Compute selected on Resource dropdown
+    :width: 800px
+    ```
+
+3. Provide a short description to make your allocation easier to identify.
+
+4. Provide a 2-3 sentence justification for the resources you are requesting.
 
-4. Select a Start Date and End Date for your allocation. The limit is 1 year, but can be renewed.
+5. Select a Start Date and End Date for your allocation. The limit is 1 year, but will be renewable when the end date is near.
 
-5. Enter the number of ***CPU hours*** you will need.
+6. Enter the number of ***CPU hours*** you will need.
 
     ```{admonition} General Guidelines
     :class: tip
     When requesting ***CPU hours***, you <u>MUST</u> request ***memory hours*** as well. The general guideline is that you need 4 ***memory hours*** for 1 ***CPU hour***. If you need assistance in determining how many hours to request, please submit a help desk ticket to [[email protected]](mailto:[email protected]) with [HPC] in the subject line.
     ```
 
-6. Enter the number of ***GPU hours*** you will need.
+7. Enter the number of ***GPU hours*** you will need.
 
     ```{admonition} General Guidelines
     :class: tip
     When requesting ***GPU hours***, you <u>MUST</u> request both ***CPU hours*** and ***memory hours*** as well. The general guideline is that you need 16 ***CPU hours*** and 96 ***memory hours*** per 1 ***GPU hour***. If you need assistance in determining how many hours to request, please submit a help desk ticket to [[email protected]](mailto:[email protected]) with [HPC] in the subject line.
     ```
 
-6. Enter the number of ***memory hours*** you will need.
+8. Enter the number of ***memory hours*** you will need.
 
-7. If you have users on your project, select which users should have access to the allocation.
+9. If you have users on your project, select which users should have access to the allocation.
 
-8. Please read and acknowledge that you will follow the ODSRCI Community Guidelines.
+10. Please read and acknowledge that you will follow the ODSRCI Community Guidelines.
 
-9. Click on Submit.
+11. Click on <img src="../images/CF/request_change_allocation/submit.png" alt="Submit" height="40">.
 
-10. Wait for your allocation to be approved by HPC Support.
+12. Wait for your allocation to be approved by HPC Support.
 
 ### Change ***Compute*** Allocation
 
@@ -76,6 +83,10 @@ To change a the ***CPU hours***, ***GPU hours***, or ***memory hours*** on a ***
     :height: 100px
     ```
 
+    ```{note}
+    When the End Date is approaching, you will be able to renew the project for another cycle. We encourage users to do this rather than extending the current cycle by 30-90 days.
+    ```
+
 4. If needed, update your ***CPU hours***, ***GPU hours***, and ***memory hours*** under <img src="../images/CF/request_change_allocation/attributes.png" alt="Allocation Attributes" height="40">.
 
     ```{note}
@@ -101,41 +112,53 @@ A ***Storage*** allocation is a shared directory with a quota on gigabytes (GB)
 
 ### Request ***Storage*** Allocation
 
-1. Select ***+ Request Resource Allocation***.
+1. Click on <img src="../images/CF/request_change_allocation/request_resource.png" alt="Request Resource Allocation" height="40"> in the Allocations box on your project page.
 
 2. Select ***Storage*** as your Resource from the dropwdown.
 
-3. Provide what you would like to name the shared folder. If a name is not provided, a generic name will be assigned.
+    ```{image} ../images/CF/request_change_allocation/select_storage.png
+    :alt: Storage selected on Resource dropdown
+    :width: 800px
+    ```
 
-4. Provide a 2-3 sentence justification for the resources you are requesting.
+3. Provide a short description to make your allocation easier to identify.
+
+4. Provide what you would like to name the shared folder. If a name is not provided, a generic name will be assigned.
+
+5. Provide a 2-3 sentence justification for the resources you are requesting.
 
-5. Select a Start Date and End Date for your allocation. The limit is 1 year, but can be renewed.
+6. Select a Start Date and End Date for your allocation. The limit is 1 year, but can be renewed.
 
-6. Enter the amount of storage you would like in GB.
+7. Enter the amount of storage you would like in GB.
 
     ```{note}
     This amount is a storage quota, which means you are capped at the provided GB, but are not guarunteed to get that much.
     ```
 
-7. Enter the number of files you expect to create or use in this allocation.
+8. Enter the number of files you expect to create or use in this allocation.
 
     ```{admonition} General Guidelines
     :class: tip
     - A conda environment needs about 100,000 files.
     - A safe bet for most people is 500,000 files for a storage allocation.
     ```
 
-8. If you have users on your project, select which users should have access to the shared folder and whether they should have ***Read and Write*** access or ***Read Only*** access. 
+9. If you have users on your project, select which users should have access to the shared folder and whether they should have ***Read and Write*** access or ***Read Only*** access. 
+
+    ```{image} ../images/CF/request_change_allocation/permissions.png
+    :alt: Permissions dropdown
+    :height: 100px
+    ```
 
     ```{note}
     ***Read Only*** means that they will only be able to see file contents, but not change them or create new files in the shared directory. ***Read and Write*** gives them full editing permissions.
     ```
 
-9. Please read and acknowledge that you will follow the ODSRCI Community Guidelines.
+10. Please read and acknowledge that you will follow the ODSRCI Community Guidelines.
 
-10. Click on Submit.
+11. Click on <img src="../images/CF/request_change_allocation/submit.png" alt="Submit" height="40">.
 
-11. Wait for your allocation to be approved by HPC Support.
+12. Wait for your allocation to be approved by HPC Support.
 
 ### Change ***Storage*** Allocation
 
@@ -152,6 +175,10 @@ To change the storage size or number of files in a ***Storage*** Allocation,
     :height: 100px
     ```
 
+    ```{note}
+    When the End Date is approaching, you will be able to renew the project for another cycle. We encourage users to do this rather than extending the current cycle by 30-90 days.
+    ```
+
 4. If needed, update your storage size and file count under <img src="../images/CF/request_change_allocation/attributes.png" alt="Allocation Attributes" height="40">.
 
     ```{note}