Merge branch 'main' into ood_slurm_accounts

Author: jrlagrone

.gitignore

@@ -2,3 +2,4 @@
 .ipynb_checkpoints
 /workshops/minted_cache
 *.sif
+/docs/_build

docs/_config.yml

@@ -5,3 +5,11 @@ execute:
   execute_notebooks: "off"
 html:
   favicon: "./images/favicon.ico"
+parse:
+  myst_enable_extensions:
+    - colon_fence
+    - dollarmath
+    - linkify
+    - substitution
+    - tasklist
+    - html_image

docs/_toc.yml

@@ -14,6 +14,17 @@ parts:
   - file: portal.md
   - file: m3_migration.md
   - file: mp_update.md
+- caption: ColdFront
+  chapters:
+  - file: coldfront/quick_start.md
+    sections:
+    - file: coldfront/qs_instructor.md
+    - file: coldfront/qs_student.md
+  - file: coldfront/add_change_project.md
+  - file: coldfront/add_class.md
+  - file: coldfront/add_remove_users.md
+  - file: coldfront/request_change_allocation.md
+  - file: coldfront/faq.md
 - caption: Applications
   chapters:
   - file: examples/chemistry.md
@@ -46,7 +57,7 @@ parts:
     sections:
     - file: tutorials/r/environments.md
     - file: tutorials/r/slurm.md
-- caption: Policies
+- caption: Policies and Guidelines
   chapters:
   - file: policies/policies.md
 

docs/about/queues.md

@@ -85,5 +85,5 @@ The following job restrictions apply:
 
 Exceptions may be requested, for example, to run a job on all 20 SuperPOD nodes.
 Approval for any such requests will be the responsibility of the 
-[O’Donnell Data Science and Research Computing Institute](https://www.smu.edu/Provost/Data-Science-Institute)
+[O’Donnell Data Science and Research Computing Institute](https://www.smu.edu/provost/odonnell-institute)
 and will be based on demonstrated need and impact to other users.

docs/coldfront/add_change_project.md

@@ -0,0 +1,79 @@
+# Add or Change Project
+
+```{note}
+Only benefits eligible faculty or staff can create a project.
+```
+
+## Add a Project
+
+1. Click on
+
+    ```{image} ../images/CF/add_change_project/add_project.png
+    :alt: add project
+    :width: 400px
+    ```
+
+2. Give your project a meaningful title.
+
+    ```{image} ../images/CF/add_change_project/title.png
+    :alt: title
+    :width: 800px
+    ```
+
+3. Give your project a meaningful short descriptor. If this is left blank a number will be generated for you.
+
+    ```{image} ../images/CF/add_change_project/short_desc.png
+    :alt: short descriptor
+    :width: 800px
+    ```
+
+    ```{warning}
+    The short descriptor cannot be changed later.
+    ```
+
+4. Give your project a meaningful description.
+
+    ```{image} ../images/CF/add_change_project/description.png
+    :alt: long description
+    :width: 800px
+    ```
+
+5. Select all Departments associated with this project.
+
+    ```{image} ../images/CF/add_change_project/departments.png
+    :alt: departments
+    :width: 800px
+    ```
+
+6. Select all relevant Fields of Study.
+
+    ```{image} 
+    :alt: fields of study
+    :width: 800px
+    ```
+
+7. Select whether or not you have a Data Management Plan. This will not affect your ability to make a project.
+
+    ```{image} ../images/CF/add_change_project/dmp.png
+    :alt: data management plan
+    :width: 800px
+    ```
+
+8. Select your expected end date for the project. This can be extended.
+
+    ```{image} ../images/CF/add_change_project/end_date.png
+    :alt: end date
+    :width: 800px
+    ```
+
+9. Please read and acknowledge that you will follow the ODSRCI Community Guidelines.
+
+10. Click <img src="../images/CF/add_change_project/save.png" alt="Save" height="40"> to create the project.
+
+## Change a Project
+
+1. From the project page, click on <img src="../images/CF/add_change_project/update_project.png" alt="update project information" height="40">.
+
+2. Change any relevant information for Title, Description, Field of Science, and Departments.
+
+3. Click on <img src="../images/CF/add_change_project/save.png" alt="save" height="40">.

docs/coldfront/add_class.md

@@ -0,0 +1,85 @@
+# Add a Class
+
+```{note}
+Only benefits eligible faculty or staff can create a class.
+```
+
+These instructions will help you get access to HPC resources for your class.
+If you are the instructor of record in my.smu, much of this process will be easy and automated for you.
+If you are not an instructor of record for a course but would like to set up a course (e.g. workshop or bootcamp), 
+please reach out to [[email protected]](mailto:help%40smu.edu?subject=%5BHPC%5D) and include [HPC] in the subject line.
+
+### Setting up your class
+
+```{image} ../images/CF/quick_start/add_class.png
+:alt: add a class button
+:width: 400px
+```
+
+1. Login to ColdFront via SSO with your SMU credentials
+2. Select Add a class 
+3. Select your course from the drop down menu
+4. Select which sections you would like to have access to HPC resources
+5. Mark which additional options you need
+6. Select Save once complete.
+
+Once a class is created you will have options to Add additional users and request additional allocations.
+
+### To add Students and Other Users
+
+For classes, the management of students is synched hourly with class enrollment records starting a week before the semester starts.
+Once in the , students that add or drop will be added or removed from your class and allocations accordingly.
+
+```{note}
+All students will appear 7 days before the semester begins.
+```
+
+If you wish to add a user who is not enrolled to your class (e.g. a co-instructor), follow the steps below.
+
+```{note}
+This is not especially common. Do not add students that will be enrolled in the course as this could disrupt their file permissions.
+```
+
+1. Once your class is created, select Add Users within the Users section of your class
+
+    ```{image} ../images/CF/quick_start/add_users.png
+    :alt: add users
+    :width: 400px
+    ```
+
+2. If you are searching by “Exact Username Only” search for the user via SMU email alias
+
+    ```{note}
+    If you are adding multiple users, you can list them all in the Search String box
+    ```
+
+3. If you are searching by “All Fields” you can enter last name or SMU email alias
+
+4. Once you’ve found and selected the user(s), select the role the user should have
+
+    ```{image} ../images/CF/quick_start/user_role.png
+    :alt: user role
+    :width: 100px
+    ```
+
+5. Then Add Selected Users to Project
+6. Once complete you will see all users requested under the Users section
+
+### To Request Additional Resource Allocations
+
+All classes are granted a default compute allocation consisting of ***Core Usage (Hours)*** and ***Memory Usage (Hours)***.
+Depending on the options chosen at the creation of the project, this may contain ***Accelerator Usage (Hours)*** or a second allocation for Storage.
+The Storage allocation is Read-Only for students by default.
+
+If you find your class needing additional resources, you can request additional allocations for either Compute or Storage, by following the instructions below.
+
+```{image} ../images/CF/quick_start/request_resource_allocation.png
+:alt: request resource allocation
+:width: 200px
+```
+
+1.	Next to Allocations, Select the **+Request Resource Allocation button**
+2.	Complete all required fields
+3.	Select the users you’d like to add to this allocation
+4.	Select Submit
+5.	Once complete you will see your status request as **Pending Review** under Allocations

docs/coldfront/add_remove_users.md

@@ -0,0 +1,97 @@
+# Add or Remove Users
+
+```{note}
+Students enrolled in a course will be added automatically as a ***User*** in a class close to the course start date and cannot be removed.
+```
+
+## Roles
+
+Instructors and PI's are automatically assigned the ***Manager*** role within a project. Other users are either a ***Manager*** or a ***User***, with the following permissions:
+
+| Role | Permissions |
+| -------- | ------- |
+| ***Manager*** | add users, remove users, request allocations, use allocations |
+| ***User*** | use allocations |
+
+## Add a User
+
+### To a Project/Class
+
+1. Once a project or class is created, under Manage Project, click on <img src="../images/CF/add_remove_users/add_users.png" alt="add users" height="35"/>
+
+3. Type in usernames of the user(s) you would like to add separated by a space or on separate lines.
+
+    ```{image} ../images/CF/add_remove_users/search_user_space.png
+    :alt: search users by space
+    :height: 150px
+    ```
+
+    ```{image} ../images/CF/add_remove_users/search_user_line.png
+    :alt: search users by line
+    :height: 150px
+    ```
+
+4. Click on <img src="../images/CF/add_remove_users/search_button.png" alt="search button" width="700"/>
+
+    ````{note}
+    If a user has already been added to the project or class, then you will see a message like this
+    ```{image} ../images/CF/add_remove_users/user_already_added.png
+    :alt: user already added message
+    :height: 35px
+    :align: center
+    ```
+    ````
+
+5. Select the user(s) that you want to add from the list 
+
+    ```{image} ../images/CF/add_remove_users/select_user.png
+    :alt: select users
+    :height: 60px
+    ```
+
+    and change their role to either ***Manager*** or ***User*** using the dropdown.
+
+    ```{image} ../images/CF/add_remove_users/user_role.png
+    :alt: user role selection
+    :height: 60px
+    ```
+
+6. 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.
+
+### 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.
+```
+
+## Remove a User
+
+### From a Project/Class
+
+1. Click on <img src="../images/CF/add_remove_users/remove_users.png" alt="remove users button" height="35"/> in the header next to <img src="../images/CF/add_remove_users/users.png" alt="users header" height="35"/>.
+
+2. Select the user(s) that you want to remove from the list.
+
+    <img src="../images/CF/add_remove_users/select_user.png" alt="select users" height="60"/>
+
+3. Click on <img src="../images/CF/add_remove_users/remove_selected_users.png" alt="remove selected users" height="40"/>.
+
+4. You can verify that a user has been removed under <img src="../images/CF/add_remove_users/users.png" alt="users header" height="35"/> on the Project/Class page.
+
+### From an Allocation
+
+## Change User
+
+### Role
+
+1. Next to the user's role you would like to change, click on <img src="../images/CF/add_remove_users/actions.png" alt="actions button" height="40"/> under Actions.
+
+2. Change their role using the dropdown:
+
+    <img src="../images/CF/add_remove_users/user_role_change.png" alt="change user role" height="40"/>
+
+3. Click on <img src="../images/CF/add_remove_users/update.png" alt="update user" height="40"/>
+
+### Allocation Permissions